Skip to main content
Skip table of contents

Create and Update Jobs

PATCH /v3/jobs

Update list of jobs. Supported properties to update: owner, project, fav. You can use 0 for project to unset project from job. Response is an array of Jobs that were updated

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: login_info
Scopes: [ jobs ]

Request body:
{
    "jobs": [
        {
            "id": 0,
            "ownerId": 0,
            "projectId": 0,
            "favorite": true,
            "account": "string"
        },
        {
            "id": 0,
            "ownerId": 0,
            "projectId": 0,
            "favorite": true,
            "account": "string"
        },
        {
            "id": 0,
            "ownerId": 0,
            "projectId": 0,
            "favorite": true,
            "account": "string"
        }
    ]
}

Response body:
}
  "jobs": [],
  "count": 0
}


PATCH /v3/jobs/{id}

Update’s jobs metadata. Supported properties to update: owner, project, fav. You can use 0 for project to unset project from job. Response is an array of Job that was updated.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: login_info
Scopes: [ jobs ]

Request body:
{
  "ownerId": 0,
  "projectId": 0,
  "favorite": true
}

Response body:
{
  "id": 0,
  "name": "string",
  "date": "string",
  "dateTime": "string",
  "favorite": true,
  "cost": 0,
  "duplex": true,
  "color": true,
  "pageCount": 0,
  "colorCount": 0,
  "copies": 0,
  "paper": {
    "state": 5
  }
}


POST /v3/jobs/delete

Cancel jobs. Mark a list of jobs as canceled. Request body is a list of id’s of jobs that should be canceled.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: login_info
Scopes: [ jobs ]

Request body:
[0, 0, 0]


DELETE /v3/jobs/{id}

Cancel job.

CODE
Headers:
Authentication: Bearer %access_token%

Authentication:
Grand_type: login_info
Scopes: [ jobs ]


POST /v3/jobs/client

Creates a client spooling job. Request contains all of basic info to create a job. ID of created job is returned in response.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: login_info
Scopes: [ jobs ]

Request body:
{
  "queue": "string",
  "owner": "string",
  "computer": "string",
  "name": "string",
  "size": 0,
  "uuid": "string",
  "jobInfo": {}
}

Response body:
{
  "id": 0
}


POST /v3/jobs/process

Process jobs.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: login_info
Scopes: [ jobs ]

Request body:
{
  "jobIds": [
    0
  ],
  "owner": "string",
  "projectId": 0,
  "account": "string"
}


POST /v3/jobs/{id}/script

Process input from user interaction.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: login_info
Scopes: [ jobs ]

Request body:
{
  "-1052320151": {
    "duplex": true,
    "simplex": null
  },
  "state": []
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.