Important!
The 3D print API is shutting down on January 15, 2017. See our end of life notice for more information.
GET jobs¶a>
Lists all the member’s jobs.
Note that non-Forge jobs, i.e., jobs running on a 3D printer that was initiated outside of Forge, are integrated into the Forge job queue and assigned to the printer owner.
Resource Information¶
| Method and URI | GET https:/ |
| Authentication Context | user context required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request¶
HTTP Headers¶
Name |
Required |
Value Type |
Description |
|---|---|---|---|
| Authorization | yes | string | Must be Bearer <token>, where <token> is obtained via a three- |
Query String Parameters¶
Name |
Required |
Value Type |
Description |
|---|---|---|---|
| status | no | array: string | an array of the statuses to include in the list
Possible values are
completed, failed, canceled,
successful, and queued.If omitted, all jobs will be returned, regardless of status.
|
| limit | no | int | maximum number of jobs to return per page
If set to
-1, it will return all jobs. |
| offset | no | int | starting index of the current list of jobs |
Response¶
HTTP Status Code Summary¶
Code |
Message |
Meaning |
|---|---|---|
| 200 | OK | Successful |
| 400 | Bad Request | Invalid request. E.g., the request could not be parsed. |
| 401 | Unauthorized | Invalid authorization header. E.g., user is not logged in, or cannot access resource. |
| 404 | Not Found | Endpoint does not exist. |
| 422 | Unprocessable Entity | Semantic errors |
| 429 | Precondition Required | Request rate limit exceeded |
| 500 | Internal Server Error | An unknown error occurred on the server. |
Body Structure (200)¶
A successful response returns a JSON object with the following attributes:
Attribute |
Value Type |
Description |
|---|---|---|
| count | int | the number of jobs returned |
| limit | int | maximum number of jobs to return |
| offset | int | starting index of the current list of jobs |
| _link_prev | string: URI path and query string | URI for the previous set of results, excluding scheme and hostname |
| _link_next | string: URI path and query string | URI for the next set of results, excluding scheme and hostname |
| _link | string: URI path and query string | URI for the endpoint called, excluding scheme and hostname |
| member_id | string | identifier of the 3-legged end user |
| jobs | array: object | the list of jobs |
| jobs.job_id | string: UUID | ID of the job |
| jobs.job_name | string | human-readable name of the job |
| jobs.printer_id | int | ID of the printer |
| jobs.job_status | object | extended information about the status of the job |
| jobs.job_status.printer_status | enum: string | |
| jobs.job_status.job_id | string: UUID | ID of the job |
| jobs.job_status.job_name | string | human-readable name of the job |
| jobs.job_status.member_id | string | ID of the member |
| jobs.job_status.printer_id | int | ID of the printer |
| jobs.job_status.printer_name | string | human-readable name of the printer |
| jobs.job_status.job_status | enum: string | |
| jobs.job_data | object | printer specific data sent by the printer |
| jobs.job_data.printable_id | string: URN | URN of the file to be printed |
| jobs.job_date_time | string | date the job was created in <month_name> D, YYYY HH:mm:ss format |
| jobs.job_status_time | string | date the last status was sent in <month_name> D, YYYY HH:mm:ss format |
| jobs.member_id | string | the ID of the member |
| jobs.local_job | bool | whether the job was created by print services or sent locally |
| jobs.status | enum: string |
Examples¶
Successful Retreival of Jobs (200)¶
curl -X 'GET' -H 'Authorization: Bearer jwP63dl3zT4fSAiy6jOBrmcr1UKh' -v 'https://developer.api.autodesk.com/ps/v1/print/jobs'
{
"count": 4,
"limit": 20,
"offset": 0,
"_link_prev": "",
"_link_next": "",
"_link": "/print/jobs?limit=20&offset=0",
"member_id": "5UNGP5JZFCVW",
"jobs": [
{
"job_id": "005cd0a1-b1cc-490c-b33d-46b8be6483a0",
"job_name": "my_job1",
"printer_id": 1364,
"job_status": {
"job_status": "created"
},
"job_data": {},
"job_date_time": "August 09, 2016 07:51:25",
"job_status_time": "August 09, 2016 07:51:25",
"local_job": false,
"status": "created"
},
{
"job_id": "b767ca74-89e3-4c43-95e4-3849f19a2392",
"job_name": "my_job1",
"printer_id": 1364,
"job_status": {
"job_status": "queued"
},
"job_data": {
"printable_id": "urn:adsk.objects:os.object:printservices-external/030929a9-99ed-435b-a22e-2133ee49f66a.tar.gz",
"printable_url": "https://developer.api.autodesk.com/oss/v2/signedresources/4b0d3525-e197-4fff-8c36-66c7c0e6f1db"
},
"job_date_time": "August 09, 2016 08:06:22",
"job_status_time": "August 09, 2016 08:06:22",
"local_job": false,
"status": "queued"
},
{
"job_id": "d57d19b9-82b1-47c9-8327-7df80496c029",
"job_name": "my_job1",
"printer_id": 1364,
"job_status": {
"job_status": "queued"
},
"job_data": {
"printable_id": "urn:adsk.objects:os.object:printservices-external/52ba6fcd-9fda-4271-a6d2-74d28bd51c49.tar.gz",
"printable_url": "https://developer.api.autodesk.com/oss/v2/signedresources/d3cdcee9-ea65-42a5-b39a-40c3d86f3be1"
},
"job_date_time": "August 09, 2016 08:04:48",
"job_status_time": "August 09, 2016 08:04:48",
"local_job": false,
"status": "queued"
},
{
"job_id": "d6e2627f-1407-49ac-a97f-420a6d58b606",
"job_name": "my_job2",
"printer_id": 1364,
"job_status": {
"printer_status": "printing",
"job_id": "d6e2627f-1407-49ac-a97f-420a6d58b606",
"job_name": "my_job2",
"member_id": "5UNGP2KZFCVW",
"printer_id": 1364,
"printer_name": "testingapis"
},
"job_data": {
"printable_id": "urn:adsk.objects:os.object:printservices-external/030929a9-99ed-435b-a22e-2133ee49f66a.tar.gz",
"printable_url": "https://developer.api.autodesk.com/oss/v2/signedresources/551f68c7-4ec7-4845-a9d5-70d34ddef728"
},
"job_date_time": "August 09, 2016 08:07:01",
"job_status_time": "August 09, 2016 08:27:49",
"local_job": false
}
]
}
Successful Retreival of Jobs with Created or Queued Statuses (200)¶
curl -X 'GET' -H 'Authorization: Bearer jwP63dl3zT4fSAiy6jOBrmcr1UKh' -v 'https://developer.api.autodesk.com/ps/v1/print/jobs?status=created,queued'
{
"count": 3,
"limit": 20,
"offset": 0,
"_link_prev": "",
"_link_next": "",
"_link": "/print/jobs?status=created,queued&limit=20&offset=0",
"member_id": "5UNGP5JZFCVW",
"jobs": [
{
"job_id": "005cd0a1-b1cc-490c-b33d-46b8be6483a0",
"job_name": "my_job1",
"printer_id": 1364,
"job_status": {
"job_status": "created"
},
"job_data": {},
"job_date_time": "August 09, 2016 07:51:25",
"job_status_time": "August 09, 2016 07:51:25",
"local_job": false,
"status": "created"
},
{
"job_id": "b767ca74-89e3-4c43-95e4-3849f19a2392",
"job_name": "my_job1",
"printer_id": 1364,
"job_status": {
"job_status": "queued"
},
"job_data": {
"printable_id": "urn:adsk.objects:os.object:printservices-external/030929a9-99ed-435b-a22e-2133ee49f66a.tar.gz",
"printable_url": "https://developer.api.autodesk.com/oss/v2/signedresources/4b0d3525-e197-4fff-8c36-66c7c0e6f1db"
},
"job_date_time": "August 09, 2016 08:06:22",
"job_status_time": "August 09, 2016 08:06:22",
"local_job": false,
"status": "queued"
},
{
"job_id": "d57d19b9-82b1-47c9-8327-7df80496c029",
"job_name": "my_job1",
"printer_id": 1364,
"job_status": {
"job_status": "queued"
},
"job_data": {
"printable_id": "urn:adsk.objects:os.object:printservices-external/52ba6fcd-9fda-4271-a6d2-74d28bd51c49.tar.gz",
"printable_url": "https://developer.api.autodesk.com/oss/v2/signedresources/d3cdcee9-ea65-42a5-b39a-40c3d86f3be1"
},
"job_date_time": "August 09, 2016 08:04:48",
"job_status_time": "August 09, 2016 08:04:48",
"local_job": false,
"status": "queued"
}
]
}
