RelativityOne Legal Hold API — Custodians

naftiko: 1.0.0-alpha2
info:
  label: RelativityOne Legal Hold API — Custodians
  description: 'RelativityOne Legal Hold API — Custodians. 3 operations. Lead operation: Get Active Custodian Summary. Self-contained
    Naftiko capability covering one Relativityone business surface.'
  tags:
  - Relativityone
  - Custodians
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RELATIVITYONE_API_KEY: RELATIVITYONE_API_KEY
capability:
  consumes:
  - type: http
    namespace: legal-hold-custodians
    baseUri: https://relativity.rest/api
    description: RelativityOne Legal Hold API — Custodians business capability. Self-contained, no shared references.
    resources:
    - name: relativity-environment-v1-workspaces-workspaceId-legal-hold-active-custodians
      path: /relativity-environment/v1/workspaces/{workspaceId}/legal-hold/active-custodians
      operations:
      - name: getactivecustodiansummary
        method: GET
        description: Get Active Custodian Summary
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: integer
          description: The artifact ID of the workspace.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index for pagination.
        - name: length
          in: query
          type: integer
          description: Number of records to return (max 1000).
    - name: relativity-environment-v1-workspaces-workspaceId-legal-hold-projects-projectId-c
      path: /relativity-environment/v1/workspaces/{workspaceId}/legal-hold/projects/{projectId}/custodians
      operations:
      - name: listprojectcustodians
        method: GET
        description: List Project Custodians
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: integer
          description: The artifact ID of the workspace.
          required: true
        - name: projectId
          in: path
          type: integer
          description: The artifact ID of the legal hold project.
          required: true
      - name: addcustodiantoproject
        method: POST
        description: Add Custodian to Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceId
          in: path
          type: integer
          description: The artifact ID of the workspace.
          required: true
        - name: projectId
          in: path
          type: integer
          description: The artifact ID of the legal hold project.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.RELATIVITYONE_API_KEY}}'
  exposes:
  - type: rest
    namespace: legal-hold-custodians-rest
    port: 8080
    description: REST adapter for RelativityOne Legal Hold API — Custodians. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/relativity-environment/v1/workspaces/{workspaceid}/legal-hold/active-custodians
      name: relativity-environment-v1-workspaces-workspaceid-legal-hold-active-custodians
      description: REST surface for relativity-environment-v1-workspaces-workspaceId-legal-hold-active-custodians.
      operations:
      - method: GET
        name: getactivecustodiansummary
        description: Get Active Custodian Summary
        call: legal-hold-custodians.getactivecustodiansummary
        with:
          workspaceId: rest.workspaceId
          start: rest.start
          length: rest.length
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/relativity-environment/v1/workspaces/{workspaceid}/legal-hold/projects/{projectid}/custodians
      name: relativity-environment-v1-workspaces-workspaceid-legal-hold-projects-projectid-c
      description: REST surface for relativity-environment-v1-workspaces-workspaceId-legal-hold-projects-projectId-c.
      operations:
      - method: GET
        name: listprojectcustodians
        description: List Project Custodians
        call: legal-hold-custodians.listprojectcustodians
        with:
          workspaceId: rest.workspaceId
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addcustodiantoproject
        description: Add Custodian to Project
        call: legal-hold-custodians.addcustodiantoproject
        with:
          workspaceId: rest.workspaceId
          projectId: rest.projectId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: legal-hold-custodians-mcp
    port: 9090
    transport: http
    description: MCP adapter for RelativityOne Legal Hold API — Custodians. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-active-custodian-summary
      description: Get Active Custodian Summary
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: legal-hold-custodians.getactivecustodiansummary
      with:
        workspaceId: tools.workspaceId
        start: tools.start
        length: tools.length
      outputParameters:
      - type: object
        mapping: $.
    - name: list-project-custodians
      description: List Project Custodians
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: legal-hold-custodians.listprojectcustodians
      with:
        workspaceId: tools.workspaceId
        projectId: tools.projectId
      outputParameters:
      - type: object
        mapping: $.
    - name: add-custodian-project
      description: Add Custodian to Project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: legal-hold-custodians.addcustodiantoproject
      with:
        workspaceId: tools.workspaceId
        projectId: tools.projectId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.