Short Message Viewer Manager (REST)

The request includes the following field:

• attachmentIDs - a string array containing IDs for attachments to return information about. The ID corresponds to the attachment object in the RSMF manifest file. See rsmf_manifest.json file on the RelativityOne Documentation site.

The response is an array of AttachmentInfo objects. These objects contain the following fields:

• AttachmentID - the ID field for the attachment in the RSMF manifest file.
• DocumentArtifactID - the ArtifactID of the attachment document.
• FileGuid - the GUID for the attachment file.

The response contains the following fields:

• participantRequests - an array containing ParticipantRequestInfo objects. A ParticipantRequestInfo object contains the following fields:
  • Id - the ID for the participant in the RSMF manifest file. For more information, see rsmf_manifest.json file on the RelativityOne Documentation site.
  • Name - the display field for the participant in the RSMF manifest file.
  • Email - an optional email field for the participant in the RSMF manifest file.

The response is an array of ParticipantResponseInfo objects. A ParticipantResponseInfo object contains the following fields:

• ParticipantID - the ID field for the participant in the RSMF manifest file. For more information, see rsmf_manifest.json file on the RelativityOne Documentation site.
• EntityName - the name of the corresponding entity object for the participant.
• Aliases - a list of alias names associated with the entity object for the participant.
• Url - a URL that links to the entity object corresponding to the participant.

The request contains the following fields:

• fileName - a string representing the file name of a specific short message document for validation.
• file - a IKeplerStream object representing the file being validated.

The following code sample illustrates how to upload a file for validation using JavaScript:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const fileinput = document.getElementById("file_input");
fileinput.onchange = event => {
    currentFile = event.target.files[0];
};
 
const metaData = {
    fileName: currentFile.name
};
 
const formData = new FormData();
formData.append("file", currentFile);
formData.append("", new Blob([JSON.stringify(metaData)], { type: "application/json" }));
 
const xhr = new XMLHttpRequest();
 
xhr.onreadystatechange = () => {
    if (xhr.readyState === 4) {
        const response = JSON.parse(xhr.response);
    }
}
 
xhr.open('post', url);
xhr.setRequestHeader("X-CSRF-Header", csrfToken);
xhr.send(formData);

The response is an RSMFValidationResponse containing the following fields:

• Status - indicates whether the RSMF is valid. Its value may be Passed, Failed, or PassedWithWarnings.
• Errors - a list of validation errors for the RSMF. Each object contains these properties: LineNumber, LinePosition, Message, and list of Submessages.
• Warnings - a list of validation warnings for the RSMF. Each object contains these properties: LineNumber, LinePosition, Message, and list of Submessages.

The response is an RSMFValidationResponse containing the following fields:

• Status - indicates whether the RSMF is valid. Its value may be Passed, Failed, or PassedWithWarnings.
• Errors - a list of validation errors for the RSMF. Each object contains these properties: LineNumber, LinePosition, Message, and list of Submessages.
• Warnings - a list of validation warnings for the RSMF. Each object contains these properties: LineNumber, LinePosition, Message, and list of Submessages.

The request contains the following fields:

• SliceRequest - contains request information about the creation of a new document based on a subset of events. It contains the following fields:
  • EventIndexes - a list of events to slice or extract from the original RSMF. This list corresponds to the indexes in the events array of the manifest file. For more information, see rsmf_manifest.json file on the RelativityOne Documentation site.
  • SliceRequestOptions - a set of options that define the behavior of the slice operation:
    • CreateAttachments - indicates whether to create and import new documents for the attachments in the new file. The default value is false.
    • SourceLayoutID - an optional Artifact ID for the document layout containing fields that are copied from the parent document to the new document.
    • PreserveAllParticipants - indicates whether to include all participants from the original RSMF in the new RSMF. The default value is true. If this option is false, only active participants are included in the new RSMF.
    • EmailConfirmation - indicates whether an email is sent to initiating user on completion of the slice. The default value is true, indicating an email should be sent.