

Last date modified: April 15 2025
The Production Queue contains all production jobs currently running in your Relativity environment. For general information, see
The Production Queue Manager service exposes endpoints used to cancel a single or multiple production jobs, to retry multiple jobs, or to set the priority for them. You can identify the jobs for canceling or retrying by mass operation token or Artifact ID.
You can also use the Production Queue Manager service through .NET. For more information, see Production Queue Manager (.NET).
See these related pages:
Review the following guidelines for working with this service.
The URLs for REST endpoints contain path parameters that you need to set before making a call:
The following example illustrates how to set the path parameters when deleting a data source, but the same convention applies to all URLs in the Production APIs:
1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/production-data-sources/{DataSourceID}
Set the path parameters as follows:
To get all production jobs in queue, send a GET request with a URL in the following format:
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/production-jobs/get-all
The request body is empty.
The response contains the following fields:
Example response:
[
{
"QueueID": 50,
"WorkspaceID": 100,
"WorkspaceName": "Test Case",
"ProductionID": 200,
"ProductionName": "Production (3)",
"JobTypeID": 300,
"JobTypeName": "Produce",
"StatusID": 400,
"Status": "Branding",
"BrandingStatus": "Pending Finalization",
"Priority": 100,
"SubmittedDate": "2024-11-07T12:40:44.76",
"SubmittedBy": 1021,
"SubmittedByName": "Test, User",
"ImagesRemaining": 0
}
]
To cancel a single production job, send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/production-queue/production-jobs/cancel
The request must a jobRef object with the following fields:
1
2
3
4
5
6
7
{
"jobRef": {
"WorkspaceID": 100,
"ProductionID": 200,
"JobID": 300
}
}
The response contains the following fields:
1
2
3
4
5
6
7
{
"WorkspaceID": 100,
"ProductionID": 200,
"JobID": 0,
"CancelSuccessfullySent": true,
"Errors": []
}
You can cancel a collection of production jobs by using mass operation token. This endpoint uses GUID to identify a collection of production jobs. Send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/production-queue/mass-cancel
The request body must contain the following field:
1
2
3
{
"databaseToken": "F420E383-7D4D-4DB1-BC60-959791685857"
}
The response contains the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"TotalJobsRequested": 2,
"TotalJobsSuccessful": 2,
"ProductionQueueResults": [
{
"JobID": 2123,
"ProductionID": 1041791,
"WorkspaceID": 1027293,
"Errors": [],
"RequestSent": true
},
{
"JobID": 2124,
"ProductionID": 1041793,
"WorkspaceID": 1027293,
"Errors": [],
"RequestSent": true
}
],
"Errors": []
}
To cancel multiple production jobs by ID, send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/production-queue/production-jobs/mass-cancel
The request must contain a jobsToBeCanceled object with the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"jobsToBeCanceled": [
{
"WorkspaceID": 100,
"ProductionID": 200,
"JobID": 300
},
{
"WorkspaceID": 101,
"ProductionID": 201,
"JobID": 301
}
]
}
The response contains the following fields
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"NumberOfJobsRequestedForCancel": 2,
"NumberOfJobsCancelWasRequestedSuccessfully": 1,
"CancelJobResults": [
{
"WorkspaceID": 100,
"ProductionID": 200,
"JobID": 300,
"CancelSuccessfullySent": true,
"Errors": []
},
{
"WorkspaceID": 101,
"ProductionID": 201,
"JobID": 301,
"CancelSuccessfullySent": false,
"Errors": [
"Invalid Production JobRef. Cannot find Production based on WorkspaceID and ProductionID, or based on JobID."
]
}
],
"Errors": []
}
To set the priority on a collection of production jobs in the queue, send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/production-queue/mass-prioritize
The request must contain the following fields:
1
2
3
4
{
"databaseToken": "F420E383-7D4D-4DB1-BC60-959791685857",
"priority": 10
}
The response contains the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"TotalJobsRequested": 2,
"TotalJobsSuccessful": 2,
"ProductionQueueResults": [
{
"JobID": 2123,
"ProductionID": 1041791,
"WorkspaceID": 1027293,
"Errors": [],
"RequestSent": true
},
{
"JobID": 2124,
"ProductionID": 1041793,
"WorkspaceID": 1027293,
"Errors": [],
"RequestSent": true
}
],
"Errors": []
}
You can retry a collection of production jobs by using a mass operation token. This endpoint uses GUID to identify a collection of production jobs.
Send a POST request with a URL in the following format:
1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/production-queue/mass-retry
The request body must contain the following field:
1
2
3
{
"databaseToken": "F420E383-7D4D-4DB1-BC60-959791685857"
}
The response contains the following fields:
Note: The results don't indicate whether the productions were successfully rerun. They only indicate that the retries were successfully submitted.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"TotalJobsRequested": 2,
"TotalJobsSuccessful": 2,
"ProductionQueueResults": [
{
"JobID": 2123,
"ProductionID": 1041791,
"WorkspaceID": 1027293,
"Errors": [],
"RequestSent": true
},
{
"JobID": 2124,
"ProductionID": 1041793,
"WorkspaceID": 1027293,
"Errors": [],
"RequestSent": true
}
],
"Errors": []
}
To retry multiple production jobs by ID, send a POST request with a URL in the following format:
1
<host>//Relativity.REST/api/relativity-productions/{versionNumber}/production-queue/production-jobs/mass-retry
The request must contain a jobsToBeRetried object with the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"jobsToBeRetried": [
{
"WorkspaceID": 100,
"ProductionID": 200,
"JobID": 300
},
{
"WorkspaceID": 101,
"ProductionID": 201,
"JobID": 301
}
]
}
The response contains the following fields:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"NumberOfJobsRequestedForRetry": 2,
"NumberOfJobsRetryWasRequestedSuccessfully": 1,
"RetryJobResults": [
{
"WorkspaceID": 100,
"ProductionID": 200,
"JobID": 300,
"RetrySuccessfullySent": true,
"Errors": []
},
{
"WorkspaceID": 101,
"ProductionID": 201,
"JobID": 301,
"RetrySuccessfullySent": false,
"Errors": [
"Invalid Production JobRef. Cannot find Production based on WorkspaceID and ProductionID, or based on JobID."
]
}
],
"Errors": []
}
On this page
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!
Additional Resources |
|||
DevHelp Community | GitHub | Release Notes | NuGet |