Relativity

Relativity ShortMessageViewerService API

The ShortMessageViewerService API from Relativity — 5 operation(s) for shortmessageviewerservice.

GitHub OpenAPI

Operations 5

POST /v{version}/workspaces/{workspaceID}/short-messages/{documentID}/attachment-info Retrieves attachment metadata for a short message document #
POST /v{version}/workspaces/{workspaceID}/short-messages/participant-info Retrieves entity information for one or more short message participants #
GET /v{version}/workspaces/{workspaceID}/short-messages/{documentID}/message-json Retrieves the JSON representation of a short message conversation document #
POST /v{version}/workspaces/{workspaceID}/short-messages/{documentID}/slice Requests creation of a new short message document from a subset of events #
GET /v{version}/workspaces/{workspaceID}/short-messages/{documentID}/validate Validates whether the specified short message document contains a valid RSMF… #

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://artifacts.apis.io/relativity/rate-limits/relativity-rate-limits.yml
📖
Documentation
https://platform.relativity.com/RelativityOne/Content/Relativity_Platform/Platform_APIs.htm
📖
GettingStarted
https://platform.relativity.com/RelativityOne/Content/Getting_Started/Basic_REST_API_concepts.htm
📖
Documentation
https://help.relativity.com/RelativityOne/Content/Management_Console/Cost_Explorer.htm

Specifications

⚙
OpenAPI
https://artifacts.apis.io/relativity/openapi/relativity-shortmessageviewerservice-api-openapi.yml

Other Resources

🔗
Plans
https://artifacts.apis.io/relativity/plans/relativity-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/relativity/finops/relativity-finops.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relativity:relativity-shortmessageviewerservice-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

relativity-shortmessageviewerservice-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: reviewservice (public) Short Message Viewer Service API
security:
- Bearer: []
tags:
- name: ShortMessageViewerService
paths:
  /v{version}/workspaces/{workspaceID}/short-messages/{documentID}/attachment-info:
    post:
      tags:
      - ShortMessageViewerService
      summary: Retrieves attachment metadata for a short message document
      description: Returns attachment records for the attachment identifiers supplied in the request body.
      parameters:
      - name: workspaceID
        in: path
        description: The Artifact ID of the workspace containing the documents for short message viewer.
        required: true
        schema:
          type: integer
          format: int32
      - name: documentID
        in: path
        description: The Artifact ID of the short message document.
        required: true
        schema:
          type: integer
          format: int32
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: The attachment IDs to return information about.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.GetAttachmentInfoRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.GetAttachmentInfoRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.GetAttachmentInfoRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.AttachmentInfo'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.AttachmentInfo'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.AttachmentInfo'
      operationId: postV{version}WorkspacesByWorkspaceIDShortMessagesByDocumentIDAttachmentInfo
      x-operation-id-source: derived
  /v{version}/workspaces/{workspaceID}/short-messages/participant-info:
    post:
      tags:
      - ShortMessageViewerService
      summary: Retrieves entity information for one or more short message participants
      description: Participant lookups use participant identity details from the request body and return mapped entity details.
      parameters:
      - name: workspaceID
        in: path
        description: The Artifact ID of the workspace containing the documents for short message viewer.
        required: true
        schema:
          type: integer
          format: int32
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: The ParticipantRequest object of the workspace containing the name, email address and id of a participant for short message viewer.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.GetParticipantInfoRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.GetParticipantInfoRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.GetParticipantInfoRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.ParticipantResponseInfo'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.ParticipantResponseInfo'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.ParticipantResponseInfo'
      operationId: postV{version}WorkspacesByWorkspaceIDShortMessagesParticipantInfo
      x-operation-id-source: derived
  /v{version}/workspaces/{workspaceID}/short-messages/{documentID}/message-json:
    get:
      tags:
      - ShortMessageViewerService
      summary: Retrieves the JSON representation of a short message conversation document
      description: The JSON structure aligns with RSMF manifest-style payloads used by the short message viewer.
      parameters:
      - name: workspaceID
        in: path
        description: The Artifact ID of the workspace containing the documents for short message viewer.
        required: true
        schema:
          type: integer
          format: int32
      - name: documentID
        in: path
        description: The Artifact ID of the document for short message viewer.
        required: true
        schema:
          type: integer
          format: int32
      - name: version
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
            text/json:
              schema:
                type: string
                format: binary
      operationId: getV{version}WorkspacesByWorkspaceIDShortMessagesByDocumentIDMessageJson
      x-operation-id-source: derived
  /v{version}/workspaces/{workspaceID}/short-messages/{documentID}/slice:
    post:
      tags:
      - ShortMessageViewerService
      summary: Requests creation of a new short message document from a subset of events
      description: This operation queues slicing work and supports options such as attachment creation and participant preservation.
      parameters:
      - name: workspaceID
        in: path
        description: The Artifact ID of the workspace containing the document to be sliced.
        required: true
        schema:
          type: integer
          format: int32
      - name: documentID
        in: path
        description: The Artifact ID of the document to be sliced.
        required: true
        schema:
          type: integer
          format: int32
      - name: version
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: A SliceRequest object containing details about the request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.SliceRSMFRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.SliceRSMFRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Reviewservice.Api.V2.Models.SliceRSMFRequest'
      responses:
        '200':
          description: OK
      operationId: postV{version}WorkspacesByWorkspaceIDShortMessagesByDocumentIDSlice
      x-operation-id-source: derived
  /v{version}/workspaces/{workspaceID}/short-messages/{documentID}/validate:
    get:
      tags:
      - ShortMessageViewerService
      summary: Validates whether the specified short message document contains a valid RSMF…
      description: Returns validation status and diagnostic details for document-level RSMF validation.
      parameters:
      - name: workspaceID
        in: path
        description: The Artifact ID of the workspace containing the documents for short message viewer.
        required: true
        schema:
          type: integer
          format: int32
      - name: documentID
        in: path
        description: The Artifact ID of the short message document.
        required: true
        schema:
          type: integer
          format: int32
      - name: version
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.RSMFValidationResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.RSMFValidationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.RSMFValidationResponse'
      operationId: getV{version}WorkspacesByWorkspaceIDShortMessagesByDocumentIDValidate
      x-operation-id-source: derived
components:
  schemas:
    Relativity.DocumentViewer.Services.V2.ParticipantResponseInfo:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        EntityName:
          type:
          - string
          - 'null'
        Aliases:
          type:
          - array
          - 'null'
          items:
            type: string
        Url:
          type:
          - string
          - 'null'
      additionalProperties: false
    Relativity.DocumentViewer.Domain.Enums.RSMFValidationStatusType:
      enum:
      - Passed
      - Failed
      - PassedWithWarnings
      type: string
    Relativity.DocumentViewer.Services.V2.AttachmentInfo:
      type: object
      properties:
        AttachmentId:
          type:
          - string
          - 'null'
        DocumentArtifactId:
          type: integer
          format: int32
        FileGuid:
          type:
          - string
          - 'null'
      additionalProperties: false
    Relativity.DocumentViewer.Services.V2.SliceRequestOptions:
      type: object
      properties:
        CreateAttachments:
          type:
          - boolean
          - 'null'
        SourceLayoutID:
          type:
          - integer
          - 'null'
          format: int32
        PreserveAllParticipants:
          type:
          - boolean
          - 'null'
        EmailConfirmation:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    Relativity.DocumentViewer.Domain.DTOs.RSMFValidationResponse:
      type: object
      properties:
        Status:
          $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.Enums.RSMFValidationStatusType'
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.RSMFValidationDetails'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Relativity.DocumentViewer.Domain.DTOs.RSMFValidationDetails'
      additionalProperties: false
    Relativity.DocumentViewer.Domain.DTOs.RSMFValidationDetails:
      type: object
      properties:
        LineNumber:
          type: integer
          format: int32
        LinePosition:
          type: integer
          format: int32
        Message:
          type:
          - string
          - 'null'
        Submessages:
          type:
          - array
          - 'null'
          items:
            type: string
        ErrorCode:
          $ref: '#/components/schemas/Relativity.RSMFU.Validator.RSMFValidatorErrorCode'
      additionalProperties: false
    Relativity.DocumentViewer.Services.V2.SliceRequest:
      type: object
      properties:
        EventIndexes:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        Options:
          $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.SliceRequestOptions'
        CorrelationId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    Reviewservice.Api.V2.Models.SliceRSMFRequest:
      type: object
      properties:
        sliceRequest:
          $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.SliceRequest'
      additionalProperties: false
    Relativity.DocumentViewer.Services.V2.ParticipantRequestInfo:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        Email:
          type:
          - string
          - 'null'
      additionalProperties: false
    Relativity.RSMFU.Validator.RSMFValidatorErrorCode:
      enum:
      - RSMFValidatorError
      - RSMFValidity
      - RSMFHeadersMissing
      - RSMFHeaderVersion
      - RSMFAccessZip
      - ZipIntegrity
      - ZipMissingManifest
      - ManifestValidity
      - ManifestSchemaViolation
      - ManifestVersion
      - ManifestDuplicateId
      - JSONTrailingCommas
      - MissingTimeZoneOffset
      - RSMFMissingBody
      - ZipAttachmentMissing
      - ZipAvatarMissing
      - ManifestParticipantArrayEmpty
      - ManifestConversationArrayEmpty
      - ManifestEventArrayEmpty
      - ManifestOrphanedDirectConversation
      - ManifestParticipantCount
      - ManifestConversationCount
      - ManifestEventCount
      - ManifestUndefinedProperty
      - RSMFHeaderVersionMismatch
      - RSMFHeaderDateFormat
      - RSMFHeaderDateMismatch
      - RSMFHeaderEventCountFormat
      - RSMFHeaderEventCountMismatch
      - ZipUnreferencedFiles
      - ManifestParentIdInvalid
      - ManifestOrphanedEvent
      - ManifestUndefinedParticipantId
      - ManifestInvalidConversationParticipant
      - ManifestInvalidConversationCustodian
      - ManifestJoinLeaveInDirectConversation
      - ManifestInvalidEventEditTimestamp
      - ManifestInvalidEventEditParticipant
      - ManifestInvalidEventParticipant
      - ManifestInvalidEventReactionParticipants
      - ManifestInvalidEventReceiptParticipant
      - ManifestEmptyEventReceipt
      - RSMFHeaderAttachmentCountFormat
      - RSMFHeaderParticipantsMismatch
      - RSMFInvalidHeaderValue
      - RSMFInvalidToAddress
      - ManifestEventMissingTimeZone
      - ManifestEventEditMissingTimeZone
      - ManifestEventReadReceiptMissingTimeZone
      - ManifestUnknownObjectMissingTimeZone
      type: string
    Reviewservice.Api.V2.Models.GetParticipantInfoRequest:
      type: object
      properties:
        participantRequests:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Relativity.DocumentViewer.Services.V2.ParticipantRequestInfo'
      additionalProperties: false
    Reviewservice.Api.V2.Models.GetAttachmentInfoRequest:
      type: object
      properties:
        attachmentIDs:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: http
      description: 'Standard Authorization header using the Bearer scheme. Example: "bearer {token}"'
      scheme: bearer
      bearerFormat: JWT