Salesforce Chart API

The Chart API from Salesforce — 1 operation(s) for chart.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-chart-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Chart 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: Chart
paths:
  /data/v64.0/ui-api/actions/list-view-chart/{SOBJECT_API_NAME}:
    parameters: []
    get:
      tags:
      - Chart
      summary: Salesforce Get List View Chart Actions
      description: Get the record actions on list views.
      operationId: GetListViewChartActions
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: Currently, only `ListViewChartInstance` is valid.
        required: true
        schema:
          type: string
          examples:
          - ListViewChartInstance
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 11:41:26 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-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
            ETag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: '"60c273c4ba34efcc645bd0ce249c8cd4--gzip"'
            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/GetListViewChartActions'
                - examples:
                  - actions:
                      ListViewChartInstance:
                        actions:
                        - actionListContext: ObjectHomeChart
                          actionTarget: null
                          actionTargetType: null
                          apiName: NewObjectHomeChartAction
                          externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:NewObjectHomeChartAction
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                          id: 0JV4H0000138090WAA
                          isMassAction: 'false'
                          label: New Chart
                          lwcComponent: null
                          primaryColor: null
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: ListViewChartInstance
                          subtype: null
                          targetObject: ListViewChart
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: ObjectHomeChart
                          actionTarget: null
                          actionTargetType: null
                          apiName: EditObjectHomeChartAction
                          externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:EditObjectHomeChartAction
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                          id: 0JV4H0000138091WAA
                          isMassAction: 'false'
                          label: Edit Chart
                          lwcComponent: null
                          primaryColor: null
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: ListViewChartInstance
                          subtype: null
                          targetObject: ListViewChart
                          targetUrl: null
                          type: StandardButton
                        - actionListContext: ObjectHomeChart
                          actionTarget: null
                          actionTargetType: null
                          apiName: DeleteObjectHomeChartAction
                          externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:DeleteObjectHomeChartAction
                          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                          id: 0JV4H0000138092WAA
                          isMassAction: 'false'
                          label: Delete Chart
                          lwcComponent: null
                          primaryColor: null
                          relatedListRecordId: null
                          relatedSourceObject: null
                          section: Page
                          sourceObject: ListViewChartInstance
                          subtype: null
                          targetObject: ListViewChart
                          targetUrl: null
                          type: StandardButton
                        links: []
                        url: /services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance
                    eTag: 60c273c4ba34efcc645bd0ce249c8cd4
                    url: /services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance
                contentMediaType: application/json;charset=UTF-8
              example:
                actions:
                  ListViewChartInstance:
                    actions:
                    - actionListContext: ObjectHomeChart
                      actionTarget: null
                      actionTargetType: null
                      apiName: NewObjectHomeChartAction
                      externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:NewObjectHomeChartAction
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                      id: 0JV4H0000138090WAA
                      isMassAction: 'false'
                      label: New Chart
                      lwcComponent: null
                      primaryColor: null
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: ListViewChartInstance
                      subtype: null
                      targetObject: ListViewChart
                      targetUrl: null
                      type: StandardButton
                    - actionListContext: ObjectHomeChart
                      actionTarget: null
                      actionTargetType: null
                      apiName: EditObjectHomeChartAction
                      externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:EditObjectHomeChartAction
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                      id: 0JV4H0000138091WAA
                      isMassAction: 'false'
                      label: Edit Chart
                      lwcComponent: null
                      primaryColor: null
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: ListViewChartInstance
                      subtype: null
                      targetObject: ListViewChart
                      targetUrl: null
                      type: StandardButton
                    - actionListContext: ObjectHomeChart
                      actionTarget: null
                      actionTargetType: null
                      apiName: DeleteObjectHomeChartAction
                      externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:DeleteObjectHomeChartAction
                      iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
                      id: 0JV4H0000138092WAA
                      isMassAction: 'false'
                      label: Delete Chart
                      lwcComponent: null
                      primaryColor: null
                      relatedListRecordId: null
                      relatedSourceObject: null
                      section: Page
                      sourceObject: ListViewChartInstance
                      subtype: null
                      targetObject: ListViewChart
                      targetUrl: null
                      type: StandardButton
                    links: []
                    url: /services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance
                eTag: 60c273c4ba34efcc645bd0ce249c8cd4
                url: /services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    GetListViewChartActions:
      title: GetListViewChartActions
      required:
      - actions
      - eTag
      - url
      type: object
      properties:
        actions:
          $ref: '#/components/schemas/Actions15'
        eTag:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      examples:
      - actions:
          ListViewChartInstance:
            actions:
            - actionListContext: ObjectHomeChart
              actionTarget: null
              actionTargetType: null
              apiName: NewObjectHomeChartAction
              externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:NewObjectHomeChartAction
              iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
              id: 0JV4H0000138090WAA
              isMassAction: 'false'
              label: New Chart
              lwcComponent: null
              primaryColor: null
              relatedListRecordId: null
              relatedSourceObject: null
              section: Page
              sourceObject: ListViewChartInstance
              subtype: null
              targetObject: ListViewChart
              targetUrl: null
              type: StandardButton
            - actionListContext: ObjectHomeChart
              actionTarget: null
              actionTargetType: null
              apiName: EditObjectHomeChartAction
              externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:EditObjectHomeChartAction
              iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
              id: 0JV4H0000138091WAA
              isMassAction: 'false'
              label: Edit Chart
              lwcComponent: null
              primaryColor: null
              relatedListRecordId: null
              relatedSourceObject: null
              section: Page
              sourceObject: ListViewChartInstance
              subtype: null
              targetObject: ListViewChart
              targetUrl: null
              type: StandardButton
            - actionListContext: ObjectHomeChart
              actionTarget: null
              actionTargetType: null
              apiName: DeleteObjectHomeChartAction
              externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:DeleteObjectHomeChartAction
              iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
              id: 0JV4H0000138092WAA
              isMassAction: 'false'
              label: Delete Chart
              lwcComponent: null
              primaryColor: null
              relatedListRecordId: null
              relatedSourceObject: null
              section: Page
              sourceObject: ListViewChartInstance
              subtype: null
              targetObject: ListViewChart
              targetUrl: null
              type: StandardButton
            links: []
            url: /services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance
        eTag: 60c273c4ba34efcc645bd0ce249c8cd4
        url: /services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance
    Actions15:
      title: Actions15
      required:
      - ListViewChartInstance
      type: object
      properties:
        ListViewChartInstance:
          $ref: '#/components/schemas/ListViewChartInstance'
      examples:
      - ListViewChartInstance:
          actions:
          - actionListContext: ObjectHomeChart
            actionTarget: null
            actionTargetType: null
            apiName: NewObjectHomeChartAction
            externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:NewObjectHomeChartAction
            iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
            id: 0JV4H0000138090WAA
            isMassAction: 'false'
            label: New Chart
            lwcComponent: null
            primaryColor: null
            relatedListRecordId: null
            relatedSourceObject: null
            section: Page
            sourceObject: ListViewChartInstance
            subtype: null
            targetObject: ListViewChart
            targetUrl: null
            type: StandardButton
          - actionListContext: ObjectHomeChart
            actionTarget: null
            actionTargetType: null
            apiName: EditObjectHomeChartAction
            externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:EditObjectHomeChartAction
            iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
            id: 0JV4H0000138091WAA
            isMassAction: 'false'
            label: Edit Chart
            lwcComponent: null
            primaryColor: null
            relatedListRecordId: null
            relatedSourceObject: null
            section: Page
            sourceObject: ListViewChartInstance
            subtype: null
            targetObject: ListViewChart
            targetUrl: null
            type: StandardButton
          - actionListContext: ObjectHomeChart
            actionTarget: null
            actionTargetType: null
            apiName: DeleteObjectHomeChartAction
            externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:DeleteObjectHomeChartAction
            iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
            id: 0JV4H0000138092WAA
            isMassAction: 'false'
            label: Delete Chart
            lwcComponent: null
            primaryColor: null
            relatedListRecordId: null
            relatedSourceObject: null
            section: Page
            sourceObject: ListViewChartInstance
            subtype: null
            targetObject: ListViewChart
            targetUrl: null
            type: StandardButton
          links: []
          url: /services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance
    Actions12:
      title: Actions12
      required:
      - actionListContext
      - actionTarget
      - actionTargetType
      - apiName
      - externalId
      - iconUrl
      - id
      - isMassAction
      - label
      - lwcComponent
      - primaryColor
      - relatedListRecordId
      - relatedSourceObject
      - section
      - sourceObject
      - subtype
      - targetObject
      - targetUrl
      - type
      type: object
      properties:
        actionListContext:
          type: string
          example: example_value
        actionTarget:
          type:
          - string
          - 'null'
          example: example_value
        actionTargetType:
          type:
          - string
          - 'null'
          example: example_value
        apiName:
          type: string
          example: example_value
        externalId:
          type: string
          example: '500123'
        iconUrl:
          type: string
          example: https://www.example.com
        id:
          type: string
          example: abc123
        isMassAction:
          type: string
          example: example_value
        label:
          type: string
          example: Example Title
        lwcComponent:
          type:
          - string
          - 'null'
          example: example_value
        primaryColor:
          type:
          - string
          - 'null'
          example: example_value
        relatedListRecordId:
          type:
          - string
          - 'null'
          example: '500123'
        relatedSourceObject:
          type:
          - string
          - 'null'
          example: example_value
        section:
          type: string
          example: example_value
        sourceObject:
          type: string
          example: example_value
        subtype:
          type:
          - string
          - 'null'
          example: example_value
        targetObject:
          type: string
          example: example_value
        targetUrl:
          type:
          - string
          - 'null'
          example: https://www.example.com
        type:
          type: string
          example: example_value
      examples:
      - actionListContext: ListView
        actionTarget: null
        actionTargetType: Invoke
        apiName: EditFilter
        externalId: 00D58000000arpq:00B58000002ssinEAA::ListView:Desktop:StandardButton:EditFilter
        iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/filter_120.png
        id: 0JV4H0000132177WAA
        isMassAction: 'false'
        label: Filter
        lwcComponent: null
        primaryColor: 0176D3
        relatedListRecordId: null
        relatedSourceObject: null
        section: Page
        sourceObject: 00B58000002ssinEAA
        subtype: null
        targetObject: Account
        targetUrl: null
        type: StandardButton
    ListViewChartInstance:
      title: ListViewChartInstance
      required:
      - actions
      - links
      - url
      type: object
      properties:
        actions:
          type: array
          items:
            $ref: '#/components/schemas/Actions12'
          description: ''
          example: []
        links:
          type: array
          items:
            type: string
          description: ''
          example: []
        url:
          type: string
          example: https://www.example.com
      examples:
      - actions:
        - actionListContext: ObjectHomeChart
          actionTarget: null
          actionTargetType: null
          apiName: NewObjectHomeChartAction
          externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:NewObjectHomeChartAction
          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
          id: 0JV4H0000138090WAA
          isMassAction: 'false'
          label: New Chart
          lwcComponent: null
          primaryColor: null
          relatedListRecordId: null
          relatedSourceObject: null
          section: Page
          sourceObject: ListViewChartInstance
          subtype: null
          targetObject: ListViewChart
          targetUrl: null
          type: StandardButton
        - actionListContext: ObjectHomeChart
          actionTarget: null
          actionTargetType: null
          apiName: EditObjectHomeChartAction
          externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:EditObjectHomeChartAction
          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
          id: 0JV4H0000138091WAA
          isMassAction: 'false'
          label: Edit Chart
          lwcComponent: null
          primaryColor: null
          relatedListRecordId: null
          relatedSourceObject: null
          section: Page
          sourceObject: ListViewChartInstance
          subtype: null
          targetObject: ListViewChart
          targetUrl: null
          type: StandardButton
        - actionListContext: ObjectHomeChart
          actionTarget: null
          actionTargetType: null
          apiName: DeleteObjectHomeChartAction
          externalId: 00D58000000arpq:ListViewChartInstance::ObjectHomeChart:Desktop:StandardButton:DeleteObjectHomeChartAction
          iconUrl: https://pozil-dev-ed.my.salesforce.com/img/icon/t4v35/action/new_custom19_120.png
          id: 0JV4H0000138092WAA
          isMassAction: 'false'
          label: Delete Chart
          lwcComponent: null
          primaryColor: null
          relatedListRecordId: null
          relatedSourceObject: null
          section: Page
          sourceObject: ListViewChartInstance
          subtype: null
          targetObject: ListViewChart
          targetUrl: null
          type: StandardButton
        links: []
        url: /services/data/v58.0/ui-api/actions/list-view-chart/ListViewChartInstance
  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}".

        '