swagger: '2.0'
info:
  title: docCentrum Minimal
  version: '1.0'
host: api.doccentrum.com
schemes:
  - https
paths:
  '/api/Approvals/{approvalId}':
    get:
      tags:
        - Approvals
      summary: Retrieves the approval record with the specified identifier.
      description: Get Approval by Id
      operationId: GetApprovalById
      produces:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - application/octet-stream
        - text/json
        - application/json; charset=utf-8
      parameters:
        - in: path
          name: approvalId
          description: The unique identifier of the approval to retrieve. Cannot be null or empty.
          required: true
          type: string
      responses:
        '200':
          description: The approval record was found.
          schema:
            $ref: '#/definitions/DocumentApproval'
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
    delete:
      tags:
        - Approvals
      summary: Cancels the approval request identified by the specified approval ID.
      description: Cancel an Approval
      operationId: CancelApproval
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: path
          name: approvalId
          description: The unique identifier of the approval to cancel. Cannot be null or empty.
          required: true
          type: string
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/Approvals/Create:
    post:
      tags:
        - Approvals
      summary: Creates a new approval record based on the specified document approval details.
      description: Create an Approval
      operationId: CreateApproval
      consumes:
        - application/json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          description: The document approval information to be used for creating the approval. Cannot be null.
          schema:
            $ref: '#/definitions/DocumentApproval'
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/Approvals/Respond:
    post:
      tags:
        - Approvals
      summary: Processes a response to an approval request submitted by a client application.
      description: "This action requires a valid approval request in the request body. The response is\n            accepted only if the model passes validation. The operation is performed asynchronously."
      operationId: RespondToApproval
      consumes:
        - application/json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          description: "The approval response details to process. Must contain a valid approval ID and response value. Cannot be\n            null."
          schema:
            $ref: '#/definitions/DocumentApprovalResponse'
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/Approvals/Reassign:
    post:
      tags:
        - Approvals
      summary: Reassigns an approval to a specified user based on the provided request data.
      description: Reassign an Approval
      operationId: ReassignApproval
      consumes:
        - application/json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          description: "The request containing the approval identifier and the user identifier to whom the approval will be\n            reassigned. Cannot be null."
          schema:
            $ref: '#/definitions/ReassignApprovalRequest'
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/Approvals/Settings:
    get:
      tags:
        - Approvals
      summary: Retrieves the current approval settings for the application.
      description: Get Approval Settings
      operationId: GetApprovalSettings
      produces:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - application/octet-stream
        - text/json
        - application/json; charset=utf-8
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ApprovalSettings'
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
    post:
      tags:
        - Approvals
      summary: Saves the specified approval settings.
      description: Save Approval Settings
      operationId: SaveApprovalSettings
      consumes:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - text/json
        - application/*+json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          description: The approval settings to be saved. Cannot be null.
          schema:
            $ref: '#/definitions/ApprovalSettings'
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/Approvals/ChangeOwner:
    post:
      tags:
        - Approvals
      summary: Changes the owner of an approval to a specified user.
      description: Change Approval Owner
      operationId: ChangeApprovalOwner
      consumes:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - text/json
        - application/*+json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          description: The request containing the approval identifier and the user ID of the new owner. Cannot be null.
          schema:
            $ref: '#/definitions/ChangeApprovalOwnerRequest'
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /odata/approvals:
    get:
      tags:
        - ApprovalsOData
      summary: Gets all approvals in the system.
      description: Admin-only
      operationId: GetAllApprovals
      produces:
        - application/json
        - application/json; charset=utf-8
      parameters:
        - in: query
          name: top
          description: The max number of records.
          type: string
        - in: query
          name: skip
          description: The number of records to skip.
          type: string
        - in: query
          name: filter
          description: A function that must evaluate to true for a record to be returned.
          type: string
        - in: query
          name: select
          description: Specifies a subset of properties to return. Use a comma separated list.
          type: string
        - in: query
          name: orderby
          description: Determines what values are used to order a collection of records.
          type: string
        - in: query
          name: expand
          description: Use to add related query data.
          type: string
        - in: query
          name: count
          description: Return the total number of items in the set.
          type: boolean
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/DocumentApprovalODataResponse'
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /odata/approvals/assignedtome:
    get:
      tags:
        - ApprovalsOData
      summary: Gets approvals assigned to the current user.
      description: Gets approvals assigned to the current user
      operationId: GetMyAssignedApprovals
      produces:
        - application/json
        - application/json; charset=utf-8
      parameters:
        - in: query
          name: top
          description: The max number of records.
          type: string
        - in: query
          name: skip
          description: The number of records to skip.
          type: string
        - in: query
          name: filter
          description: A function that must evaluate to true for a record to be returned.
          type: string
        - in: query
          name: select
          description: Specifies a subset of properties to return. Use a comma separated list.
          type: string
        - in: query
          name: orderby
          description: Determines what values are used to order a collection of records.
          type: string
        - in: query
          name: expand
          description: Use to add related query data.
          type: string
        - in: query
          name: count
          description: Return the total number of items in the set.
          type: boolean
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/DocumentApprovalODataResponse'
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /odata/approvals/ownedbyme:
    get:
      tags:
        - ApprovalsOData
      summary: Gets approvals owned by the current user.
      description: Gets approvals owned by the current user
      operationId: GetMyOwnedApprovals
      produces:
        - application/json
        - application/json; charset=utf-8
      parameters:
        - in: query
          name: top
          description: The max number of records.
          type: string
        - in: query
          name: skip
          description: The number of records to skip.
          type: string
        - in: query
          name: filter
          description: A function that must evaluate to true for a record to be returned.
          type: string
        - in: query
          name: select
          description: Specifies a subset of properties to return. Use a comma separated list.
          type: string
        - in: query
          name: orderby
          description: Determines what values are used to order a collection of records.
          type: string
        - in: query
          name: expand
          description: Use to add related query data.
          type: string
        - in: query
          name: count
          description: Return the total number of items in the set.
          type: boolean
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/DocumentApprovalODataResponse'
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  '/odata/approvals/{approvalId}/Responses':
    get:
      tags:
        - ApprovalsOData
      summary: Retrieves the collection of approval responses associated with the specified approval item.
      description: Gets approval responses for an approval item
      operationId: GetApprovalResponses
      produces:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - application/octet-stream
        - text/json
        - application/json; charset=utf-8
      parameters:
        - in: path
          name: approvalId
          description: The unique identifier of the approval item for which to retrieve responses. Cannot be null or empty.
          required: true
          type: string
        - in: query
          name: top
          description: The max number of records.
          type: string
        - in: query
          name: skip
          description: The number of records to skip.
          type: string
        - in: query
          name: filter
          description: A function that must evaluate to true for a record to be returned.
          type: string
        - in: query
          name: select
          description: Specifies a subset of properties to return. Use a comma separated list.
          type: string
        - in: query
          name: orderby
          description: Determines what values are used to order a collection of records.
          type: string
        - in: query
          name: expand
          description: Use to add related query data.
          type: string
        - in: query
          name: count
          description: Return the total number of items in the set.
          type: boolean
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/DocumentApprovalResponse'
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  '/odata/approvals/{approvalId}/Requests':
    get:
      tags:
        - ApprovalsOData
      summary: Retrieves the collection of approval requests associated with the specified approval item.
      description: Gets approval requests for an approval item
      operationId: GetApprovalRequests
      produces:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - application/octet-stream
        - text/json
        - application/json; charset=utf-8
      parameters:
        - in: path
          name: approvalId
          description: The unique identifier of the approval item for which to retrieve approval requests. Cannot be null or empty.
          required: true
          type: string
        - in: query
          name: top
          description: The max number of records.
          type: string
        - in: query
          name: skip
          description: The number of records to skip.
          type: string
        - in: query
          name: filter
          description: A function that must evaluate to true for a record to be returned.
          type: string
        - in: query
          name: select
          description: Specifies a subset of properties to return. Use a comma separated list.
          type: string
        - in: query
          name: orderby
          description: Determines what values are used to order a collection of records.
          type: string
        - in: query
          name: expand
          description: Use to add related query data.
          type: string
        - in: query
          name: count
          description: Return the total number of items in the set.
          type: boolean
      responses:
        '200':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/DocumentApprovalRequest'
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/ReadTasks/CreateSimpleItem:
    post:
      tags:
        - ReadTasks
      summary: Creates a new Simple Document Read Request
      description: ''
      operationId: CreateSimpleItem
      consumes:
        - application/json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          schema:
            $ref: '#/definitions/SimpleItemRequest'
      responses:
        '201':
          description: Returns the newly created item
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/ReadTasks/CreateTasksFromPackage:
    post:
      tags:
        - ReadTasks
      summary: Create Tasks from Package
      description: Create Tasks from a package
      operationId: CreateTasksFromPackage
      consumes:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - text/json
        - application/*+json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          schema:
            $ref: '#/definitions/CreateTasksFromPackageRequest'
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/TaskAdmin/ReassignTask:
    post:
      tags:
        - TaskAdmin
      summary: Reassigns an existing task to a different user based on the specified request data.
      description: "This action requires authorization. The request must specify valid identifiers for\n            the document and both users. If the reassignment fails, the response will include an error message\n            describing the issue."
      operationId: ReassignTask
      consumes:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - text/json
        - application/*+json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          description: "The request containing the identifiers of the task, the current user, and the new user to whom the task will\n            be reassigned. Cannot be null."
          schema:
            $ref: '#/definitions/ReassignTaskRequest'
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /api/TaskAdmin/DeleteDocumentTasks:
    delete:
      tags:
        - TaskAdmin
      summary: Permanently deletes all tasks associated with a specified document.
      description: "If both document ID and document path are provided, tasks matching the document path\n            will be deleted. This operation cannot be undone."
      operationId: DeleteDocumentTasks
      consumes:
        - application/json;odata.metadata=minimal;odata.streaming=true
        - application/json;odata.metadata=minimal;odata.streaming=false
        - application/json;odata.metadata=minimal
        - application/json;odata.metadata=full;odata.streaming=true
        - application/json;odata.metadata=full;odata.streaming=false
        - application/json;odata.metadata=full
        - application/json;odata.metadata=none;odata.streaming=true
        - application/json;odata.metadata=none;odata.streaming=false
        - application/json;odata.metadata=none
        - application/json;odata.streaming=true
        - application/json;odata.streaming=false
        - application/json
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=minimal;IEEE754Compatible=false
        - application/json;odata.metadata=minimal;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=full;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=full;IEEE754Compatible=false
        - application/json;odata.metadata=full;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.metadata=none;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=true
        - application/json;odata.metadata=none;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=false
        - application/json;odata.metadata=none;IEEE754Compatible=true
        - application/json;odata.streaming=true;IEEE754Compatible=false
        - application/json;odata.streaming=true;IEEE754Compatible=true
        - application/json;odata.streaming=false;IEEE754Compatible=false
        - application/json;odata.streaming=false;IEEE754Compatible=true
        - application/json;IEEE754Compatible=false
        - application/json;IEEE754Compatible=true
        - application/xml
        - text/plain
        - text/json
        - application/*+json
      produces:
        - application/json; charset=utf-8
      parameters:
        - in: body
          name: body
          description: "An object containing the criteria for identifying the document whose tasks should be deleted. Either the\n            document ID or document path must be provided."
          schema:
            $ref: '#/definitions/DeleteDocumentTasksRequest'
      responses:
        '200':
          description: OK
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
  /odata/Tasks:
    get:
      tags:
        - Tasks
      summary: Query all tasks
      description: Queries for all tasks
      operationId: odata/Tasks
      produces:
        - application/json
        - application/json; charset=utf-8
      parameters:
        - in: query
          name: top
          description: The max number of records.
          type: string
        - in: query
          name: skip
          description: The number of records to skip.
          type: string
        - in: query
          name: filter
          description: A function that must evaluate to true for a record to be returned.
          type: string
        - in: query
          name: select
          description: Specifies a subset of properties to return. Use a comma separated list.
          type: string
        - in: query
          name: orderby
          description: Determines what values are used to order a collection of records.
          type: string
        - in: query
          name: expand
          description: Use to add related query data.
          type: string
        - in: query
          name: count
          description: Return the total number of items in the set.
          type: boolean
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/DocumentTaskODataResponse'
        '500':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
        '400':
          description: Problem
          schema:
            $ref: '#/definitions/DocCentrumProblem'
definitions:
  ApprovalSettings:
    description: Represents configuration options related to approval workflows or processes.
    type: object
    properties:
      allowCustomResponses:
        description: Gets or sets a value indicating whether custom responses are allowed.
        type: boolean
    additionalProperties: false
  ChangeApprovalOwnerRequest:
    description: Represents a request to change the owner of an approval to a different user.
    required:
      - approvalId
      - newOwnerUserId
    type: object
    properties:
      approvalId:
        description: Gets or sets the unique identifier associated with the approval request.
        type: string
      newOwnerUserId:
        description: Gets or sets the user ID of the new owner to whom ownership will be transferred.
        type: string
    additionalProperties: false
  CreateTasksFromPackageRequest:
    description: An API request to issue tasks from a Task Package
    type: object
    properties:
      packageId:
        description: The ID of the Package
        type: string
      packageName:
        description: The name of the Package. You can use this if you don't have the ID
        type: string
      assignmentId:
        description: A unique ID to group this assignment in a process
        type: string
      users:
        description: The UPNs of the recipients for this task
        type: array
        items:
          type: string
      groups:
        description: The names or IDs of the groups to send this task to
        type: array
        items:
          type: string
      autoAssignNewGroupMembers:
        description: 'If a Groups are specified, and members are added after this task is issued, then the newly added members will also be issued a task'
        type: boolean
      issueOnlyNewTasks:
        description: Only create tasks that user have not been issued yet. Use this when re-issuing a package to users
        type: boolean
      throwExceptions:
        description: 'If true, Execptions are raised if problems exist. If set to false, exceptions are swallowed and the call will succeed.'
        type: boolean
      source:
        description: 'A way to identify the source of the task. It could be the name of an application, a process, or a Flow'
        type: string
      templateGroup:
        description: A template group to override whatever is set in the package
        type: string
    additionalProperties: false
  DeleteDocumentTasksRequest:
    description: An API request to delete a document tasl
    type: object
    properties:
      documentId:
        description: The ID of the document
        type: string
      documentPath:
        description: 'The path to the document. If the ID is absent, you can try this'
        type: string
    additionalProperties: false
  DocCentrumProblem:
    description: A Problem raised by a DocCentrum Exception
    type: object
    properties:
      type:
        type: string
      title:
        type: string
      status:
        format: int32
        type: integer
      detail:
        type: string
      instance:
        type: string
    additionalProperties: { }
  DocumentApproval:
    description: 'Represents an approval workflow for a document, including approvers, prompts, state, and metadata.'
    required:
      - approversList
      - displayName
      - documentCentreId
      - documentReference
    type: object
    properties:
      id:
        description: Gets or sets the unique identifier for the approval.
        type: string
      documentReference:
        description: Gets or sets the reference to the associated document.
        type: string
      documentCentreId:
        description: Gets or sets the unique identifier for the associated document centre.
        type: string
      displayName:
        description: Gets or sets the display name of the approval.
        type: string
      owner:
        description: Gets or sets the owner of the approval.
        type: string
      approversList:
        description: Gets or sets the list of approvers for the approval.
        type: array
        items:
          type: string
      approvers:
        description: Gets or sets the list of approvers associated with the item.
        type: string
      description:
        description: Gets or sets the description of the approval.
        type: string
      allowEmailNotification:
        description: Gets or sets a value indicating whether email notifications are allowed for this approval.
        type: boolean
      approvalType:
        description: Gets or sets the type of approval.
        type: string
      responsePromptsList:
        description: Gets or sets the list of response prompts for the approval.
        type: array
        items:
          type: string
      responsePrompts:
        description: Gets or sets the response prompts used to guide or customize system replies.
        type: string
      viewPoints:
        description: Gets or sets the list of viewpoints associated with the approval.
        type: array
        items:
          type: string
      state:
        description: Gets or sets the current state of the approval.
        type: string
      result:
        description: Gets or sets the result of the approval.
        type: string
      createdDate:
        format: date-time
        description: Gets or sets the date and time when the Approval was created.
        type: string
      completedDate:
        format: date-time
        description: Gets or sets the date and time when the operation was completed.
        type: string
      approvalCompleteCallbackUrl:
        description: Gets or sets the URL to which the user is redirected after completing the approval process.
        type: string
      workflowInstanceId:
        description: The Instance ID of the Azure Durable Function running the approval workflow
        type: string
    additionalProperties: false
  DocumentApprovalODataResponse:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DocumentApproval'
      count:
        format: int32
        type: integer
    additionalProperties: false
  DocumentApprovalRequest:
    description: Represents a request to approve a document within a workflow or approval system.
    type: object
    properties:
      id:
        description: Gets or sets the unique identifier for the request.
        type: string
      approvalId:
        description: Gets or sets the unique identifier associated with the approval.
        type: string
      taskId:
        description: The Id of the docCentrum Compliance Task associated with this approval request.
        type: string
      userId:
        description: Gets or sets the user name associated with the current instance.
        type: string
      state:
        description: Gets or sets the current state as a string value.
        type: string
    additionalProperties: false
  DocumentApprovalResponse:
    description: Represents a response to a document approval request.
    required:
      - approvalId
    type: object
    properties:
      approvalId:
        description: Gets or sets the unique identifier associated with the approval request.
        type: string
      responseId:
        description: Gets or sets the unique identifier associated with the response.
        type: string
      response:
        description: Gets or sets the response message returned by the operation.
        type: string
      comments:
        description: Gets or sets the user-provided comments associated with this instance.
        type: string
      userId:
        description: Gets or sets the unique identifier for the user who responded to the approval request.
        type: string
      responseDate:
        format: date-time
        description: Gets or sets the date and time when the response was generated.
        type: string
    additionalProperties: false
  DocumentTask:
    description: Represents a task to read a document
    type: object
    properties:
      partitionKey:
        type: string
      rowKey:
        type: string
      timestamp:
        format: date-time
        type: string
      eTag:
        type: string
      path:
        description: The path to the item that the read task will open
        type: string
      title:
        description: The title of the task
        type: string
      fileName:
        description: The file name of the task
        type: string
      documentId:
        description: The ID of the document of the task
        type: string
      userName:
        description: The UPN of the recipient of the task
        type: string
      dueDate:
        format: date-time
        description: The due date of the task
        type: string
      hasOpened:
        description: Has the user opened the document associated with the task?
        type: boolean
      hasRead:
        description: Has the user marked this document as read and completed?
        type: boolean
      dateOpened:
        format: date-time
        description: The date the document was opened
        type: string
      firstOpened:
        format: date-time
        description: The date the document was first opened
        type: string
      dateRead:
        format: date-time
        description: The date the document was read and completed
        type: string
      dateCreated:
        format: date-time
        description: The date the task was created
        type: string
      dateDismissed:
        format: date-time
        description: The date the task was dismissed by the user
        type: string
      priority:
        description: 'Task Priority. High, Medium, or Low'
        type: string
      readType:
        description: Task Read type. Mandatory or Recommended
        type: string
      description:
        description: The task description
        type: string
      status:
        description: The task status
        type: string
      quizPassed:
        description: Set to true if the user passed the quiz
        type: boolean
      quizId:
        description: The ID of the quiz associated with the task
        type: string
      assignedBy:
        description: The UPN of the user issuing this task
        type: string
      source:
        description: 'A way to identify the source of the task. It could be the name of an application, a process, or a Flow'
        type: string
      packageRef:
        description: 'A reference to the package that issued this task. Format: dcPackage|#{package.Name}|#{package.Id}'
        type: string
      itemType:
        description: The type of the document associated with the task
        type: string
      assignedUnifiedGroupId:
        description: Not used
        type: string
      iconName:
        description: Not used
        type: string
      taskId:
        description: The ID of this task. Normally it's the MD5 checksum of the ItemPath
        type: string
      notificationSent:
        description: The type of Notification that was last sent for this task
        type: string
      taskAssignmentId:
        description: A unique identifier to associate this task with a group of task assignments
        type: string
      taskGroupName:
        description: A way to group tasks issued by a process
        type: string
      templateGroup:
        description: The name of Template Group for notifications
        type: string
      customAttribute1:
        description: Custom Attribute
        type: string
      customAttribute2:
        description: Custom Attribute
        type: string
      customAttribute3:
        description: Custom Attribute
        type: string
      customAttribute4:
        description: Custom Attribute
        type: string
      customAttribute5:
        description: Custom Attribute
        type: string
      customAttribute6:
        description: Custom Attribute
        type: string
      customAttribute7:
        description: Custom Attribute
        type: string
      customAttribute8:
        description: Custom Attribute
        type: string
      customAttribute9:
        description: Custom Attribute
        type: string
      customAttribute10:
        description: Custom Attribute
        type: string
      confirmProcess:
        description: How the user completes the task in docCentrum. Either "ReadThenComplete" or "ReadAndComplete".
        type: string
      openUrl:
        type: string
      completeUrl:
        type: string
      assignedByUserPhotoUrl:
        type: string
      assignedToUserPhotoUrl:
        type: string
      isArchived:
        type: boolean
    additionalProperties: false
  DocumentTaskODataResponse:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/DocumentTask'
      count:
        format: int32
        type: integer
    additionalProperties: false
  ReassignApprovalRequest:
    description: Represents a request to reassign an approval to a different user.
    required:
      - approvalId
      - userIds
    type: object
    properties:
      approvalId:
        description: Gets or sets the unique identifier associated with the approval request.
        type: string
      userIds:
        description: Gets or sets the list of user identifiers associated with the current context.
        type: array
        items:
          type: string
    additionalProperties: false
  ReassignTaskRequest:
    description: An API request to reassign a task
    type: object
    properties:
      userId:
        description: The User ID of the task
        type: string
      documentId:
        description: The Document Task ID
        type: string
      newUserId:
        description: The user to reassign this task to
        type: string
    additionalProperties: false
  SimpleItemRequest:
    description: 'A simple, flat request to create a new read task'
    type: object
    properties:
      itemPath:
        description: The path to the item that the read task will open
        type: string
      itemTitle:
        description: The title of the task
        type: string
      description:
        description: The description of the task
        type: string
      groupId:
        description: The Object ID of the Entra ID group to issue this task to. Each member will recieve a task.
        type: string
      groupExcludedUsers:
        description: 'If a Group Id is specified, then you can specify a list of members to NOT send a task to'
        type: string
      autoAssignNewGroupMembers:
        description: 'If a Group Id is specified, and members are added after this task is issued, then the newly added members will also be issued a task'
        type: boolean
      upn:
        description: The UPN of the task recipient
        type: string
      priority:
        description: 'Task Priority. High, Medium, or Low'
        type: string
      dueDate:
        format: date-time
        description: The due date of the task
        type: string
      quizId:
        description: The ID of the quiz associated with this task
        type: string
      isMandatory:
        description: Set to true to make this task mandatory
        type: boolean
      itemType:
        description: The Type of the item associated with the task
        type: string
      assignedBy:
        description: The UPN of the user issuing this task
        type: string
      templateGroup:
        description: The name of Template Group for notifications
        type: string
      assignmentId:
        description: A unique identifier to associate this task with a group of task assignments
        type: string
      taskGroupName:
        description: A way to group tasks issued by a process
        type: string
      source:
        description: 'A way to identify the source of the task. It could be the name of an application, a process, or a Flow'
        type: string
      confirmProcess:
        description: How the user completes the task in docCentrum. Either "ReadThenComplete" or "ReadAndComplete".
        type: string
      customAttribute1:
        description: Custom Attribute
        type: string
      customAttribute2:
        description: Custom Attribute
        type: string
      customAttribute3:
        description: Custom Attribute
        type: string
      customAttribute4:
        description: Custom Attribute
        type: string
      customAttribute5:
        description: Custom Attribute
        type: string
      customAttribute6:
        description: Custom Attribute
        type: string
      customAttribute7:
        description: Custom Attribute
        type: string
      customAttribute8:
        description: Custom Attribute
        type: string
      customAttribute9:
        description: Custom Attribute
        type: string
      customAttribute10:
        description: Custom Attribute
        type: string
    additionalProperties: false