Decisiv Case Line Item Parts Relationships SalesPerson 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 Relationships SalesPerson 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 Relationships SalesPerson
paths:
  ? /service_management/{srm_account_id}/v1/cases/{case_id}/line_items/{line_item_id}/parts/{part_id}/relationships/salesperson
  : patch:
      summary: Add, Update or Remove a Salesperson from part
      tags:
      - Case Line Item Parts Relationships SalesPerson
      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: part_id
        in: path
        schema:
          type: string
          format: uuid
        description: The part UUID
        required: true
      responses:
        '200':
          description: Show details for changed 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'
                    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. / Feature for this action is not available
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                ? This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
                : 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'
                Feature for this action is not available:
                  value:
                    errors:
                    - status: '403'
                      code: decisiv:account:002
                      title: Feature Unavailable
                      detail: Requested feature or action not available for this account
        '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'
        '422':
          description: User does not have the underlying permission
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '422'
                  code: decisiv:permissions:001
                  title: Missing Permission
                  detail: Provided resource does not have the required permission to complete the request.
              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'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/salesperson_change'
              - $ref: '#/components/schemas/salesperson_remove'
            examples:
              Change Salesperson:
                value:
                  data:
                    type: internal_users
                    id: 6383dc89-05b6-4572-8979-a6257f3597ec
              Remove Salesperson:
                value:
                  data: {}
components:
  schemas:
    salesperson_change:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            type:
              type: string
            id:
              type: string
    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:
      type: object
      required:
      - data
      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
    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
    salesperson_remove:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            type:
              type: string
            id:
              type: string
  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: {}