Salesforce Graph API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Graph 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: Graph
paths:
  /data/v64.0/composite/graph:
    parameters: []
    post:
      tags:
      - Graph
      summary: Salesforce Composite Graph
      description: 'Composite graphs provide an enhanced way to perform composite requests, which execute a series of REST API requests in a single call.

        Regular composite requests allow you to execute a series of REST API requests in a single call. And you can use the output of one request as the input to a subsequent request.


        Composite graphs extend this by allowing you to assemble a more complicated and complete series of related objects and records.


        Composite graphs also enable you to ensure that the steps in a given set of operations are either all completed or all not completed. This avoids requiring you to check for a mix of successful and unsuccessful results.


        Regular composite requests have a limit of 25 subrequests. Composite graphs increase this limit to 500. This gives a single API call much greater power.


        https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_graph_introduction.htm'
      operationId: CompositeGraph
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CompositeGraphRequest'
              - examples:
                - graphs:
                  - graphId: graph1
                    compositeRequest:
                    - method: POST
                      url: /services/data/v64.0/sobjects/Account/
                      referenceId: newAccount
                      body:
                        Name: ACME Inc.
                        Custom__c: Hello world
                    - method: GET
                      url: /services/data/v64.0/sobjects/Account/@{newAccount.id}
                      referenceId: newAccountInfo
              contentMediaType: application/json
            example:
              graphs:
              - graphId: graph1
                compositeRequest:
                - method: POST
                  url: /services/data/v64.0/sobjects/Account/
                  referenceId: newAccount
                  body:
                    Name: ACME Inc.
                    Custom__c: Hello world
                - method: GET
                  url: /services/data/v64.0/sobjects/Account/@{newAccount.id}
                  referenceId: newAccountInfo
        required: true
      responses:
        '200':
          description: OK
          headers:
            cache-control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            content-type:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: application/json;charset=UTF-8
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulCompositeGraph'
                - examples:
                  - graphs:
                    - graphId: graph1
                      graphResponse:
                        compositeResponse:
                        - body:
                            id: 0014H00002x6HUhQAM
                            success: true
                            errors: []
                          httpHeaders:
                            Location: /services/data/v50.0/sobjects/Account/0014H00002x6HUhQAM
                          httpStatusCode: 201
                          referenceId: newAccount
                        - body:
                            id: 0034H00002JsInQQAV
                            success: true
                            errors: []
                          httpHeaders:
                            Location: /services/data/v50.0/sobjects/Contact/0034H00002JsInQQAV
                          httpStatusCode: 201
                          referenceId: newContact
                      isSuccessful: true
                contentMediaType: application/json
              example:
                graphs:
                - graphId: graph1
                  graphResponse:
                    compositeResponse:
                    - body:
                        id: 0014H00002x6HUhQAM
                        success: true
                        errors: []
                      httpHeaders:
                        Location: /services/data/v50.0/sobjects/Account/0014H00002x6HUhQAM
                      httpStatusCode: 201
                      referenceId: newAccount
                    - body:
                        id: 0034H00002JsInQQAV
                        success: true
                        errors: []
                      httpHeaders:
                        Location: /services/data/v50.0/sobjects/Contact/0034H00002JsInQQAV
                      httpStatusCode: 201
                      referenceId: newContact
                  isSuccessful: true
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Graph:
      title: Graph
      required:
      - graphId
      - compositeRequest
      type: object
      properties:
        graphId:
          type: string
          example: '500123'
        compositeRequest:
          type: array
          items:
            $ref: '#/components/schemas/CompositeRequest2'
          description: ''
          example: []
      examples:
      - graphId: graph1
        compositeRequest:
        - method: POST
          url: /services/data/v64.0/sobjects/Account/
          referenceId: newAccount
          body:
            Name: ACME Inc.
            Custom__c: Hello world
        - method: GET
          url: /services/data/v64.0/sobjects/Account/@{newAccount.id}
          referenceId: newAccountInfo
    CompositeGraphRequest:
      title: CompositeGraphRequest
      required:
      - graphs
      type: object
      properties:
        graphs:
          type: array
          items:
            $ref: '#/components/schemas/Graph'
          description: ''
          example: []
      examples:
      - graphs:
        - graphId: graph1
          compositeRequest:
          - method: POST
            url: /services/data/v64.0/sobjects/Account/
            referenceId: newAccount
            body:
              Name: ACME Inc.
              Custom__c: Hello world
          - method: GET
            url: /services/data/v64.0/sobjects/Account/@{newAccount.id}
            referenceId: newAccountInfo
    Graph1:
      title: Graph1
      required:
      - graphId
      - graphResponse
      - isSuccessful
      type: object
      properties:
        graphId:
          type: string
          example: '500123'
        graphResponse:
          $ref: '#/components/schemas/GraphResponse'
        isSuccessful:
          type: boolean
          example: true
      examples:
      - graphId: graph1
        graphResponse:
          compositeResponse:
          - body:
              id: 0014H00002x6HUhQAM
              success: true
              errors: []
            httpHeaders:
              Location: /services/data/v50.0/sobjects/Account/0014H00002x6HUhQAM
            httpStatusCode: 201
            referenceId: newAccount
          - body:
              id: 0034H00002JsInQQAV
              success: true
              errors: []
            httpHeaders:
              Location: /services/data/v50.0/sobjects/Contact/0034H00002JsInQQAV
            httpStatusCode: 201
            referenceId: newContact
        isSuccessful: true
    CompositeResponse:
      title: CompositeResponse
      required:
      - body
      - httpHeaders
      - httpStatusCode
      - referenceId
      type: object
      properties:
        body:
          $ref: '#/components/schemas/Body1'
        httpHeaders:
          $ref: '#/components/schemas/HttpHeaders'
        httpStatusCode:
          type: integer
          contentEncoding: int32
          example: 10
        referenceId:
          type: string
          example: '500123'
      examples:
      - body:
          id: 001...
          success: true
          errors: []
        httpHeaders:
          Location: /services/data/v53.0/sobjects/Account/001...
        httpStatusCode: 201
        referenceId: refAccount
    Body2:
      title: Body2
      required:
      - Name
      - Custom__c
      type: object
      properties:
        Name:
          type: string
          example: Example Title
        Custom__c:
          type: string
          example: example_value
      examples:
      - Name: ACME Inc.
        Custom__c: Hello world
    SuccessfulCompositeGraph:
      title: SuccessfulCompositeGraph
      required:
      - graphs
      type: object
      properties:
        graphs:
          type: array
          items:
            $ref: '#/components/schemas/Graph1'
          description: ''
          example: []
      examples:
      - graphs:
        - graphId: graph1
          graphResponse:
            compositeResponse:
            - body:
                id: 0014H00002x6HUhQAM
                success: true
                errors: []
              httpHeaders:
                Location: /services/data/v50.0/sobjects/Account/0014H00002x6HUhQAM
              httpStatusCode: 201
              referenceId: newAccount
            - body:
                id: 0034H00002JsInQQAV
                success: true
                errors: []
              httpHeaders:
                Location: /services/data/v50.0/sobjects/Contact/0034H00002JsInQQAV
              httpStatusCode: 201
              referenceId: newContact
          isSuccessful: true
    CompositeRequest2:
      title: CompositeRequest2
      required:
      - method
      - url
      - referenceId
      type: object
      properties:
        method:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
        referenceId:
          type: string
          example: '500123'
        body:
          $ref: '#/components/schemas/Body2'
      examples:
      - method: POST
        url: /services/data/v64.0/sobjects/Account/
        referenceId: newAccount
        body:
          Name: ACME Inc.
          Custom__c: Hello world
    HttpHeaders:
      title: HttpHeaders
      required:
      - Location
      type: object
      properties:
        Location:
          type: string
          example: example_value
      examples:
      - Location: /services/data/v53.0/sobjects/Account/001...
    GraphResponse:
      title: GraphResponse
      required:
      - compositeResponse
      type: object
      properties:
        compositeResponse:
          type: array
          items:
            $ref: '#/components/schemas/CompositeResponse'
          description: ''
          example: []
      examples:
      - compositeResponse:
        - body:
            id: 0014H00002x6HUhQAM
            success: true
            errors: []
          httpHeaders:
            Location: /services/data/v50.0/sobjects/Account/0014H00002x6HUhQAM
          httpStatusCode: 201
          referenceId: newAccount
        - body:
            id: 0034H00002JsInQQAV
            success: true
            errors: []
          httpHeaders:
            Location: /services/data/v50.0/sobjects/Contact/0034H00002JsInQQAV
          httpStatusCode: 201
          referenceId: newContact
    Body1:
      title: Body1
      required:
      - id
      - success
      - errors
      type: object
      properties:
        id:
          type: string
          example: abc123
        success:
          type: boolean
          example: true
        errors:
          type: array
          items:
            type: string
          description: ''
          example: []
      examples:
      - id: 001...
        success: true
        errors: []
  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}".

        '