Zendesk Job Statuses API

openapi: 3.2.0
info:
  title: Zendesk Job Statuses API
  version: '1.0'
  description: 'Operations tagged Job Statuses across 2 of this provider''s published API definitions: job-statuses-openapi-original.yml, routing-openapi-original.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Job Statuses
paths:
  /api/v2/job_statuses:
    get:
      operationId: ListJobStatuses
      tags:
      - Job Statuses
      summary: Zendesk Get Api V2 Job_statuses
      description: 'Shows the statuses for background jobs. Statuses are sorted first by completion date and then by creation date in descending order.


        #### Allowed For:


        * Agents


        #### Pagination


        * Cursor pagination


        See Pagination.'
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusesResponse'
              examples:
                default:
                  $ref: '#/components/examples/JobStatusesResponseExample'
  /api/v2/job_statuses/{job_status_id}:
    parameters:
    - $ref: '#/components/parameters/JobStatusId'
    get:
      operationId: ShowJobStatus
      tags:
      - Job Statuses
      summary: Zendesk Get Api V2 Job_statuses Job_status_id
      description: 'Shows the status of a background job.


        #### Allowed For:


        * Agents'
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusResponse'
              examples:
                default:
                  $ref: '#/components/examples/ShowJobStatusResponseExample'
  /api/v2/job_statuses/show_many:
    get:
      operationId: ShowManyJobStatuses
      tags:
      - Job Statuses
      summary: Zendesk Get Api V2 Job_statuses Show_many
      description: 'Accepts a comma-separated list of job status ids.


        #### Allowed For:


        * Agents'
      parameters:
      - name: ids
        in: query
        description: Comma-separated list of job status ids.
        required: true
        schema:
          type: string
        example: 8b726e606741012ffc2d782bcb7848fe,e7665094164c498781ebe4c8db6d2af5
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusesResponse'
              examples:
                default:
                  $ref: '#/components/examples/JobStatusesResponseExample'
  /api/v2/routing/agents/instance_values/job:
    post:
      operationId: BulkSetAgentAttributeValuesJob
      tags:
      - Job Statuses
      summary: Zendesk Post Api V2 Routing Agents Instance_values Job
      description: 'Adds, replaces or removes multiple attributes for up to 100 agents.


        #### Allowed For

        * Admins

        * Agents in custom role with permission to manage skills


        #### Available Parameters


        The request takes a data object with the following properties:

        | Name | Type | Required | Description |

        | ---------- | ------ | -------- | ------------------------------------------------------------------------------------------------- |

        | action | string | true | The action to perform on the attribute values. One of the following: "upsert", "update", "delete" |

        | attributes | object | true | The attribute values to update. See Attribute Values |

        | items | array | true | The list of agent ids |


        Action can be one of the following:

        * upsert: Adds new attribute values to the agents

        * update: Replaces all the current attribute values of the agents with the new values

        * delete: Removes specified attribute values from the agents


        This endpoint returns a `job_status` JSON object and queues a background job to do the work. Use the Show Job Status endpoint to check for the job''s completion.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkSkillBasedRoutingAttributeValuesRequest'
            examples:
              default:
                $ref: '#/components/examples/BulkSkillBasedRoutingAttributeValuesRequestExample'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobStatusResponse'
              examples:
                default:
                  $ref: '#/components/examples/BulkSkillBasedRoutingAttributeValuesJobStatusResponseExample'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkillBasedRoutingAttributeValuesError'
              examples:
                default:
                  $ref: '#/components/examples/BulkSkillBasedRoutingAttributeValuesErrorExample'
components:
  schemas:
    JobStatusesResponse:
      type: object
      properties:
        job_statuses:
          type: array
          items:
            $ref: '#/components/schemas/JobStatusObject'
      required:
      - job_statuses
    JobStatusResponse:
      type: object
      properties:
        job_status:
          $ref: '#/components/schemas/JobStatusObject'
x-refined-from:
- job-statuses-openapi-original.yml
- routing-openapi-original.yml