Relativity Legal Hold Module API

openapi: 3.2.0
info:
  title: kCura.LegalHold.Services.V0 Legal Hold Module API
  description: kCura.LegalHold.Services
  version: V0
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Legal Hold Module
paths:
  /CustodianPortalAuthUrl/GetPortalRedirectUrl:
    get:
      tags:
      - Legal Hold Module
      description: '[Private] ICustodianPortalAuthUrlManager -'
      operationId: kCura.LegalHold.Services.ICustodianPortalAuthUrlManager.GetPortalRedirectUrl
      parameters:
      - $ref: '#/components/parameters/workspaceId'
      - $ref: '#/components/parameters/emailAddress'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: string
      summary: K cura legal hold services ICustodian portal auth url manager get portal…
      x-summary-source: derived
  /custodian-request-manager/ActiveCustodianSummary:
    get:
      tags:
      - Legal Hold Module
      description: '[Public] ICustodianRequestManager -'
      operationId: kCura.LegalHold.Services.ICustodianRequestManager.ActiveCustodianSummary
      parameters:
      - $ref: '#/components/parameters/workspaceId'
      - $ref: '#/components/parameters/startingIndex'
      - $ref: '#/components/parameters/length'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActiveCustodianSummary'
      summary: K cura legal hold services ICustodian request manager active custodian summary
      x-summary-source: derived
  /workspace/{workspaceId}/GetRedirectUriAsync:
    get:
      tags:
      - Legal Hold Module
      description: '[Private] IGoogleAuthorizationManager -'
      operationId: kCura.LegalHold.Services.IGoogleAuthorizationManager.GetRedirectUriAsync
      parameters:
      - $ref: '#/components/parameters/workspaceId_Path'
      - $ref: '#/components/parameters/authenticationType'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UrlRedirectModel'
      summary: K cura legal hold services IGoogle authorization manager get redirect uri async
      x-summary-source: derived
  /workspace/{workspaceId}/GoogleMail/HandleAuthenticationRedirect:
    get:
      tags:
      - Legal Hold Module
      description: '[Private] IGoogleAuthorizationManager -'
      operationId: kCura.LegalHold.Services.IGoogleAuthorizationManager.ProcessGSuiteAuthRedirectAsync
      parameters:
      - $ref: '#/components/parameters/workspaceId_Path'
      - $ref: '#/components/parameters/state'
      - $ref: '#/components/parameters/code'
      - $ref: '#/components/parameters/scope'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericMessageResponseModel'
      summary: K cura legal hold services IGoogle authorization manager process GSuite auth…
      x-summary-source: derived
  /graph-auth-response:
    get:
      tags:
      - Legal Hold Module
      description: '[Private] IGraphAuthorizationManager -'
      operationId: kCura.LegalHold.Services.IGraphAuthorizationManager.AuthorizeMicrosoftGraph
      parameters:
      - $ref: '#/components/parameters/code'
      - $ref: '#/components/parameters/state'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: string
      summary: K cura legal hold services IGraph authorization manager authorize microsoft…
      x-summary-source: derived
  /authorized-user/{workspaceId}:
    get:
      tags:
      - Legal Hold Module
      description: '[Private] IGraphAuthorizationManager -'
      operationId: kCura.LegalHold.Services.IGraphAuthorizationManager.GetAuthorizedUser
      parameters:
      - $ref: '#/components/parameters/workspaceId_Path'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: string
      summary: K cura legal hold services IGraph authorization manager get authorized user
      x-summary-source: derived
  /preservation/{projectArtifactId}/getCustodians:
    get:
      tags:
      - Legal Hold Module
      description: '[Private] IPreservationManager -'
      operationId: kCura.LegalHold.Services.IPreservationManager.GetCustodiansAsync
      parameters:
      - $ref: '#/components/parameters/projectArtifactId'
      - $ref: '#/components/parameters/workspaceId'
      - $ref: '#/components/parameters/startingIndex'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactIDCollection'
      summary: K cura legal hold services IPreservation manager get custodians async
      x-summary-source: derived
  /preservation/IsInstalled/{workspaceId}:
    get:
      tags:
      - Legal Hold Module
      description: '[Private] IPreservationManager -'
      operationId: kCura.LegalHold.Services.IPreservationManager.InstalledAsync
      parameters:
      - $ref: '#/components/parameters/workspaceId_Path'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegalHoldApplicationInstallResponse'
      summary: K cura legal hold services IPreservation manager installed async
      x-summary-source: derived
  /health-check:
    get:
      tags:
      - Legal Hold Module
      description: '[Internal] IPostDeployHealthCheckManager -'
      operationId: kCura.LegalHold.Services.IPostDeployHealthCheckManager.HealthCheckAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpResponseMessage'
      summary: K cura legal hold services IPost deploy health check manager health check async
      x-summary-source: derived
  /toggles/{toggleName}/is-enabled:
    get:
      tags:
      - Legal Hold Module
      description: '[Internal] IToggleManager -'
      operationId: kCura.LegalHold.Services.IToggleManager.IsEnabled
      parameters:
      - $ref: '#/components/parameters/toggleName'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: boolean
      summary: K cura legal hold services IToggle manager is enabled
      x-summary-source: derived
  /SettingsManagement/workspace/{workspaceId}/ValidateEmailSettings:
    get:
      tags:
      - Legal Hold Module
      description: '[Internal] ISettingsProcessor -'
      operationId: kCura.LegalHold.Services.ISettingsProcessor.ValidateEmailSettings
      parameters:
      - $ref: '#/components/parameters/workspaceId_Path'
      - $ref: '#/components/parameters/settingsType'
      - $ref: '#/components/parameters/sendTestEmail'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationSettings'
      summary: K cura legal hold services ISettings processor validate email settings
      x-summary-source: derived
  /workload-discovery/{guid}/workload:
    get:
      tags:
      - Legal Hold Module
      description: '[Internal] IWorkloadDiscoveryManager -'
      operationId: kCura.LegalHold.Services.IWorkloadDiscoveryManager.GetAgentWorkloadAsync
      parameters:
      - $ref: '#/components/parameters/guid'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workload'
      summary: K cura legal hold services IWorkload discovery manager get agent workload async
      x-summary-source: derived
  /workspace/{workspaceArtifactId}/communication/{communicationArtifactId}/layout-state:
    get:
      tags:
      - Legal Hold Module
      description: '[Private] ICommunicationManager -'
      operationId: kCura.LegalHold.Services.ICommunicationManager.GetCommunicationLayoutState
      parameters:
      - $ref: '#/components/parameters/workspaceArtifactId'
      - $ref: '#/components/parameters/communicationArtifactId'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationLayoutStateModel'
      summary: K cura legal hold services ICommunication manager get communication layout state
      x-summary-source: derived
  /workspace/{workspaceArtifactId}/communication/{communicationArtifactId}/acknowledge-on-behalf:
    post:
      tags:
      - Legal Hold Module
      description: '[Private] ICommunicationManager -'
      operationId: kCura.LegalHold.Services.ICommunicationManager.AcknowledgeOnBehalf
      parameters:
      - $ref: '#/components/parameters/workspaceArtifactId'
      - $ref: '#/components/parameters/communicationArtifactId'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcknowledgeOnBehalfModel'
        required: true
      responses:
        '200':
          description: Successful Operation
      summary: K cura legal hold services ICommunication manager acknowledge on behalf
      x-summary-source: derived
components:
  schemas:
    CommunicationLayoutStateModel:
      title: CommunicationLayoutStateModel
      type: object
    Int16:
      title: Int16
      type: object
    DisplayableObjectIdentifier:
      title: DisplayableObjectIdentifier
      type: object
      properties:
        Name:
          type: string
        ArtifactID:
          type: integer
        Guids:
          type: array
          items:
            type: string
    ValidationSettings:
      title: ValidationSettings
      type: object
      properties:
        Message:
          type: string
        Status:
          enum:
          - Success
          - Failure
          - NotApplicable
          type: string
    Uri:
      title: Uri
      type: object
      properties:
        AbsolutePath:
          type: string
        AbsoluteUri:
          type: string
        LocalPath:
          type: string
        Authority:
          type: string
        HostNameType:
          enum:
          - Unknown
          - Basic
          - Dns
          - IPv4
          - IPv6
          type: string
        IsDefaultPort:
          type: boolean
        IsFile:
          type: boolean
        IsLoopback:
          type: boolean
        PathAndQuery:
          type: string
        Segments:
          type: array
          items:
            type: string
        IsUnc:
          type: boolean
        Host:
          type: string
        Port:
          type: integer
        Query:
          type: string
        Fragment:
          type: string
        Scheme:
          type: string
        OriginalString:
          type: string
        DnsSafeHost:
          type: string
        IdnHost:
          type: string
        IsAbsoluteUri:
          type: boolean
        UserEscaped:
          type: boolean
        UserInfo:
          type: string
    ArtifactIDCollection:
      title: ArtifactIDCollection
      type: object
      properties:
        Error:
          type: string
        TotalCount:
          type: integer
        ArtifactIDs:
          type: array
          items:
            type: integer
    HttpMethod:
      title: HttpMethod
      type: object
      properties:
        Get:
          $ref: '#/components/schemas/HttpMethod'
        Put:
          $ref: '#/components/schemas/HttpMethod'
        Post:
          $ref: '#/components/schemas/HttpMethod'
        Delete:
          $ref: '#/components/schemas/HttpMethod'
        Head:
          $ref: '#/components/schemas/HttpMethod'
        Options:
          $ref: '#/components/schemas/HttpMethod'
        Trace:
          $ref: '#/components/schemas/HttpMethod'
        Method:
          type: string
    HttpContent:
      title: HttpContent
      type: object
      properties:
        Headers:
          type: array
          items:
            type: string
            format: HttpContentHeaders
    LegalHoldApplicationInstallResponse:
      title: LegalHoldApplicationInstallResponse
      type: object
      properties:
        Error:
          type: string
        Results:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationInstallSearchItem'
        Summary:
          $ref: '#/components/schemas/InstallStatusSummary'
        CurrentStartIndex:
          type: integer
        ResultCount:
          type: integer
        TotalCount:
          type: integer
        FirstPage:
          $ref: '#/components/schemas/Action'
        PreviousPage:
          $ref: '#/components/schemas/Action'
        NextPage:
          $ref: '#/components/schemas/Action'
        LastPage:
          $ref: '#/components/schemas/Action'
    Action:
      title: Action
      type: object
      properties:
        Name:
          type: string
        Href:
          type: string
        Verb:
          type: string
        IsAvailable:
          type: boolean
        Reason:
          type: array
          items:
            type: string
    HttpResponseMessage:
      title: HttpResponseMessage
      type: object
      properties:
        Version:
          $ref: '#/components/schemas/Version'
        Content:
          $ref: '#/components/schemas/HttpContent'
        StatusCode:
          enum:
          - Continue
          - SwitchingProtocols
          - OK
          - Created
          - Accepted
          - NonAuthoritativeInformation
          - NoContent
          - ResetContent
          - PartialContent
          - MultipleChoices
          - Ambiguous
          - MovedPermanently
          - Moved
          - Found
          - Redirect
          - SeeOther
          - RedirectMethod
          - NotModified
          - UseProxy
          - Unused
          - TemporaryRedirect
          - RedirectKeepVerb
          - BadRequest
          - Unauthorized
          - PaymentRequired
          - Forbidden
          - NotFound
          - MethodNotAllowed
          - NotAcceptable
          - ProxyAuthenticationRequired
          - RequestTimeout
          - Conflict
          - Gone
          - LengthRequired
          - PreconditionFailed
          - RequestEntityTooLarge
          - RequestUriTooLong
          - UnsupportedMediaType
          - RequestedRangeNotSatisfiable
          - ExpectationFailed
          - UpgradeRequired
          - InternalServerError
          - NotImplemented
          - BadGateway
          - ServiceUnavailable
          - GatewayTimeout
          - HttpVersionNotSupported
          type: string
        ReasonPhrase:
          type: string
        Headers:
          type: array
          items:
            type: string
            format: HttpResponseHeaders
        RequestMessage:
          $ref: '#/components/schemas/HttpRequestMessage'
        IsSuccessStatusCode:
          type: boolean
    Version:
      title: Version
      type: object
      properties:
        Major:
          type: integer
        Minor:
          type: integer
        Build:
          type: integer
        Revision:
          type: integer
        MajorRevision:
          $ref: '#/components/schemas/Int16'
        MinorRevision:
          $ref: '#/components/schemas/Int16'
    AcknowledgeOnBehalfModel:
      title: AcknowledgeOnBehalfModel
      type: object
      properties:
        ArtifactIds:
          type: array
          items:
            type: integer
        Reason:
          type: string
    ActiveCustodianSummary:
      title: ActiveCustodianSummary
      type: object
      properties:
        ProjectID:
          type: integer
        FullName:
          type: string
        FirstName:
          type: string
        LastName:
          type: string
        EmailAddress:
          type: string
        EmployeeNumber:
          type: string
        UniqueID:
          type: string
        ErrorMessage:
          type: string
        CustodianRole:
          type: string
    Workload:
      title: Workload
      type: object
      properties:
        Size:
          enum:
          - None
          - One
          - S
          - M
          - L
          - XL
          - XXL
          type: string
    InstallStatus:
      title: InstallStatus
      type: object
      properties:
        Code:
          enum:
          - Unknown
          - Pending
          - InProgress
          - Failed
          - Completed
          - Canceled
          type: string
        Message:
          type: string
        Details:
          type: string
        GetDetailsAction:
          $ref: '#/components/schemas/Action'
        RetryInstallAction:
          $ref: '#/components/schemas/Action'
        CancelInstallAction:
          $ref: '#/components/schemas/Action'
    InstallStatusSummary:
      title: InstallStatusSummary
      type: object
      properties:
        Other:
          type: integer
        Pending:
          type: integer
        InProgress:
          type: integer
        Failed:
          type: integer
        Completed:
          type: integer
        Canceled:
          type: integer
        TotalActiveInstalls:
          type: integer
        Total:
          type: integer
    GenericMessageResponseModel:
      title: GenericMessageResponseModel
      type: object
      properties:
        Message:
          type: string
        Success:
          type: boolean
    UrlRedirectModel:
      title: UrlRedirectModel
      type: object
      properties:
        Url:
          type: string
    HttpRequestMessage:
      title: HttpRequestMessage
      type: object
      properties:
        Version:
          $ref: '#/components/schemas/Version'
        Content:
          $ref: '#/components/schemas/HttpContent'
        Method:
          $ref: '#/components/schemas/HttpMethod'
        RequestUri:
          $ref: '#/components/schemas/Uri'
        Headers:
          type: array
          items:
            type: string
            format: HttpRequestHeaders
        Properties:
          type: object
          additionalProperties:
            title: Object
            type: object
    ApplicationInstallSearchItem:
      title: ApplicationInstallSearchItem
      type: object
      properties:
        ApplicationInstallID:
          type: integer
        ApplicationIdentifier:
          $ref: '#/components/schemas/DisplayableObjectIdentifier'
        WorkspaceIdentifier:
          $ref: '#/components/schemas/DisplayableObjectIdentifier'
        ClientIdentifier:
          $ref: '#/components/schemas/DisplayableObjectIdentifier'
        MatterIdentifier:
          $ref: '#/components/schemas/DisplayableObjectIdentifier'
        Message:
          type: string
        RootFolderID:
          type: integer
        InstallStatus:
          $ref: '#/components/schemas/InstallStatus'
        Version:
          type: string
        IsOutOfDate:
          type: boolean
        InstalledBy:
          $ref: '#/components/schemas/DisplayableObjectIdentifier'
        StartedOn:
          type:
          - string
          - 'null'
          format: date-time
        CompletedOn:
          type:
          - string
          - 'null'
          format: date-time
  parameters:
    emailAddress:
      name: emailAddress
      in: query
      description: ''
      required: true
      schema:
        type: string
    pageSize:
      name: pageSize
      in: query
      description: ''
      schema:
        type: integer
        default: 100
    scope:
      name: scope
      in: query
      description: ''
      required: true
      schema:
        type: string
    startingIndex:
      name: startingIndex
      in: query
      description: ''
      required: true
      schema:
        type: integer
    x-csrf-header:
      name: x-csrf-header
      in: header
      description: ''
      required: true
      schema:
        type: string
        default: '-'
    guid:
      name: guid
      in: path
      description: ''
      required: true
      schema:
        type: string
    communicationArtifactId:
      name: communicationArtifactId
      in: path
      description: ''
      required: true
      schema:
        type: integer
    code:
      name: code
      in: query
      description: ''
      required: true
      schema:
        type: string
    length:
      name: length
      in: query
      description: ''
      required: true
      schema:
        type: integer
    state:
      name: state
      in: query
      description: ''
      required: true
      schema:
        type: string
    projectArtifactId:
      name: projectArtifactId
      in: path
      description: ''
      required: true
      schema:
        type: integer
    workspaceId_Path:
      name: workspaceId
      in: path
      description: ''
      required: true
      schema:
        type: integer
    sendTestEmail:
      name: sendTestEmail
      in: query
      description: ''
      required: true
      schema:
        type: boolean
    settingsType:
      name: settingsType
      in: query
      description: ''
      required: true
      schema:
        type: string
    workspaceArtifactId:
      name: workspaceArtifactId
      in: path
      description: ''
      required: true
      schema:
        type: integer
    authenticationType:
      name: authenticationType
      in: query
      description: ''
      required: true
      schema:
        type: string
    toggleName:
      name: toggleName
      in: path
      description: ''
      required: true
      schema:
        type: string
    workspaceId:
      name: workspaceId
      in: query
      description: ''
      required: true
      schema:
        type: integer
x-provenance:
  method: harvested
  publisher: Relativity
  source: https://platform.relativity.com/RelativityOne/Content/OASFiles/kCura.LegalHold.Services.V0.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)