Processing Document Manager (REST)

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.

Note: 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.

Note: 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 
<host>/Relativity.Rest/API/relativity-processing/v1/workspaces/{your workspace id}/documents/{your file ID}/metadata

Retrieve error history for a document

To retrieve the error history for a document, send a GET request to the following URL

Copy 
<host>/Relativity.Rest/API/relativity-processing/v1/workspaces/{your workspace id}/documents/{your file ID}/errors?skip={skip}&top={top}

Retry deleting documents

To retry deleting documents, send a POST request to the following URL

Copy 
<host>/Relativity.Rest/API/relativity-processing/v1/workspaces/{your workspace id}/documents/retry

Request Body Example

Copy 
{
    "documentsRequest":
    {
        "ProcessingFileIDs":[1,2,3],
        “Expression”:{expression to apply on file IDs}
    }
}

Retry document errors

Note: The Retry Document Errors (retry-errors) endpoint is not currently supported. Support for this endpoint will be added in a future release of Relativity Server

To retry document errors, send a POST request to the following URL

Copy 
<host>/Relativity.Rest/API/relativity-processing/v1/workspaces/{your workspace id}/documents/retry-errors

Request Body Example

Copy 
{
    "documentsRequest":
    {
        "ProcessingFileIDs":[1,2,3],
        “Expression”:{expression to apply on file IDs}
    }
}

Publish documents

To publish documents, send a POST request to the following URL

Copy 
<host>/Relativity.Rest/API/relativity-processing/v1/workspaces/{your workspace id}/documents/publish

Request Body Example

Copy 
{
    "documentsRequest":
    {
        "ProcessingFileIDs":[1,2,3],
        “Expression”:{expression to apply on file IDs}
    }
}

Retrieve count of publishable documents

To retrieve a count of publishable documents, send a POST request to the following URL

Copy 
<host>/Relativity.Rest/API/relativity-processing/v1/workspaces/{your workspace id}/documents/count

Request Body Example

Copy 
{
    "documentsRequest":
    {
        "ProcessingFileIDs":[1,2,3],
        “Expression”:{expression to apply on file IDs}
    }
}