Feedback
Last date modified: 2026-Mar-16
Processing Document Manager (REST) v2
This topic describes the documents endpoint, which is used to access the Processing Document Manager service. The Processing Document Manager service includes methods for working with documents in a publishing set.
See the topic Get started with the Processing API for general guidance on the Processing API, and links to documentation for the other interfaces and services in this API.
See the section on Filter expressions for more details on building an Expression value, which may be used in the Request Body for certain endpoints.
Retrieve metadata fields and values for a document
To retrieve metadata fields and values for a document, send a GET request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/{logical ID}/metadata
Retrieve metadata fields and values for multiple documents
To retrieve metadata fields and values for multiple documents, send a POST request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/metadata
Request Body Example
Copy
1
2
3
4
5
6
{
"request":
{
"LogicalIDs":["97a02181f1ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42233d12","78a02181f6ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42231b52"]
}
}
The response returns the metadata for each requested document.
Retrieve the physical file locations for the requested documents
To retrieve the physical file locations for specified documents, send a POST request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/get-file-paths
Request Body Example
Copy
1
2
3
4
5
6
{
"request":
{
"LogicalIDs":["97a02181f1ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42233d12","78a02181f6ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42231b52"]
}
}
The response returns the physical location for each requested document.
Retrieve error history for a document
To retrieve the error history for a document, send a GET request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/{logical ID}/errors?skip={skip}&top={top}
Retry deleting documents
To retry deleting documents, send a POST request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/retry-delete
Request Body Example
Copy
1
2
3
4
5
6
7
{
"documentsRequest":
{
"LogicalIDs":["97a02181f1ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42233d12","78a02181f6ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42231b52","27a02181e2ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42232f46"],
"Expression":{expression used to filter files}
}
}
The LogicalIDs array takes precedence over Expression. If both are specified, then LogicalIDs array is used.
Retry document errors
To retry document errors, send a POST request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/retry-errors
Request Body Example
Copy
1
2
3
4
5
6
7
{
"documentsRequest":
{
"LogicalIDs":["97a02181f1ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42233d12","78a02181f6ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42231b52","27a02181e2ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42232f46"],
"Expression":{expression used to filter files}
}
}
The LogicalIDs array takes precedence over Expression. If both are specified, then LogicalIDs array is used.
Publish documents
To publish documents, send a POST request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/publish
Request Body Example
Copy
1
2
3
4
5
6
7
{
"documentsRequest":
{
"LogicalIDs":["97a02181f1ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42233d12","78a02181f6ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42231b52","27a02181e2ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42232f46"],
"Expression":{expression used to filter files}
}
}
The LogicalIDs array takes precedence over Expression. If both are specified, then LogicalIDs array is used.
Retrieve publish job errors
To retrieve publish job errors, send a POST request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/get-publish-job-errors
Request Body Example
Copy
1
2
3
4
5
6
7
{
"documentsRequest":
{
"LogicalIDs":["97a02181f1ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42233d12","78a02181f6ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42231b52","27a02181e2ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42232f46"],
"Expression":{expression used to filter files}
}
}
The LogicalIDs array takes precedence over Expression. If both are specified, then LogicalIDs array is used.
Retrieve count of publishable documents
To retrieve a count of publishable documents, send a POST request to the following URL:
Copy
1
<host>/Relativity.Rest/API/relativity-processing/v2/workspaces/{your workspace id}/documents/count
Request Body Example
Copy
1
2
3
4
5
6
7
{
"documentsRequest":
{
"LogicalIDs":["97a02181f1ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42233d12","78a02181f6ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42231b52","27a02181e2ff22286d552ab844abb715f79b5361aa013a0c0f0b7caa42232f46"],
"Expression":{expression used to filter files}
}
}
The LogicalIDs array takes precedence over Expression. If both are specified, then LogicalIDs array is used.
On this page
- Processing Document Manager (REST) v2
- Retrieve metadata fields and values for a document
- Retrieve metadata fields and values for multiple documents
- Retrieve the physical file locations for the requested documents
- Retrieve error history for a document
- Retry deleting documents
- Retry document errors
- Publish documents
- Retrieve publish job errors
- Retrieve count of publishable documents
