Salesforce Notation API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Notation API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Notation
paths:
  /data/v64.0/connect/business-rules/decision-models/export:
    parameters: []
    post:
      tags:
      - Notation
      summary: Salesforce Decision Model Notation Export
      description: "# Decision Model Notation Export (POST)\n\nExport decision matrix data to a file in the [DMN (Decision Model Notation)](https://www.omg.org/dmn/#:~:text=DMN%20is%20a%20modeling%20language,monitor%20their%20application;%20business%20analysts.) format, an easily readable format for business rules designed by Object Management Group.Resource\n\n```\n/connect/business-rules/decision-models/export\n\n ```\n\nResource Example\n\n```\nhttps://yourInstance.salesforce.com/services/data/v59.0/connect/business-rules/decision-models/export\n\n ```\n\nAvailable version\n\n58.0\n\nRequires Chatter\n\nNo\n\nHTTP methods\n\nPOST\n\nRequest body for POST\n\nJSON example\n\n```\n{\n   \"decisionModelEntityIds\":[\n      “0lNRO00000004f72AA”,\n      “0lNRO000000rfn27AA”\n   ]\n}\n\n ```\n\nProperties\n\n| Name | Type | Description | Required or Optional | Available Version |\n| --- | --- | --- | --- | --- |\n| decisionModelEntityIds | String\\[\\] | A list of decision matrix version IDs to export data from. | Required | 58.0 |\n\nResponse body for POST\n\n[Decision Model Export Output](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_model_export_output.htm)\n\n# Decision Model Export Output\n\nOutput representation of a completed DMN (Decision Model Notation) export request.JSON example\n\n```\n{\n   \"message\":\"OK\",\n   \"success\":true,\n   \"errors\":[\n      {\n         \"errorCode\":\"BAD_REQUEST\",\n         \"errorMessage\":\"We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.\",\n         \"recordId\":\"0lNRO00000004fsdfAA\"\n      }\n   ]\n}\n\n ```\n\n| Property Name | Type | Description | Filter Group and Version | Available Version |\n| --- | --- | --- | --- | --- |\n| errors | [Decision Model Export Error](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/connect_responses_decision_model_export_error.htm)\\[\\] | List of errors corresponding to a failed export request. | Small, 58.0 | 58.0 |\n| message | String | Response message from the completed export request. | Small, 58.0 | 58.0 |\n| success | Boolean | Indicates whether the export request was successful (true) or not (false). | Small, 58.0 | 58.0 |"
      operationId: DecisionModelNotationExport
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DecisionModelNotationExportRequest'
              - examples:
                - decisionModelEntityIds:
                  - 0lNHo000000LEvfMAG
              contentMediaType: application/json
            example:
              decisionModelEntityIds:
              - 0lNHo000000LEvfMAG
        required: true
      responses:
        '201':
          description: Created
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Tue, 19 Sep 2023 12:01:33 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/Status201-BadRequest'
                - examples:
                  - errors:
                    - errorCode: BAD_REQUEST
                      errorMessage: We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.
                      recordId: 0lNRO00000004f72AA
                    - errorCode: BAD_REQUEST
                      errorMessage: We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.
                      recordId: 0lNRO000000rfn27AA
                    message: OK
                    success: true
                contentMediaType: application/json;charset=UTF-8
              example:
                errors:
                - errorCode: BAD_REQUEST
                  errorMessage: We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.
                  recordId: 0lNRO00000004f72AA
                - errorCode: BAD_REQUEST
                  errorMessage: We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.
                  recordId: 0lNRO000000rfn27AA
                message: OK
                success: true
        '500':
          description: Server Error
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Tue, 19 Sep 2023 12:02:44 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Status500-EmptyBody1'
                description: ''
                examples:
                - - message: 'An unexpected error occurred. Please include this ErrorId if you contact support: 1291449758-100210 (-239130079)'
                    errorCode: UNKNOWN_EXCEPTION
                contentMediaType: application/json;charset=UTF-8
              example:
              - message: 'An unexpected error occurred. Please include this ErrorId if you contact support: 1291449758-100210 (-239130079)'
                errorCode: UNKNOWN_EXCEPTION
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Status500-EmptyBody1:
      title: Status500-EmptyBody1
      required:
      - message
      - errorCode
      type: object
      properties:
        message:
          type: string
          example: example_value
        errorCode:
          type: string
          example: example_value
      examples:
      - message: 'An unexpected error occurred. Please include this ErrorId if you contact support: 1291449758-100210 (-239130079)'
        errorCode: UNKNOWN_EXCEPTION
    Status201-BadRequest:
      title: Status201-BadRequest
      required:
      - errors
      - message
      - success
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: ''
          example: []
        message:
          type: string
          example: example_value
        success:
          type: boolean
          example: true
      examples:
      - errors:
        - errorCode: BAD_REQUEST
          errorMessage: We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.
          recordId: 0lNRO00000004f72AA
        - errorCode: BAD_REQUEST
          errorMessage: We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.
          recordId: 0lNRO000000rfn27AA
        message: OK
        success: true
    DecisionModelNotationExportRequest:
      title: DecisionModelNotationExportRequest
      required:
      - decisionModelEntityIds
      type: object
      properties:
        decisionModelEntityIds:
          type: array
          items:
            type: string
          description: ''
          example: []
      examples:
      - decisionModelEntityIds:
        - 0lNHo000000LEvfMAG
    Error:
      title: Error
      required:
      - errorCode
      - errorMessage
      - recordId
      type: object
      properties:
        errorCode:
          type: string
          example: example_value
        errorMessage:
          type: string
          example: example_value
        recordId:
          type: string
          example: '500123'
      examples:
      - errorCode: BAD_REQUEST
        errorMessage: We couldn’t find this record. Specify a valid ID for decisionModelEntityIds parameter.
        recordId: 0lNRO00000004f72AA
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'OAuth 2.0 Bearer token obtained from the Salesforce OAuth 2.0 token endpoint. Include this token in the Authorization header as "Bearer {access_token}".

        '