Decisiv Case Line Item Parts 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 Case Line Item Parts 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: Case Line Item Parts
paths:
  /service_management/{srm_account_id}/v1/cases/{case_id}/line_items/{line_item_id}/parts:
    get:
      summary: List all parts for the requested line item
      tags:
      - Case Line Item Parts
      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: line_item_id
        in: path
        schema:
          type: string
          format: uuid
        description: The line item UUID
        required: true
      - 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
      - name: include
        in: query
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - salesman
        description: The relationships to be included.
      responses:
        '200':
          description: Returns list of line items for the case
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 167f089e-339d-4d05-b175-9b10206c3cbf
                  type: line_item_parts
                  attributes:
                    name: Part123
                    quantity: '2.00'
                    quantity_shipped: '2'
                    quantity_backordered: '0'
                    number: '2132'
                    unit_price: '1.2000'
                    core:
                      price: '1.2000'
                      quantity: 2
                  relationships:
                    salesperson:
                      data:
                        type: internal_users
                        id: 6383dc89-05b6-4572-8979-a6257f3597ec
              schema:
                $ref: '#/components/schemas/parts'
        '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'
        '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 estimate item part
      tags:
      - Case Line Item Parts
      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: line_item_id
        in: path
        schema:
          type: string
          format: uuid
        description: The line item UUID
        required: true
      responses:
        '201':
          description: Successful creation of line item
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 167f089e-339d-4d05-b175-9b10206c3cbf
                  type: line_item_parts
                  attributes:
                    name: Part123
                    quantity: '2.00'
                    quantity_shipped: '2'
                    quantity_backordered: '0'
                    number: '2132'
                    unit_price: '1.2000'
                    core:
                      price: '1.2000'
                      quantity: 2
                  relationships:
                    salesperson:
                      data:
                        type: internal_users
                        id: 6383dc89-05b6-4572-8979-a6257f3597ec
              schema:
                $ref: '#/components/schemas/part'
        '400':
          description: Missing required key / Missing required value / Invalid Attribute Type / Attribute Not Allowed / Invalid Attribute Pattern
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                Missing required 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/name
                Missing required 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/name
                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/name
                Attribute Not Allowed:
                  value:
                    errors:
                    - status: 400
                      code: decisiv:request_attributes:009
                      title: Attribute Not Allowed
                      detail: '{{attribute}} is not allowed'
                      source:
                        pointer: /data/attributes/name
                Invalid Attribute Pattern:
                  value:
                    errors:
                    - status: 400
                      code: decisiv:request_attributes:011
                      title: Invalid Attribute Pattern
                      detail: Attribute value must match pattern '{{pattern}}'
                      source:
                        pointer: /data/attributes/unit_price
        '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:
                - 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'
        '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_estimate_item_part'
            examples:
              Create Line Item Part:
                value:
                  data:
                    type: line_item_parts
                    attributes:
                      name: Valve
                      quantity: '4'
                      quantity_shipped: '2'
                      quantity_backordered: '0'
                      number: '1'
                      unit_price: '12.50'
                      core:
                        price: '12.50'
                        quantity: '1.0'
                    relationships:
                      salesperson:
                        data:
                          type: internal_users
                          id: 6383dc89-05b6-4572-8979-a6257f3597ec
  /service_management/{srm_account_id}/v1/cases/{case_id}/line_items/{line_item_id}/parts/{id}:
    get:
      summary: List details on a specific part for the requested line item
      tags:
      - Case Line Item Parts
      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: line_item_id
        in: path
        schema:
          type: string
          format: uuid
        description: The line item 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:
            - salesman
        description: The relationships to be included.
      responses:
        '200':
          description: Show details for requested Line Item
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 167f089e-339d-4d05-b175-9b10206c3cbf
                  type: line_item_parts
                  attributes:
                    name: Part123
                    quantity: '2.00'
                    quantity_shipped: '2'
                    quantity_backordered: '0'
                    number: '2132'
                    unit_price: '1.2000'
                    core:
                      price: '1.2000'
                      quantity: 2
                  relationships:
                    salesperson:
                      data:
                        type: internal_users
                        id: 6383dc89-05b6-4572-8979-a6257f3597ec
              schema:
                $ref: '#/components/schemas/part'
        '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'
    patch:
      summary: Update a specific part
      tags:
      - Case Line Item Parts
      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: line_item_id
        in: path
        schema:
          type: string
          format: uuid
        description: The line item UUID
        required: true
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource UUID
        required: true
      responses:
        '200':
          description: Successful update of line item part
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 167f089e-339d-4d05-b175-9b10206c3cbf
                  type: line_item_parts
                  attributes:
                    name: Part123
                    quantity: '2.00'
                    quantity_shipped: '2'
                    quantity_backordered: '0'
                    number: '2132'
                    unit_price: '1.2000'
                    core:
                      price: '1.2000'
                      quantity: 2
                  relationships:
                    salesperson:
                      data:
                        type: internal_users
                        id: 6383dc89-05b6-4572-8979-a6257f3597ec
              schema:
                $ref: '#/components/schemas/case'
        '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:
                - 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: Missing required value / Invalid Attribute Type / Attribute Not Allowed / Invalid Attribute Pattern
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                Missing required 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/name
                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/name
                Attribute Not Allowed:
                  value:
                    errors:
                    - status: 400
                      code: decisiv:request_attributes:009
                      title: Attribute Not Allowed
                      detail: '{{attribute}} is not allowed'
                      source:
                        pointer: /data/attributes/name
                Invalid Attribute Pattern:
                  value:
                    errors:
                    - status: 400
                      code: decisiv:request_attributes:011
                      title: Invalid Attribute Pattern
                      detail: Attribute value must match pattern '{{pattern}}'
                      source:
                        pointer: /data/attributes/unit_price
        '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_estimate_item_part'
            examples:
              Update Line Item Part:
                value:
                  data:
                    type: line_item_parts
                    id: 167f089e-339d-4d05-b175-9b10206c3cbf
                    attributes:
                      name: Valve
                      quantity: '4'
                      quantity_shipped: '2'
                      quantity_backordered: '0'
                      number: '1'
                      unit_price: '12.50'
                      core:
                        price: '12.50'
                        quantity: '1.0'
                    relationships:
                      salesperson:
                        data:
                          type: internal_users
                          id: 6383dc89-05b6-4572-8979-a6257f3597ec
    delete:
      summary: Delete an estimate item part
      tags:
      - Case Line Item Parts
      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: line_item_id
        in: path
        schema:
          type: string
          format: uuid
        description: The line item UUID
        required: true
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource UUID
        required: true
      responses:
        '204':
          description: Deletes an estimate item part
          content: {}
        '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'
        '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'
components:
  schemas:
    create_estimate_item_part:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            type:
              type: string
            attributes:
              type: object
              required:
              - name
              - unit_price
              properties:
                name:
                  type: string
                  description: Part name of materials associated with the item
                  maxLength: 510
                quantity:
                  type: string
                  description: Count of specific parts associated with the item
                  maxLength: 11
                  pattern: ^[0-9]{1,9}\.[0-9]{2}$
                quantity_shipped:
                  type: string
                  description: Count of parts that have been shipped, as an integer-formatted string. Response bodies emit this field as an integer; the request side accepts the contract's string form.
                  maxLength: 9
                  pattern: ^[0-9]{1,9}$
                quantity_backordered:
                  type: string
                  description: Count of parts that are backordered, as an integer-formatted string. Response bodies emit this field as an integer; the request side accepts the contract's string form.
                  maxLength: 9
                  pattern: ^[0-9]{1,9}$
                number:
                  type: string
                  description: Part number of material associated with the item
                  maxLength: 100
                unit_price:
                  type: string
                  description: Unit cost of each part associated with the item
                  maxLength: 11
                  pattern: ^[0-9]{1,7}\.[0-9]{4}$
                core:
                  type: object
                  description: Information about the core parts
                  properties:
                    quantity:
                      type: string
                      description: Quantity for the core charge as a decimal-formatted string. Response bodies emit this field as an integer; the request side accepts the contract's string form.
                      maxLength: 11
                      pattern: ^-?[0-9]{1,9}(\.[0-9]{1,2})?$
                    price:
                      type: string
                      description: Unit cost of each core part associated with the item
                      maxLength: 11
                      pattern: ^[0-9]{1,7}\.[0-9]{4}$
            relationships:
              type: object
              properties:
                salesperson:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                        id:
                          type: string
                          format: uuid
                      required:
                      - type
                      - id
          required:
          - type
          - attributes
    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
    part_properties-data:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - line_item_parts
        attributes:
          type: object
          properties:
            name:
              type: string
              description: Part name of materials associated with the item
              maxLength: 510
            quantity:
              type: string
              description: Count of specific parts associated with the item
              maxLength: 11
              pattern: ^[0-9]{1,9}\.[0-9]{2}$
            quantity_shipped:
              type:
              - string
              - 'null'
              description: Count of parts that have been shipped for the item, emitted as an integer-formatted string for consistency with quantity
            quantity_backordered:
              type:
              - string
              - 'null'
              description: Count of parts that are backordered for the item, emitted as an integer-formatted string for consistency with quantity
            number:
              type: string
              description: Part number of material associated with the item
              maxLength: 100
            unit_price:
              type: string
              description: Unit cost of each part associated with the item
              maxLength: 11
              pattern: ^[0-9]{1,7}\.[0-9]{4}$
            core:
              type: object
              description: Information about the core parts
              properties:
                quantity:
                  type:
                  - integer
                  - 'null'
                  description: Count of specific core parts associated with the item
                price:
                  type: string
                  description: Unit cost of each core part associated with the item
                  maxLength: 11
                  pattern: ^[0-9]{1,7}\.[0-9]{4}$
        relationships:
          type: object
          properties:
            salesperson:
              $ref: '#/components/schemas/relationship_object'
      required:
      - attributes
      - type
      - id
    case:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              enum:
       

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