Decisiv Case Notes API

openapi: 3.2.0
info:
  title: Decisiv Case Notes API
  version: 0.48.24
  contact:
    name: Decisiv Support
    email: support@decisiv.com
    url: https://www.decisiv.com
  license:
    name: Proprietary
    identifier: proprietary
    url: https://www.decisiv.com/terms-of-use/
  termsOfService: https://www.decisiv.com/terms-of-use
  description: 'Operations tagged Case Notes across 2 of this provider''s published API definitions: decisiv-asset-management-openapi.yml, decisiv-service-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://srm-api.staging.decisivapps.com
- url: https://srm-api.decisivapps.com
security:
- OAuth2AuthorizationCode: []
  AccessToken: []
- OAuth2Password: []
  AccessToken: []
tags:
- name: Case Notes
paths:
  /asset_management/{srm_account_id}/v1/cases/{case_id}/notes:
    get:
      operationId: listCaseNotes
      description: Retrieves a paginated list of notes for the specified case.
      summary: List all notes for the requested case
      tags:
      - Case Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: case_id
        in: path
        description: The case uuid
        required: true
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: number
        description: Sets the desired `page` when encountering larger result sets
      - name: page[size]
        in: query
        required: false
        schema:
          type: number
        description: Sets the desired maximum number of results per page
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - sender
            - subject
            - recipients
            - participants
        description: The relationships to be included.
      responses:
        '200':
          description: Returns list of notes for the case
          content:
            application/vnd.api+json:
              examples:
                success:
                  value:
                    data:
                    - id: 17cd5b9d-1f7b-480f-aebb-c72e5df56a0c
                      type: notes
                      attributes:
                        message: This is my note
                        public: false
                      relationships:
                        subject:
                          data:
                            type: cases
                            id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44
                        sender:
                          data:
                            type: users
                            id: 2e7cace7-d1a5-4b89-b34c-8fb751296746
                        recipients:
                          data:
                          - type: recipients
                            id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2
                        participants:
                          data:
                          - type: participants
                            id: ed1641a8-fa41-478a-bd2e-dd72013096b0
              schema:
                $ref: '#/components/schemas/notes'
        '400':
          description: This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted.
          content:
            application/vnd.api+json:
              examples:
                invalid_filter:
                  value:
                    errors:
                    - title: Filter not allowed
                      detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}'
                      code: decisiv:filters:001
                      status: '400'
                      source:
                        parameter: filter[filter_name]
              schema:
                $ref: '#/components/schemas/errors_response'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              examples:
                unauthorized:
                  value:
                    errors:
                    - title: Access unauthorized
                      detail: Access unauthorized
                      code: decisiv::access_token:001
                      status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              examples:
                forbidden:
                  value:
                    errors:
                    - title: Forbidden
                      detail: User does not have permission to perform this action on the requested resource(s)
                      code: decisiv:access:001
                      status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              examples:
                not_found:
                  value:
                    errors:
                    - status: '404'
                      code: decisiv:resource:001
                      title: Resource Identifier - Not Found
                      detail: The parent resource could not be found
                      source:
                        parameter: id
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              examples:
                failed_dependency:
                  value:
                    errors:
                    - title: Failed Dependency
                      detail: Failed Dependency
                      code: '424'
                      status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              examples:
                gateway_timeout:
                  value:
                    errors:
                    - code: '504'
                      detail: Gateway timeout error
                      status: '504'
                      title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    post:
      operationId: createCaseNote
      description: Creates a new note for the specified case.
      summary: Creates a note for the requested case
      tags:
      - Case Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: case_id
        in: path
        description: The case ID
        required: true
        schema:
          type: string
      - name: X-DECISIV-SILENCE-EVENTS
        in: header
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - decisiv:asset_management:case:note_posted
        description: Corresponding webhook events which can be muted for the given transaction
      responses:
        '201':
          description: Created an note for the case
          content:
            application/vnd.api+json:
              examples:
                success:
                  value:
                    data:
                      id: 17cd5b9d-1f7b-480f-aebb-c72e5df56a0c
                      type: notes
                      attributes:
                        message: This is my note
                        public: false
                        created_at: '2025-04-07T18:58:31Z'
                      relationships:
                        subject:
                          data:
                            type: cases
                            id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44
                        sender:
                          data:
                            type: users
                            id: 2e7cace7-d1a5-4b89-b34c-8fb751296746
                        recipients:
                          data:
                          - type: recipients
                            id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2
                        participants:
                          data:
                          - type: participants
                            id: ed1641a8-fa41-478a-bd2e-dd72013096b0
              schema:
                $ref: '#/components/schemas/note'
        '400':
          description: This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted.
          content:
            application/vnd.api+json:
              examples:
                invalid_filter:
                  value:
                    errors:
                    - title: Filter not allowed
                      detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}'
                      code: decisiv:filters:001
                      status: '400'
                      source:
                        parameter: filter[filter_name]
                invalid_silence_events:
                  value:
                    errors:
                    - title: Bad Request
                      detail: Invalid value for X-DECISIV-SILENCE-EVENTS header
                      code: decisiv:silence_webhook_events:001
                      status: '400'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              examples:
                not_found:
                  value:
                    errors:
                    - status: '404'
                      code: decisiv:resource:001
                      title: Resource Identifier - Not Found
                      detail: The parent resource could not be found
                      source:
                        parameter: id
              schema:
                $ref: '#/components/schemas/errors_response'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/create_note'
            examples:
              Note with recipient:
                value:
                  data:
                    type: notes
                    attributes:
                      message: This is my note
                      public: false
                    relationships:
                      recipients:
                      - data:
                          type: recipients
                          id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2
                      - data:
                          type: recipients
                          id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/cases/{case_id}/notes/{id}:
    get:
      operationId: getCaseNote
      description: Retrieves the details of a specific note by its ID.
      summary: Shows the requested note
      tags:
      - Case Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: case_id
        in: path
        description: The case uuid
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The resource uuid
        required: true
        schema:
          type: string
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - sender
            - subject
            - recipients
            - participants
        description: The relationships to be included.
      responses:
        '200':
          description: Returns the note
          content:
            application/vnd.api+json:
              examples:
                success:
                  value:
                    data:
                      id: 17cd5b9d-1f7b-480f-aebb-c72e5df56a0c
                      type: notes
                      attributes:
                        message: This is my note
                        public: false
                        created_at: '2023-10-01T12:00:00Z'
                      relationships:
                        subject:
                          data:
                            type: cases
                            id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44
                        sender:
                          data:
                            type: users
                            id: 2e7cace7-d1a5-4b89-b34c-8fb751296746
                        recipients:
                          data:
                          - type: recipients
                            id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2
                        participants:
                          data:
                          - type: participants
                            id: ed1641a8-fa41-478a-bd2e-dd72013096b0
              schema:
                $ref: '#/components/schemas/note'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              examples:
                unauthorized:
                  value:
                    errors:
                    - title: Access unauthorized
                      detail: Access unauthorized
                      code: decisiv::access_token:001
                      status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              examples:
                forbidden:
                  value:
                    errors:
                    - title: Forbidden
                      detail: User does not have permission to perform this action on the requested resource(s)
                      code: decisiv:access:001
                      status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              examples:
                not_found:
                  value:
                    errors:
                    - status: '404'
                      code: decisiv:resource:001
                      title: Resource Identifier - Not Found
                      detail: The parent resource could not be found
                      source:
                        parameter: id
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              examples:
                failed_dependency:
                  value:
                    errors:
                    - title: Failed Dependency
                      detail: Failed Dependency
                      code: '424'
                      status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              examples:
                gateway_timeout:
                  value:
                    errors:
                    - code: '504'
                      detail: Gateway timeout error
                      status: '504'
                      title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/cases/{case_id}/send_note_to_provider:
    post:
      operationId: sendNoteToProvider
      description: Creates a note that will be sent to the provider for the specified case. This endpoint is deprecated.
      deprecated: true
      summary: Creates a note that will be sent to the provider for the requested case
      tags:
      - Case Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: case_id
        in: path
        description: The case ID
        required: true
        schema:
          type: string
      - name: X-DECISIV-SILENCE-EVENTS
        in: header
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - decisiv:asset_management:case:note_posted
        description: Corresponding webhook events which can be muted for the given transaction
      responses:
        '201':
          description: Created an note for the case
          content:
            application/vnd.api+json:
              examples:
                success:
                  value:
                    data:
                      id: 17cd5b9d-1f7b-480f-aebb-c72e5df56a0c
                      type: notes
                      attributes:
                        message: This is my note
                        public: false
                        created_at: '2023-10-01T12:00:00Z'
                      relationships:
                        subject:
                          data:
                            type: cases
                            id: e3dd4797-3215-4522-a2a8-7f3ccdb1fd44
                        sender:
                          data:
                            type: users
                            id: 2e7cace7-d1a5-4b89-b34c-8fb751296746
                        recipients:
                          data:
                          - type: recipients
                            id: 23592ac3-cec6-4f5b-849e-3cd046d14eb2
                        participants:
                          data:
                          - type: participants
                            id: ed1641a8-fa41-478a-bd2e-dd72013096b0
              schema:
                $ref: '#/components/schemas/note'
        '400':
          description: This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                Filter not allowed:
                  value:
                    errors:
                    - title: Filter not allowed
                      detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}'
                      code: decisiv:filters:001
                      status: '400'
                      source:
                        parameter: filter[filter_name]
                Invalid silence events header:
                  value:
                    errors:
                    - title: Bad Request
                      detail: Invalid value for X-DECISIV-SILENCE-EVENTS header
                      code: decisiv:silence_webhook_events:001
                      status: '400'
                Missing required attribute key:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:001
                      title: Missing required attribute key
                      detail: Required key not provided in request body
                      source:
                        pointer: /data/attributes/message
                Missing required attribute value:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:002
                      title: Missing required attribute value
                      detail: Required key must be populated
                      source:
                        pointer: /data/attributes/public
                Invalid attribute type:
                  value:
                    errors:
                    - status: '400'
                      code: decisiv:request_attributes:004
                      title: Invalid Attribute Type
                      detail: Invalid type provided for the attribute
                      source:
                        pointer: /data/attributes/public
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  code: decisiv:resource:001
                  title: Resource Identifier - Not Found
                  detail: The parent resource could not be found
                  source:
                    parameter: id
              schema:
                $ref: '#/components/schemas/errors_response'
        '422':
          description: This response may occur when the request is well-formed but cannot be processed because recipients were provided in a provider note.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                Attribute Not Allowed:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:request_attributes:009
                      title: Attribute Not Allowed
                      detail: recipients is not allowed
                      source:
                        pointer: /data/relationships/recipients
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/create_note_to_provider'
            examples:
              Case:
                value:
                  data:
                    type: notes
                    attributes:
                      message: This is my note
                      public: false
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /service_management/{srm_account_id}/v1/cases/{case_id}/notes:
    get:
      summary: List notes for the requested case
      tags:
      - Case Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: case_id
        in: path
        schema:
          type: string
          format: uuid
        description: The case UUID
        required: true
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - sender
            - subject
            - recipients
            - participants
        description: The relationships to be included.
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page
      responses:
        '200':
          description: Returns list of notes for the case
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 68d955e7-5679-418b-9d5d-6b35fc2b2c28
                  type: notes
                  attributes:
                    message: This is my note
                    public: false
                    created_at: '2025-04-10T13:30:41Z'
                  relationships:
                    subject:
                      data:
                        type: cases
                        id: 487136d2-c4d6-424c-b018-f1ed8a740c6a
                    sender:
                      data:
                        type: users
                        id: 6383dc89-05b6-4572-8979-a6257f3597ec
                    recipients:
                      data:
                      - type: recipients
                        id: 42c3f138-843a-4b7d-8d83-71b018da98fa
                      - type: contacts
                        id: bd763ee6-b2f2-49fc-a375-7fb5346ee19d
                    participants:
                      data:
                      - type: participants
                        id: cb967209-0c68-42cc-ad8d-8413554b507f
              schema:
                $ref: '#/components/schemas/notes_2'
        '400':
          description: This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Filter not allowed
                  detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}'
                  code: decisiv:filters:001
                  status: '400'
                  source:
                    parameter: filter[filter_name]
              schema:
                $ref: '#/components/schemas/errors_response'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Record not found
                  detail: The requested record or one of its relationships could not be found
                  code: '404'
                  status: '404'
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Failed Dependency
                  detail: Failed Dependency
                  code: '424'
                  status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    post:
      summary: Create a note for the requested case
      tags:
      - Case Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: case_id
        in: path
        description: The case ID
        required: true
        schema:
          type: string
      - name: X-DECISIV-SILENCE-EVENTS
        in: header
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - decisiv:service_management:case:note_posted
        description: Corresponding webhook events which can be muted for the given transaction
      responses:
        '201':
          description: Created an note for the case
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 68d955e7-5679-418b-9d5d-6b35fc2b2c28
                  type: notes
                  attributes:
                    message: This is my note
                    public: false
                    created_at: '2025-04-10T13:30:41Z'
                  relationships:
                    subject:
                      data:
                        type: cases
                        id: 487136d2-c4d6-424c-b018-f1ed8a740c6a
                    sender:
                      data:
                        type: users
                        id: 6383dc89-05b6-4572-8979-a6257f3597ec
                    recipients:
                      data:
                      - type: recipients
                        id: bd763ee6-b2f2-49fc-a375-7fb5346ee19d
                    participants:
                      data:
                      - type: participants
                        id: bd763ee6-b2f2-49fc-a375-7fb5346ee19d
              schema:
                $ref: '#/components/schemas/note_2'
        '400':
          description: Path ID mismatch
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '400'
                  code: decisiv:resource:002
                  title: Invalid JSON:API Resource specified in request
                  detail: '''79327cde-d5ce-4ce6-bdba-eebab125ae2d'' is an invalid resource'
                  source:
                    pointer: /data/id
              schema:
                $ref: '#/components/schemas/errors_response'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/decisiv/refs/heads/main/openapi/decisiv-case-notes-api-openapi.yml