Decisiv Sublet Cases Notes API

openapi: 3.2.0
info:
  version: 0.48.24
  termsOfService: https://www.decisiv.com/terms-of-use
  contact:
    name: Decisiv Support
    email: support@decisiv.com
    url: https://www.decisiv.com
  title: Service Management Sublet Cases Notes API
  description: The **Decisiv SRM Gateway** `Service Management` module provides the API functionality for managing an asset's case lifecycle from a Service Providers perspective.
  license:
    name: Proprietary
    identifier: proprietary
    url: https://www.decisiv.com/terms-of-use/
servers:
- url: https://srm-api.staging.decisivapps.com
- url: https://srm-api.decisivapps.com
security:
- OAuth2AuthorizationCode: []
  AccessToken: []
- OAuth2Password: []
  AccessToken: []
tags:
- name: Sublet Cases Notes
paths:
  /service_management/{srm_account_id}/v1/sublet_cases/{sublet_case_uuid}/notes:
    get:
      summary: Retrieves a list of sublet cases notes
      tags:
      - Sublet Cases Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: sublet_case_uuid
        in: path
        schema:
          type: string
          format: uuid
        description: The sublet 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 sublet 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: sublet_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'
        '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'
        '428':
          description: This response represents requests to a module or endpoint which can not immediately be accessed due to the Account permissions and subscriptions in the Decisiv Platform.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Precondition Required
                  detail: Precondition Required
                  code: '428'
                  status: '428'
              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: Creates a note for the requested sublet case
      tags:
      - Sublet Cases Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: sublet_case_uuid
        in: path
        schema:
          type: string
          format: uuid
        description: The sublet case UUID
        required: true
      - name: X-DECISIV-SILENCE-EVENTS
        in: header
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - decisiv:service_management:sublet_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: sublet_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'
        '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: Sublet case 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'
        '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'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/create_case_note'
            examples:
              Note with recipient:
                value:
                  data:
                    type: notes
                    attributes:
                      message: This is my note
                      public: false
                    relationships:
                      recipients:
                        data:
                        - type: recipients
                          id: 42c3f138-843a-4b7d-8d83-71b018da98fa
                        - type: contacts
                          id: bd763ee6-b2f2-49fc-a375-7fb5346ee19d
              Note with participant:
                value:
                  data:
                    type: notes
                    attributes:
                      message: This is my note
                      public: false
                    relationships:
                      recipients:
                        data:
                        - type: participants
                          id: bd763ee6-b2f2-49fc-a375-7fb5346ee19d
  /service_management/{srm_account_id}/v1/sublet_cases/{sublet_case_uuid}/notes/{id}:
    get:
      summary: List details on a specific note for the requested sublet case
      tags:
      - Sublet Cases Notes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: sublet_case_uuid
        in: path
        schema:
          type: string
          format: uuid
        description: The sublet case UUID
        required: true
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource 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.
      responses:
        '200':
          description: Show details for requested Note
          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: sublet_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/note'
        '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'
components:
  schemas:
    create_case_note:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          - relationships
          properties:
            type:
              type: string
              enum:
              - notes
            attributes:
              type: object
              required:
              - message
              - public
              properties:
                message:
                  type: string
                  example: This is a note
                public:
                  type: boolean
                  description: Notes with Public selected can be viewed from the Fleet case perspective.
                  example: true
            relationships:
              type: object
              required:
              - recipients
              properties:
                recipients:
                  type: object
                  description: Despite the key name, this accepts a single `participants` entry as an alternative to one or more `recipients`, `contacts`, or `registered_contacts` entries; the two groups can't be mixed.
                  required:
                  - data
                  properties:
                    data:
                      oneOf:
                      - title: Recipients or contacts
                        type: array
                        minItems: 1
                        items:
                          type: object
                          required:
                          - type
                          - id
                          properties:
                            type:
                              type: string
                              enum:
                              - recipients
                              - contacts
                              - registered_contacts
                              example: recipients
                            id:
                              type: string
                              format: uuid
                              description: UUID of the recipient
                              example: 1ed4f5ce-e426-11eb-a848-4fd53322f5bb
                      - title: Single participant
                        type: array
                        minItems: 1
                        maxItems: 1
                        items:
                          type: object
                          required:
                          - type
                          - id
                          properties:
                            type:
                              type: string
                              enum:
                              - participants
                              example: participants
                            id:
                              type: string
                              format: uuid
                              description: UUID of the participant
                              example: 1ed4f5ce-e426-11eb-a848-4fd53322f5bb
    error_response:
      type: object
      properties:
        status:
          type: string
        title:
          type: string
        detail:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
        source:
          type: object
          properties:
            parameter:
              type:
              - string
              - 'null'
            pointer:
              type:
              - string
              - 'null'
        links:
          type: object
          description: Links related to this error (e.g. documentation reference).
          additionalProperties:
            type: string
            format: uri
      required:
      - status
      - title
    notes:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/note_properties-data'
        meta:
          type: object
          properties:
            record-count:
              type: integer
              description: Total count across all pages
    note:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              enum:
              - notes
            attributes:
              type: object
              properties:
                message:
                  type: string
                  examples:
                  - This is a note
                public:
                  type: boolean
                  description: Notes with Public selected can be viewed from the Fleet case perspective.
                  examples:
                  - true
                created_at:
                  type: string
                  format: date-time
                  description: '`ISO 8601` timestamp'
              required:
              - message
              - public
            relationships:
              type: object
              properties:
                recipients:
                  $ref: '#/components/schemas/relationship_objects'
                subject:
                  $ref: '#/components/schemas/relationship_object'
                sender:
                  $ref: '#/components/schemas/relationship_object'
                participants:
                  $ref: '#/components/schemas/relationship_objects'
              required:
              - recipients
          required:
          - attributes
          - relationships
          - type
          - id
    note_properties-data:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - notes
        attributes:
          type: object
          properties:
            message:
              type: string
              examples:
              - This is a note
            public:
              type: boolean
              description: Notes with Public selected can be viewed from the Fleet case perspective.
              examples:
              - true
            created_at:
              type: string
              format: date-time
              description: '`ISO 8601` timestamp'
          required:
          - message
          - public
        relationships:
          type: object
          properties:
            recipients:
              $ref: '#/components/schemas/relationship_objects'
            subject:
              $ref: '#/components/schemas/relationship_object'
            sender:
              $ref: '#/components/schemas/relationship_object'
            participants:
              $ref: '#/components/schemas/relationship_objects'
          required:
          - recipients
      required:
      - attributes
      - relationships
      - type
      - id
    relationship_objects:
      type: object
      properties:
        data:
          type: array
          items:
            type:
            - object
            - 'null'
            properties:
              id:
                type: string
              type:
                type: string
            required:
            - id
            - type
      required:
      - data
    relationship_object:
      type: object
      properties:
        data:
          type:
          - object
          - 'null'
          properties:
            id:
              type: string
            type:
              type: string
          required:
          - id
          - type
      required:
      - data
    errors_response:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error_response'
      required:
      - errors
  securitySchemes:
    AccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OAuth2AuthorizationCode:
      type: oauth2
      description: OAuth 2.0 Authorization Code flow. This is the required flow for new integrations. See https://api-docs.decisiv.net/docs/api/oauth/
      flows:
        authorizationCode:
          authorizationUrl: https://login.decisiv.net/auth/api_gateway
          tokenUrl: https://login.decisiv.net/oauth/token
          refreshUrl: https://login.decisiv.net/oauth/token
          scopes: {}
    OAuth2Password:
      type: oauth2
      description: '**Deprecated.** OAuth 2.0 Password flow. New integrations must use the Authorization Code flow (`OAuth2AuthorizationCode`); this flow remains available only during the migration window and will be removed in a future release. See https://api-docs.decisiv.net/docs/api/oauth/'
      flows:
        password:
          tokenUrl: https://login.decisiv.net/oauth/token
          scopes: {}