Decisiv Program Types 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 Program Types 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: Program Types
paths:
  /service_management/{srm_account_id}/v1/program_types:
    get:
      summary: List all program types for the requested account
      tags:
      - Program Types
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - 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 program types
          content:
            application/vnd.api+json:
              example:
                data:
                - id: b7390546-9a28-4aed-9e30-1a5afc0ab696
                  type: program_types
                  attributes:
                    name: Trucks
                    default: true
              schema:
                $ref: '#/components/schemas/program_types'
        '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'
        '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'
  /service_management/{srm_account_id}/v1/program_types/{id}:
    get:
      summary: List details on a specific Program Type
      tags:
      - Program Types
      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: Show details for requested Program Type
          content:
            application/vnd.api+json:
              example:
                data:
                  id: b7390546-9a28-4aed-9e30-1a5afc0ab696
                  type: program_types
                  attributes:
                    name: Trucks
                    default: true
              schema:
                $ref: '#/components/schemas/program_type_by_id'
        '404':
          description: Account not found / Program Type not found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_response'
              examples:
                Account not found:
                  value:
                    errors:
                    - status: '404'
                      title: Record not found
                      source:
                        parameter: srm_account_id
                Program Type not found:
                  value:
                    errors:
                    - status: '404'
                      code: decisiv:resource:001
                      title: Resource Identifier - Not Found
                      detail: The parent resource could not be found
                      source:
                        parameter: id
components:
  schemas:
    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
    program_types:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/program_type'
        meta:
          type: object
    program_type_by_id:
      example:
        data:
          id: b7390546-9a28-4aed-9e30-1a5afc0ab696
          type: program_types
          attributes:
            name: Trucks
            default: true
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              enum:
              - program_types
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the Program Type
                  minLength: 1
                  maxLength: 255
                default:
                  type: boolean
                  description: When set to `true`, the identified `Program Type` is defaultly set on all cases
          required:
          - attributes
          - type
          - id
      required:
      - data
    program_type:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              enum:
              - program_types
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the Program Type
                  minLength: 1
                  maxLength: 255
                default:
                  type: boolean
                  description: When set to `true`, the identified `Program Type` is defaultly set on all cases
          required:
          - attributes
          - type
          - id
    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: {}