Salesforce Initiate API

openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Initiate 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: Initiate
paths:
  /data/v64.0/asset-management/assets/collection/actions/initiate-cancellation:
    parameters: []
    post:
      tags:
      - Initiate
      summary: Salesforce Initiate Cancellation
      operationId: InitiateCancellation
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateCancellationRequest'
              - examples:
                - assetIds:
                    assetIdArray:
                    - '{{assetID}}'
                  cancellationDate: '2023-08-21T00:00:00.000Z'
                  cancellationOutputType: order
              contentMediaType: application/json
            example:
              assetIds:
                assetIdArray:
                - '{{assetID}}'
              cancellationDate: '2023-08-21T00:00:00.000Z'
              cancellationOutputType: order
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/asset-management/assets/collection/actions/initiate-renewal:
    parameters: []
    post:
      tags:
      - Initiate
      summary: Salesforce Initiate Renewal
      operationId: InitiateRenewal
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateRenewalRequest'
              - examples:
                - assetIds:
                    assetIdArray:
                    - '{{assetID}}'
              contentMediaType: application/json
            example:
              assetIds:
                assetIdArray:
                - '{{assetID}}'
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/asset-management/assets/collection/actions/initiate-amend-quantity:
    parameters: []
    post:
      tags:
      - Initiate
      summary: Salesforce Initiate Amend Quantity
      operationId: InitiateAmendQuantity
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateAmendQuantityRequest'
              - examples:
                - assetIds:
                    assetIdArray:
                    - '{{assetID}}'
                  startDate: '2023-08-18T00:00:00.000Z'
                  quantityChange: 5
                  amendmentOutputType: order
              contentMediaType: application/json
            example:
              assetIds:
                assetIdArray:
                - '{{assetID}}'
              startDate: '2023-08-18T00:00:00.000Z'
              quantityChange: 5
              amendmentOutputType: order
        required: true
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    AssetIds:
      title: AssetIds
      required:
      - assetIdArray
      type: object
      properties:
        assetIdArray:
          type: array
          items:
            type: string
          description: ''
          example: []
      examples:
      - assetIdArray:
        - '{{assetID}}'
    InitiateRenewalRequest:
      title: InitiateRenewalRequest
      required:
      - assetIds
      type: object
      properties:
        assetIds:
          $ref: '#/components/schemas/AssetIds'
      examples:
      - assetIds:
          assetIdArray:
          - '{{assetID}}'
    InitiateAmendQuantityRequest:
      title: InitiateAmendQuantityRequest
      required:
      - assetIds
      - startDate
      - quantityChange
      - amendmentOutputType
      type: object
      properties:
        assetIds:
          $ref: '#/components/schemas/AssetIds'
        startDate:
          type: string
          example: example_value
        quantityChange:
          type: integer
          contentEncoding: int32
          example: 10
        amendmentOutputType:
          type: string
          example: example_value
      examples:
      - assetIds:
          assetIdArray:
          - '{{assetID}}'
        startDate: '2023-08-18T00:00:00.000Z'
        quantityChange: 5
        amendmentOutputType: order
    InitiateCancellationRequest:
      title: InitiateCancellationRequest
      required:
      - assetIds
      - cancellationDate
      - cancellationOutputType
      type: object
      properties:
        assetIds:
          $ref: '#/components/schemas/AssetIds'
        cancellationDate:
          type: string
          example: example_value
        cancellationOutputType:
          type: string
          example: example_value
      examples:
      - assetIds:
          assetIdArray:
          - '{{assetID}}'
        cancellationDate: '2023-08-21T00:00:00.000Z'
        cancellationOutputType: order
  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}".

        '