Salesforce

Salesforce Definition API

The Definition API from Salesforce — 1 operation(s) for definition.

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/get_job_info.htm
📖
Authentication
https://developer.salesforce.com/docs/atlas.en-us.api_bulk_v2.meta/api_bulk_v2/bulk_api_2_0_security.htm
📖
Documentation
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/
📖
GettingStarted
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_get_started.htm
📖
APIReference
https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_list.htm
📖
Documentation
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/rest-api.html
📖
GettingStarted
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/get-started-spec.html
📖
APIReference
https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_overview.html
📖
Authentication
https://developer.salesforce.com/docs/marketing/marketing-cloud/guide/access-token-s2s.html
📖
Documentation
https://developer.salesforce.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-definition-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/json-schema/salesforce-bulk-job-schema.json

OpenAPI Specification

salesforce-definition-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Definition 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: Definition
paths:
  /data/v64.0/smartdatadiscovery/predictionDefinitions/{PREDICTION_DEFINITION_ID}:
    parameters: []
    get:
      tags:
      - Definition
      summary: Salesforce Prediction Definition Metadata
      description: Get available prediction definitions.
      operationId: Predictiondefinitionmetadata
      parameters:
      - name: PREDICTION_DEFINITION_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Thu, 04 Mar 2021 13:45:58 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=31536002; includeSubDomains
            Expect-CT:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=86400, report-uri="https://a.forcesslreports.com/Expect-CT-report/00D5Y000001crJvm"
            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/Predictiondefinitionmetadata'
                - examples:
                  - countOfActiveModels: 1
                    countOfModels: 1
                    createdBy:
                      id: 0055Y00000DWwAIQA1
                      name: Philippe Ozil
                      profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
                    createdDate: '2021-03-04T13:37:02.000Z'
                    id: 1OR5Y0000010ws8WAA
                    label: Sales_per_Customer
                    lastModifiedBy:
                      id: 0055Y00000DWwAIQA1
                      name: Philippe Ozil
                      profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
                    lastModifiedDate: '2021-03-04T13:37:02.000Z'
                    modelsUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models
                    name: Sales_per_Customer
                    outcome:
                      goal: Maximize
                      label: Sales per Customer
                      name: Sales_per_Customer
                    predictionType: Regression
                    status: Enabled
                    url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA
                contentMediaType: application/json;charset=UTF-8
              example:
                countOfActiveModels: 1
                countOfModels: 1
                createdBy:
                  id: 0055Y00000DWwAIQA1
                  name: Philippe Ozil
                  profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
                createdDate: '2021-03-04T13:37:02.000Z'
                id: 1OR5Y0000010ws8WAA
                label: Sales_per_Customer
                lastModifiedBy:
                  id: 0055Y00000DWwAIQA1
                  name: Philippe Ozil
                  profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
                lastModifiedDate: '2021-03-04T13:37:02.000Z'
                modelsUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models
                name: Sales_per_Customer
                outcome:
                  goal: Maximize
                  label: Sales per Customer
                  name: Sales_per_Customer
                predictionType: Regression
                status: Enabled
                url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Predictiondefinitionmetadata:
      title: Predictiondefinitionmetadata
      required:
      - countOfActiveModels
      - countOfModels
      - createdBy
      - createdDate
      - id
      - label
      - lastModifiedBy
      - lastModifiedDate
      - modelsUrl
      - name
      - outcome
      - predictionType
      - status
      - url
      type: object
      properties:
        countOfActiveModels:
          type: integer
          contentEncoding: int32
          example: 42
        countOfModels:
          type: integer
          contentEncoding: int32
          example: 42
        createdBy:
          $ref: '#/components/schemas/CreatedBy'
        createdDate:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
        label:
          type: string
          example: Example Title
        lastModifiedBy:
          $ref: '#/components/schemas/LastModifiedBy'
        lastModifiedDate:
          type: string
          example: example_value
        modelsUrl:
          type: string
          example: https://www.example.com
        name:
          type: string
          example: Example Title
        outcome:
          $ref: '#/components/schemas/Outcome'
        predictionType:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - countOfActiveModels: 1
        countOfModels: 1
        createdBy:
          id: 0055Y00000DWwAIQA1
          name: Philippe Ozil
          profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
        createdDate: '2021-03-04T13:37:02.000Z'
        id: 1OR5Y0000010ws8WAA
        label: Sales_per_Customer
        lastModifiedBy:
          id: 0055Y00000DWwAIQA1
          name: Philippe Ozil
          profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
        lastModifiedDate: '2021-03-04T13:37:02.000Z'
        modelsUrl: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA/models
        name: Sales_per_Customer
        outcome:
          goal: Maximize
          label: Sales per Customer
          name: Sales_per_Customer
        predictionType: Regression
        status: Enabled
        url: /services/data/v51.0/smartdatadiscovery/predictiondefinitions/1OR5Y0000010ws8WAA
    CreatedBy:
      title: CreatedBy
      required:
      - id
      - name
      - profilePhotoUrl
      type: object
      properties:
        id:
          type: string
          example: abc123
        name:
          type: string
          example: Example Title
        profilePhotoUrl:
          type: string
          example: https://www.example.com
      examples:
      - id: 0055Y00000DWwAIQA1
        name: Philippe Ozil
        profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
    Outcome:
      title: Outcome
      required:
      - goal
      - label
      - name
      type: object
      properties:
        goal:
          type: string
          example: example_value
        label:
          type: string
          example: Example Title
        name:
          type: string
          example: Example Title
      examples:
      - goal: Maximize
        label: Sales per Customer
        name: Sales_per_Customer
    LastModifiedBy:
      title: LastModifiedBy
      required:
      - id
      - name
      - profilePhotoUrl
      type: object
      properties:
        id:
          type: string
          example: abc123
        name:
          type: string
          example: Example Title
        profilePhotoUrl:
          type: string
          example: https://www.example.com
      examples:
      - id: 0055Y00000DWwAIQA1
        name: Philippe Ozil
        profilePhotoUrl: https://crm-analytics-deorg-dev-ed--c.documentforce.com/profilephoto/005/T
  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}".

        '