Decisiv Sublet Requests 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 Requests 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 Requests
paths:
  /service_management/{srm_account_id}/v1/sublet_requests:
    get:
      summary: Retrieves a list of sublet requests
      tags:
      - Sublet Requests
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - service_provider
            - parent_case
            - sublet_case
        description: The relationships to be included.
      - name: filter[status]
        in: query
        required: false
        schema:
          type: string
        description: Filters the sublet_requests for the given status, using exact matching search
      - name: filter[service_provider.id]
        in: query
        required: false
        schema:
          type: string
        description: Filters the sublet_requests for the given service_provider.id, using exact matching search
      - name: filter[parent_case.id]
        in: query
        required: false
        schema:
          type: string
        description: Filters the sublet_requests for the given parent_case.id, using exact matching search
      - name: filter[event_timestamps.requested_at:gt]
        in: query
        required: false
        schema:
          type: string
        description: Filters the sublet_requests for the given event_timestamps.requested_at:gt, using exact matching search
      - name: filter[event_timestamps.requested_at:lt]
        in: query
        required: false
        schema:
          type: string
        description: Filters the sublet_requests for the given event_timestamps.requested_at:lt, using exact matching search
      - name: filter[event_timestamps.requested_at:gte]
        in: query
        required: false
        schema:
          type: string
        description: Filters the sublet_requests for the given event_timestamps.requested_at:gte, using exact matching search
      - name: filter[event_timestamps.requested_at:lte]
        in: query
        required: false
        schema:
          type: string
        description: Filters the sublet_requests for the given event_timestamps.requested_at:lte, using exact matching search
      - 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: The request has succeeded. It may or may not return a single resource of collection of resources.
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 55dc388f-89ed-411d-9a79-825162e59137
                  type: sublet_requests
                  attributes:
                    complaint: Check Engine Light continually on
                    status: pending
                    po_number: THX1138
                    auth_number: FLT2112
                    note: Sample note
                    reference_number: 18328893
                    primary_contact: {}
                    driver: {}
                    breakdown:
                      location: John Smith, 5480 7th Ave
                      city: San Francisco
                      state: CA
                    event_timestamps:
                      requested_at: '2025-04-10T13:28:31Z'
                      requested_appointment_time: '2025-04-10T13:28:31Z'
                      requested_completion_time: '2025-04-10T13:28:31Z'
                      asset_downtime: '2025-04-09T13:28:31Z'
                    created_at: '2025-04-10T13:28:31Z'
                    updated_at: '2025-04-10T13:28:31Z'
                  links:
                    self: https://srm-api.decisivapps.com/api/service_management/{srm_account_id}/v1/sublet_requests/55dc388f-89ed-411d-9a79-825162e59137
                  relationships:
                    parent_case:
                      data:
                        type: cases
                        id: 487136d2-c4d6-424c-b018-f1ed8a740c6a
                    service_provider:
                      data:
                        type: service_providers
                        id: 65b8d7f1-77aa-4b62-9a62-7207da98bb94
                    sublet_case:
                      data:
                        type: sublet_cases
                        id: dc8b7b66-288c-4072-9e31-3df871d5e561
              schema:
                $ref: '#/components/schemas/sublet_requests'
        '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: Create a new sublet request
      tags:
      - Sublet Requests
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - service_provider
            - parent_case
            - sublet_case
        description: The relationships to be included.
      - name: X-DECISIV-SILENCE-EVENTS
        in: header
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - sublet_request:submitted
            - decisiv:service_management:sublet_request:submitted
        description: Corresponding webhook events which can be muted for the given transaction
      responses:
        '201':
          description: The request has been fulfilled and a new resource is available.
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 55dc388f-89ed-411d-9a79-825162e59137
                  type: sublet_requests
                  attributes:
                    complaint: Check Engine Light continually on
                    status: pending
                    po_number: THX1138
                    auth_number: FLT2112
                    note: Sample note
                    reference_number: 18328893
                    primary_contact: {}
                    driver: {}
                    breakdown:
                      location: John Smith, 5480 7th Ave
                      city: San Francisco
                      state: CA
                    event_timestamps:
                      requested_at: '2025-04-10T13:28:31Z'
                      requested_appointment_time: '2025-04-10T13:28:31Z'
                      requested_completion_time: '2025-04-10T13:28:31Z'
                      asset_downtime: '2025-04-09T13:28:31Z'
                    created_at: '2025-04-10T13:28:31Z'
                    updated_at: '2025-04-10T13:28:31Z'
                  links:
                    self: https://srm-api.decisivapps.com/api/service_management/{srm_account_id}/v1/sublet_requests/55dc388f-89ed-411d-9a79-825162e59137
                  relationships:
                    parent_case:
                      data:
                        type: cases
                        id: 487136d2-c4d6-424c-b018-f1ed8a740c6a
                    service_provider:
                      data:
                        type: service_providers
                        id: 65b8d7f1-77aa-4b62-9a62-7207da98bb94
                    sublet_case:
                      data:
                        type: sublet_cases
                        id: dc8b7b66-288c-4072-9e31-3df871d5e561
              schema:
                $ref: '#/components/schemas/sublet_request'
        '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]
                - 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'
        '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'
        '422':
          description: Invalid relationship uuid format error / Parent case not found error
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                Invalid relationship uuid format error:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:relationships:001
                      title: Invalid ID format requested
                      detail: Provided ID in relationships must be a valid UUID format
                      source:
                        pointer: /data/relationships/parent_case|service_provider/data/id
                Parent case not found error:
                  value:
                    errors:
                    - status: '422'
                      code: decisiv:sublet_request:001
                      detail: Parent Case not found for the requested Account
                      source:
                        pointer: /data/relationships/parent_case/data/id
        '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'
        '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'
        '429':
          description: This response will often be associated as a result of an over abundance of calls by a specific Application, Account, or IP Address resulting in a required cool off period.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '429'
                  detail: The maximum number of requests for this application has been far exceeded with the given credentials.
                  status: '429'
                  title: Too Many Requests
              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_sublet_request'
            examples:
              Sublet:
                value:
                  data:
                    type: sublet_requests
                    attributes:
                      complaint: Check Engine Light continually on
                      po_number: THX1138
                      auth_number: FLT2112
                      note: Sample note
                      primary_contact: {}
                      driver: {}
                      breakdown:
                        location: John Smith, 5480 7th Ave
                        city: San Francisco
                        state: CA
                      event_timestamps:
                        requested_at: '2025-04-10T13:28:31Z'
                        requested_appointment_time: '2025-04-10T13:28:31Z'
                        requested_completion_time: '2025-04-10T13:28:31Z'
                        asset_downtime: '2025-04-09T13:28:31Z'
                    relationships:
                      parent_case:
                        data:
                          type: cases
                          id: 487136d2-c4d6-424c-b018-f1ed8a740c6a
                      service_provider:
                        data:
                          type: service_providers
                          id: 65b8d7f1-77aa-4b62-9a62-7207da98bb94
  /service_management/{srm_account_id}/v1/sublet_requests/{id}:
    get:
      summary: Retrieves a sublet request
      tags:
      - Sublet Requests
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource UUID
        required: true
      responses:
        '200':
          description: The request has succeeded. It may or may not return a single resource of collection of resources.
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 55dc388f-89ed-411d-9a79-825162e59137
                  type: sublet_requests
                  attributes:
                    complaint: Check Engine Light continually on
                    status: pending
                    po_number: THX1138
                    auth_number: FLT2112
                    note: Sample note
                    reference_number: 18328893
                    primary_contact: {}
                    driver: {}
                    breakdown:
                      location: John Smith, 5480 7th Ave
                      city: San Francisco
                      state: CA
                    event_timestamps:
                      requested_at: '2025-04-10T13:28:31Z'
                      requested_appointment_time: '2025-04-10T13:28:31Z'
                      requested_completion_time: '2025-04-10T13:28:31Z'
                      asset_downtime: '2025-04-09T13:28:31Z'
                    created_at: '2025-04-10T13:28:31Z'
                    updated_at: '2025-04-10T13:28:31Z'
                  links:
                    self: https://srm-api.decisivapps.com/api/service_management/{srm_account_id}/v1/sublet_requests/55dc388f-89ed-411d-9a79-825162e59137
                  relationships:
                    parent_case:
                      data:
                        type: cases
                        id: 487136d2-c4d6-424c-b018-f1ed8a740c6a
                    service_provider:
                      data:
                        type: service_providers
                        id: 65b8d7f1-77aa-4b62-9a62-7207da98bb94
                    sublet_case:
                      data:
                        type: sublet_cases
                        id: dc8b7b66-288c-4072-9e31-3df871d5e561
              schema:
                $ref: '#/components/schemas/sublet_request'
        '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: Invalid UUID Format
                  detail: The `ID` value does not contain a valid UUID format
                  code: '107'
                  status: '400'
              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'
        '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'
    put:
      summary: Updates a sublet request
      tags:
      - Sublet Requests
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource UUID
        required: true
      responses:
        '200':
          description: The request has succeeded. It may or may not return a single resource of collection of resources.
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 55dc388f-89ed-411d-9a79-825162e59137
                  type: sublet_requests
                  attributes:
                    complaint: Check Engine Light continually on
                    status: pending
                    po_number: THX1138
                    auth_number: FLT2112
                    note: Sample note
                    reference_number: 18328893
                    primary_contact: {}
                    driver: {}
                    breakdown:
                      location: John Smith, 5480 7th Ave
                      city: San Francisco
                      state: CA
                    event_timestamps:
                      requested_at: '2025-04-10T13:28:31Z'
                      requested_appointment_time: '2025-04-10T13:28:31Z'
                      requested_completion_time: '2025-04-10T13:28:31Z'
                      asset_downtime: '2025-04-09T13:28:31Z'
                    created_at: '2025-04-10T13:28:31Z'
                    updated_at: '2025-04-10T13:28:31Z'
                  links:
                    self: https://srm-api.decisivapps.com/api/service_management/{srm_account_id}/v1/sublet_requests/55dc388f-89ed-411d-9a79-825162e59137
                  relationships:
                    parent_case:
                      data:
                        type: cases
                        id: 487136d2-c4d6-424c-b018-f1ed8a740c6a
                    service_provider:
                      data:
                        type: service_providers
                        id: 65b8d7f1-77aa-4b62-9a62-7207da98bb94
                    sublet_case:
                      data:
                        type: sublet_cases
                        id: dc8b7b66-288c-4072-9e31-3df871d5e561
              schema:
                $ref: '#/components/schemas/sublet_request'
        '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'
        '422':
          description: invalid previous status
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: decisiv:sublet_requests:004
                  status: '422'
                  title: Unprocessable record
                  detail: Only Sublet Requests with a status of 'Pending' may be canceled by the requesting account
              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'
        '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'
        '429':
          description: This response will often be associated as a result of an over abundance of calls by a specific Application, Account, or IP Address resulting in a required cool off period.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '429'
                  detail: The maximum number of requests for this application has been far exceeded with the given credentials.
                  status: '429'
                  title: Too Many Requests
              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/update_sublet_request'
  /service_management/{srm_account_id}/v1/sublet_requests/{id}/cancel:
    post:
      summary: Cancel sublet request
      tags:
      - Sublet Requests
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource UUID
        required: true
      responses:
        '200':
          description: The request has succeeded. It may or may not return a single resource of collection of resources.
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 55dc388f-89ed-411d-9a79-825162e59137
                  type: sublet_requests
                  attributes:
                    complaint: Check Engine Light continually on
                    po_number: THX1138
                    auth_number: FLT2112
                    note: Sample note
                    reference_number: 18328893
                    primary_contact: {}
                    driver: {}
                    breakdown:
                      location: John Smith, 5480 7th Ave
                      city: San Francisco
                      state: CA
                    event_timestamps:
                      requested_at: '2025-04-10T13:28:31Z'
                      requested_appointment_time: '2025-04-10T13:28:31Z'
                      requested_completion_time: '2025-04-10T13:28:31Z'
                      asset_downtime: '2025-04-09T13:28:31Z'
                    status: Canceled
                  relationships:
                    parent_case:
                      data:
                        type: cases
                        id: 487136d2-c4d6-424c-b018-f1ed8a740c6a
                    service_provider:
                      data:
                        type: service_providers
                        id

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