Production Manager (REST)

The request may contain the following fields:

• DataSources - an array of ProductionDataSource objects with the following fields:
  • ArtifactTypeID - the Relativity artifact type ID of the data source.
  • ProductionType - the type of production that applies to this data source. The ProductionType enumeration defines valid values for this property.
  • SavedSearch - includes the following fields:
    • ArtifactID - the Artifact ID of the saved search.
    • Name - the user-friendly name of the saved search.
  • UseImagePlaceholder - describes how to use the image placeholder as follows:
    • NeverUseImagePlaceholder - never use image placeholder.
    • AlwaysUseImagePlaceholder - always use the image placeholder, even if image exists.
    • WhenNoImageExists - only use image placeholder when images don't exist.
  • Placeholder - includes the following fields:
    • ArtifactID - the Artifact ID of the placeholder.
    • Name - the user-friendly name of the placeholder.
  • MarkupSet - includes the following fields:
    • ArtifactID - the Artifact ID of the markup set.
    • Name - the user-friendly name of the markup set.
  • BurnRedactions - a Boolean value indicating whether to burn redactions when producing image type productions.
  • PlaceholderFilename - the name of the placeholder file.
  • PlaceholderFileSize - an integer representing the size of the placeholder file.
  • Name - the user-friendly name of the data source.

• Details - contains the following fields:
  • EmailRecipients - a string containing the emails of recipients who are notified about the status of the production.
  • BrandingFont - a string indicating the font used for branding.
  • BrandingFontSize - an integer indicating the font size used for branding.
  • ScaleBrandingFont - a Boolean value indicating whether to scale the branding font.
  • WrapBrandingText - a Boolean value indicating whether to wrap the branding text when it may overlap with adjacent headers or footers.
  • PlaceholderImageFormat - the file type of image used for the placeholder. Set this field to Tiff or Jpeg.
  • FirstBatesValue - a string indicating the initial Bates number for the completed production.
  • LastBatesValue - a string indicating the final Bates number for the completed production.
  • DateProduced - an optional the date and time field to store data about the production.
• Numbering - contains the following fields:
  • BatesPrefix - a string used to define the prefix for a Bates number.
  • BatesSuffix - a string used to define the suffix for a Bates number.
  • BatesStartNumber - an integer indicating the initial Bates number for the production.
  • NumberOfDigitsForDocumentNumbering - an integer representing the number of digits used for document-level numbering. The range is from 1 to 7.
  • NumberingType - the document number type as defined in the NumberingType enumeration. Values include PageLevel, DocumentLevel, OriginalImage, ExistingProduction, and DocumentField.
  • AttachmentRelationalField - contains the following information:
    • ArtifactID - the Artifact ID for the field.
    • ViewFieldID - the field ID for the view.
    • Guids - an array of GUIDs for the field.
    • Name - the user-friendly name of the field.
• SortOrder - an array of Sort objects with properties indicating the direction of the sort as ascending or descending, and the name of the field to sort on. These objects determine how the documents in the production are sorted. A maximum of five Sort objects can be specified.
• Headers - contain the following fields:
  • Left - defines the left header with the following fields:
    • Type - indicates the header types as defined in the HeaderFooterType enumeration. Values include None, ProductionBatesNumber, Field, FreeText, OriginalImageNumber, DocumentIdentifierAndPageNumber, and AdvancedFormatting.
    • Field - specifies the document field used in header. If the Type field is set to Field, the following values must be specified:
      • ArtifactID - the Artifact ID for the field.
      • ViewFieldID - the field ID for the view.
      • Guids - an array of GUIDs for the field.
      • Name - the user-friendly name of the field.
    • FreeText - specifies the text used in header, which may include a combination of text, tokens, and carriage returns. If the Type field is set to FreeText, this field specifies the text.
    • AdvancedFormatting - specifies formatting using a subset of HTML. If the Type field is set to AdvancedFormatting, this field specifies the formatting.
    • FriendlyName - a descriptive name for the header.
  • Right - see the descriptions in Left field.
  • Center - see the descriptions in Left field.
• Footers - contains the following the Left, Right, and Center fields. See the descriptions in Left field under the Header.
• Keywords - optional words or phrases used to describe the production.
• Notes - an optional description or other information about the production.
• RelativityApplications - an array of Relativity applications represented by ObjectIdentifier objects, which contain the Artifact ID and GUIDs for an application. The production set is linked to the applications in this array. If the array is empty, then the production set isn't linked to any application.
• ShouldCopyInstanceOnWorkspaceCreate - a Boolean value indicating whether instances of this production are copied when a new workspace is created.
• Name - a user-friendly name for the production set.

The response also contains these fields:

• ProductionMetadata - contains the following fields created and updated by Relativity:
  • RestrictionOverrideBy - tracks production restrictions for internal use only.
  • RestrictionOverrideOn - tracks production restrictions by date and time for internal use only.
  • Status - indicates the status as defined in the Production Status enumeration.
  • Imported - a Boolean value indicating whether this production was imported through the Relativity Desktop Client.
  • LegacyProductionSet - a Boolean value indicating whether this production is a legacy production set.
  • DocumentsHaveRedactions - a Boolean value indicating whether documents have redactions after they are produced.
  • SystemCreatedBy - contains the following fields:
    • Secured - indicates whether the current user has permission to view the setting in the Value field.
    • Value - the Artifact ID and name of the user who created the production.
  • SystemCreatedOn - the date and time when the production was added to Relativity. See the description of the Secured field in SystemCreatedBy.
  • SystemLastModifiedBy - contains the Artifact ID and name of the user who recently updated the production. See the description of the Secured field in SystemCreatedBy.
  • SystemLastModifiedOn - the date and time when the production was most recently modified. See the description of the Secured field in SystemCreatedBy.
  • LastRunError - a string representing a status message for the most recent error.
  • LastRunStatus - a string representing a status message for the most recent run.
  • BrandingPercentageComplete - a decimal indicating the percentage of the branding completed on the production.
  • ImagingPercentageComplete - a decimal indicating the percentage of the imaging completed on the production.
  • TotalDocumentCount - an integer representing the total number of documents in the production.
  • TotalImagesCount - an integer representing the total number of images in the production.
  • DocumentsWithImages - an integer representing the total number of documents with images.
  • DocumentsWithNatives - an integer representing the total number of documents with native files.
  • DocumentsWithPlaceholders - an integer representing the total number of documents with placeholders.
  • DocumentsWithRedactions - an integer representing the total number of documents with redactions.
  • TotalProducedImageSize - an integer representing the total image size in GBs.
  • ProductionSavedSearch - contains the following fields:
    • ArtifactID - the Artifact ID of the saved search used by the production.
    • Name - the user-friendly name of the saved search used by the production.
• ProductionID - the Artifact ID of the production
• Name - the user-friendly name of the production.

The response contains a ProductionJobResult object with the following fields:

• JobID - the ID for the production job.
• Errors - an array of strings providing error messages if the job wasn't created.
• Messages - an array of strings providing additional information about the job.
• Warnings - an array of strings providing warnings about the job.
• WasJobCreated - a Boolean value indicating whether the production job was created.
• ProductionID - the Artifact ID of the production.
• WorkspaceID - the Artifact ID of the workspace containing the production.

The response contains the following fields:

• field object - an object for each field associated with the data source. In the sample JSON, these objects are ScaleBrandingFont, BrandingFont, and others.
  • Guid - the GUID for the field.
  • ID - the Artifact ID for the field.
  • DefaultValue - depends on the field type. For example, a single choice field returns the Artifact ID of a choice for its default value.

The response contains a ProductionJobStatusResult object with the following fields:

• BrandingErrors - an array of branding error messages.
• NumberOfBrandingErrors - an integer representing the total number of branding errors in the job.
• JobStatus - indicates the status of the job based on the ProductionJobStatus enumeration:
  • NotRunning - the job is currently not running.
  • Running - the job is currently running.
  • Errored - the job isn't running and is errored.
  • Complete - the job is currently isn't running and is completed.
• Status - the status of the production, such as New, Staging, Branding and others. See the Production Status.
• PercentageImaging - a decimal representing the percentage completed of the branding process.
• PercentageProducing - a decimal representing the percentage completed of the producing process.
• LastRunStatus - a string representing a status message for the most recent run.
• LastRunError - a string representing a status message for the most recent error.

The response contains a ProductionProgress object with the following fields:

• Status - a string indicating the status of the production.
• StartTime - the date and time that the production began running.
• CurrentBrandingQueueLength - a long indicating the number of incomplete branding jobs.
• TotalImages - a long indicating the total number of images in the production.
• ImagesToBeBranded - a long indicating the number of images to be branded.
• ImagesWithErrors - a long indicating the number of images with branding errors.
• TotalDocuments - a long indicating the total number of documents in the production.
• DocumentsWithImages - a long indicating the total number of documents with images.
• DocumentsWithPlaceHolders - a long indicating the total number of documents with placeholders.
• DocumentsWithRedactions - a long indicating the total number of documents with redactions.
• DocumentsWithNatives - a long indicating the total number of documents with native files.
• ImageSizeInGb - the total size of the all the images in GBs.
• ProductionRunDate - the date and time that the production was produced.

To retrieve images by using paging, send a GET request with a URL in the following format:

1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/productions/{ProductionID}/production-images/token?top={top}&skip={skip}

Set the path parameters in the URL as follows:

• {WorkspaceId} - the Artifact ID of workspace containing productions to retrieve.
• {ProductionID} - the Artifact ID of the production containing the images.
• {top} - an integer representing the number of images to be returned.
• {skip} - an integer representing the number of images to omit before retrieving the results.

The request body is empty.

The response contains PagedImageFilesResult object with the following fields:

• TotalResultSet - an integer indicating the number of results for this request.
• ResultCount - an integer indicating the number of results returned in the current page.
• ImageFiles - an array of objects representing an image file. The files aren't in any specific order. Each produced file has the following fields:
  • DocumentID - the Artifact ID of a document.
  • FileID - an ID for the file.
  • PageNumber - an integer indicating the page number of this file in the document. The page numbers are 0-indexed.
  • HasRedactions - a Boolean value indicating whether this image file has redactions.
  • FileGuid - a GUID for the file.
• Errors - an array of errors associated with the current page.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
    "TotalResultSet": 7,
    "ResultCount": 7,
    "ImageFiles": [
        {
            "DocumentID": 1045081,
            "FileID": 13704,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "40b546c1-ad51-4857-a695-84e72fb70e24"
        },
        {
            "DocumentID": 1045082,
            "FileID": 13705,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "0ce86285-4865-45af-b77d-1dedda3fb114"
        },
        {
            "DocumentID": 1045083,
            "FileID": 13706,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "676fcdbd-2ef7-4270-b75c-173bd6fd052c"
        },
        {
            "DocumentID": 1045084,
            "FileID": 13707,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "dd718d91-833f-4166-a77d-fda4630af226"
        },
        {
            "DocumentID": 1045085,
            "FileID": 13708,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "b164bd13-0824-497f-98ac-3904a3bf3e33"
        },
        {
            "DocumentID": 1045086,
            "FileID": 13709,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "c5c9721d-64d4-4ac1-a62e-974146c9afe7"
        },
        {
            "DocumentID": 1045087,
            "FileID": 13710,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "c7a15e16-7d80-4b78-877c-67e1a037e1a8"
        }
    ],
    "Errors": []
}

To retrieve images by using document IDs, send a GET request with a URL in the following format:

1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/productions/{ProductionID}/production-images

The request must contain the following field:

• documentIDs - the Artifact IDs of the documents with images to be retrieved.

1
2
3
4
5
6
{
    "documentIDs":[
       1045081,
       1045082
    ]
}

The response contains an ImageFilesResult object with the following fields:

• Count - an integer representing the total number of files returned.
• ImageFiles - an array of objects representing an image file. Each image file has the following fields:
  • DocumentID - the Artifact ID of a document.
  • FileID - an ID for the file.
  • PageNumber - an integer indicating the page number of this file in the document. The page numbers are 0-indexed.
  • HasRedactions - a Boolean value indicating whether this image file has redactions.
  • FileGuid - a GUID for the file.
• Errors - an array of errors associated with this result.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
    "Count": 2,
    "ImageFiles": [
        {
            "DocumentID": 1045081,
            "FileID": 13704,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "40b546c1-ad51-4857-a695-84e72fb70e24"
        },
        {
            "DocumentID": 1045082,
            "FileID": 13705,
            "PageNumber": 0,
            "HasRedactions": false,
            "FileGuid": "0ce86285-4865-45af-b77d-1dedda3fb114"
        }
    ],
    "Errors": []
}

To retrieve produced productions by using document IDs, send a GET request with a URL in the following format:

1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/produced-production

The body of the request must include the following fields:

• documentIDs -an array of Artifact IDs for the documents with produced productions to retrieve.
• excludeNonReproducible - a Boolean value indicating whether to return non-reproducible productions. The default value is false.

1
2
3
4
5
6
"documentIDs":[
             {{documentID}},
             {{documentID}}
      ],
    "excludeNonReproducible": {{excludeNonReproducible}}
}

To retrieve produced productions for a collection of documents by using a mass operation token, send a GET request with a URL in the following format:

1
<host>/Relativity.REST/api/relativity-productions/{versionNumber}/workspaces/{WorkspaceID}/tokens/{token}/produced-production?{excludeNonReproducible}

Set the path parameters in the URL as follows:

• {workspaceID} - the Artifact ID of workspace containing produced productions to retrieve.
• {token} - a GUID used as database token to represent the collection of documents with produced productions.
• {excludeNonReproducible} - a Boolean value indicating whether to return non-reproducible productions. The default value is false.

The request body is empty.

• ConflictMessage - a message providing information about document conflicts.
• ProductionErrors - an array of error messages for the production.
• CanContinue - a Boolean value indicating whether the production is able to continue running.
• ContinueMessage - a string providing information about the ability of the production to continue running.

• ErroredDocumentCount - an integer representing the number of documents that errored during staging.
• DuplicateDocuments - contains the following fields:
  • Name - the name of a document found to be a duplicate.
  • DataSourceNames - an array of data sources where the document was found to be duplicated.
• ErrorMessage - a message with information about the documents that errored during staging.

The response contains a specified number of branding errors for a production. The MaxListItems instance setting controls the number of branding errors returned.

This method returns an empty list if the production isn't in an errored state or if the user doesn't have permission to view the errored documents.

The response contains an array of BrandingError objects that contain the following fields:

• DocumentName - a string identifying the errored document.
• DocumentID - the Artifact ID of the document.
• FileID - the ID of the file that wasn't branded. It is provided for documents with multiple pages.
• ErrorMessage - a string contains branding error messages.

• ProductionRestrictions - contains the following fields:
  • SavedSearchID - the Artifact ID of the saved search used for the production restriction on the workspace. If no restriction exists, this field is 0.
  • SavedSearchName - the user-friendly name of the saved search. If no restriction exists, this field is an empty string.
• DocumentIDs - an array of Artifact IDs for documents that conflict with the production restriction on the workspace. If no restriction exists, this list is empty.
• HasOverridePermission - a Boolean value indicating whether the user has permission to override conflicts. This field returns true when the user has edit permissions for productions and override permissions to restrictions.

The response is a status code of 200 for productions with a Staged or Starting status. Other production statuses return a code of 400 with validation errors.

• BeginBates - a string representing the beginning Bates number for the production.
• EndBates - a string representing the ending Bates number for the production.
• DateProduced - the date and time that the production was produced.
• ProductionID - the Artifact ID for the production
• Name - the user-friendly name of the production.

• Name - the user-friendly name of the re-production.
• ProductionID - the Artifact ID of the re-production. If the re-production has been deleted, this field is -1.
• IsDeleted - a Boolean value indicating whether the re-production has been deleted.

The response contains a result object for each production in the re-production job. Each object contains the following fields:

• JobID - the ID of the re-production job.
• Errors - an array of strings providing error messages for a re-production job.
• Messages - an array of strings providing warning messages about the re-production job.
• Warnings - an array of strings providing warnings about the job.
• WasJobCreated - a Boolean value indicating whether the job was created.
• ProductionID - the Artifact ID of the production run in this job.
• WorkspaceID - the Artifact ID of workspace containing the re-production.

The response contains the following fields:

• NumberOfJobsRequestedForCancel - the total number of production queue jobs requested for the operation.
• NumberOfJobsCancelWasRequestedSuccessfully - the total number of jobs successfully operated on.
• CancelJobResults - an array containing the results for each requested job cancellation. Each job contains the following fields:
  • WorkspaceID - the Artifact ID of the workspace containing the production.
  • ProductionID - the Artifact ID of the production.
  • JobID - the Artifact ID of the production job.
  • CancelSuccessfullySent - a Boolean value indicating whether the cancel request was successfully sent.
  • Errors - an array of errors that occurred during the cancel operation.
• Errors - an array of error messages for the overall operation.