Decisiv Extended Attributes API

openapi: 3.2.0
info:
  title: Decisiv Extended Attributes API
  version: 0.48.24
  contact:
    name: Decisiv Support
    email: support@decisiv.com
    url: https://www.decisiv.com
  license:
    name: Proprietary
    identifier: proprietary
    url: https://www.decisiv.com/terms-of-use/
  termsOfService: https://www.decisiv.com/terms-of-use
  description: 'Operations tagged Extended Attributes across 2 of this provider''s published API definitions: decisiv-asset-management-openapi.yml, decisiv-service-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://srm-api.staging.decisivapps.com
- url: https://srm-api.decisivapps.com
security:
- OAuth2AuthorizationCode: []
  AccessToken: []
- OAuth2Password: []
  AccessToken: []
tags:
- name: Extended Attributes
paths:
  /asset_management/{srm_account_id}/v1/extended_attributes:
    get:
      operationId: listExtendedAttributes
      description: Lists all extended attributes from the requested account.
      summary: List all Extended Attributes from the requested account
      tags:
      - Extended Attributes
      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: number
        description: Sets the desired `page` when encountering larger result sets
      - name: page[size]
        in: query
        required: false
        schema:
          type: number
        description: Sets the desired maximum number of results per page
      responses:
        '200':
          description: Returns list of extended attributes
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9
                  type: extended_attributes
                  attributes:
                    name: String Options
                    schema:
                      type: string
                      enum:
                      - option1
                      - option2
              schema:
                $ref: '#/components/schemas/extended_attributes'
        '400':
          description: Account filter is missing
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Required filter is missing
                  detail: 'Required filter must be provided. Valid required filters: srm_account_id'
                  code: decisiv:filters:006
                  status: '400'
                  source:
                    parameter: filter[srm_account_id]
              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'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/extended_attributes/{id}:
    get:
      operationId: getExtendedAttribute
      description: Retrieves a specific extended attribute from the requested account by its ID.
      summary: Retrieves an Extended Attribute from the requested account
      tags:
      - Extended Attributes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The resource uuid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns an extended attribute
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9
                  type: extended_attributes
                  attributes:
                    name: String Options
                    schema:
                      type: string
                      enum:
                      - option1
                      - option2
              schema:
                $ref: '#/components/schemas/extended_attribute'
        '400':
          description: Account filter is missing
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Required filter is missing
                  detail: 'Required filter must be provided. Valid required filters: srm_account_id'
                  code: decisiv:filters:006
                  status: '400'
                  source:
                    parameter: filter[srm_account_id]
              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: Account not found
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  title: Record not found
                  source:
                    parameter: srm_account_id
              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'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /service_management/{srm_account_id}/v1/extended_attributes:
    get:
      summary: List all Extended Attributes from the requested account
      tags:
      - Extended Attributes
      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: number
        description: Sets the desired `page` when encountering larger result sets
      - name: page[size]
        in: query
        required: false
        schema:
          type: number
        description: Sets the desired maximum number of results per page
      responses:
        '200':
          description: Returns list of extended attributes
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9
                  type: extended_attributes
                  attributes:
                    name: String Options
                    schema:
                      type: string
                      enum:
                      - option1
                      - option2
              schema:
                $ref: '#/components/schemas/extended_attributes'
        '400':
          description: Account filter is missing
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Required filter is missing
                  detail: 'Required filter must be provided. Valid required filters: srm_account_id'
                  code: decisiv:filters:006
                  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'
        '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'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /service_management/{srm_account_id}/v1/extended_attributes/{id}:
    get:
      summary: Retrieves an Extended Attribute from the requested account
      tags:
      - Extended Attributes
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: The resource uuid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns an extended attribute
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 3e5f4d4d-8a3d-43d7-8b55-73a0b38adbf9
                  type: extended_attributes
                  attributes:
                    name: String Options
                    schema:
                      type: string
                      enum:
                      - option1
                      - option2
              schema:
                $ref: '#/components/schemas/extended_attribute_2'
        '400':
          description: Account filter is missing
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Required filter is missing
                  detail: 'Required filter must be provided. Valid required filters: srm_account_id'
                  code: decisiv:filters:006
                  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: Account not found
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  title: Record not found
                  source:
                    parameter: srm_account_id
              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'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
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
    extended_attribute:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: Description of extended attribute
                  minLength: 1
                  maxLength: 255
                schema:
                  type: object
                  oneOf:
                  - type: object
                    description: String with enum validation
                    required:
                    - type
                    - enum
                    properties:
                      type:
                        type: string
                        example: string
                      enum:
                        type: array
                        items:
                          type: string
                  - type: object
                    description: String with length validation
                    required:
                    - type
                    - minLength
                    - maxLength
                    properties:
                      type:
                        type: string
                        example: string
                      minLength:
                        type: integer
                      maxLength:
                        type: integer
                  - type: object
                    description: String with pattern validation
                    required:
                    - type
                    - pattern
                    properties:
                      type:
                        type: string
                        example: string
                      pattern:
                        type: string
                  - type: object
                    description: Integer with range validation
                    required:
                    - type
                    - minimum
                    - maximum
                    properties:
                      type:
                        type: integer
                        example: 42
                      minimum:
                        type: integer
                      maximum:
                        type: integer
                  - type: object
                    description: Integer with enum validation
                    required:
                    - type
                    - enum
                    properties:
                      type:
                        type: integer
                        example: 42
                      enum:
                        type: array
                        items:
                          type: integer
                  - type: object
                    description: Number with range validation
                    required:
                    - type
                    - minimum
                    - maximum
                    properties:
                      type:
                        type: number
                        example: 3.14
                      minimum:
                        type: number
                      maximum:
                        type: number
                  - type: object
                    description: Boolean
                    required:
                    - type
                    properties:
                      type:
                        type: boolean
                        example: true
                  - type: object
                    description: Datetime
                    required:
                    - type
                    - format
                    properties:
                      type:
                        type: string
                        example: string
                      format:
                        type: string
                        example: date-time
                  - type: object
                    description: Date
                    required:
                    - type
                    - format
                    properties:
                      type:
                        type: string
                        example: string
                      format:
                        type: string
                        example: date
                  - type: object
                    description: Time
                    required:
                    - type
                    - format
                    properties:
                      type:
                        type: string
                        example: string
                      format:
                        type: string
                        example: time
                  - type: object
                    description: Email
                    required:
                    - type
                    - format
                    properties:
                      type:
                        type: string
                        example: string
                      format:
                        type: string
                        example: email
                  - type: object
                    description: URI
                    required:
                    - type
                    - format
                    properties:
                      type:
                        type: string
                        example: string
                      format:
                        type: string
                        example: uri
                  - type: object
                    description: UUID
                    required:
                    - type
                    - format
                    properties:
                      type:
                        type: string
                        example: string
                      format:
                        type: string
                        example: uuid
          required:
          - attributes
          - type
          - id
    extended_attribute_properties-data:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
        attributes:
          type: object
          properties:
            name:
              type: string
              description: Description of extended attribute
              minLength: 1
              maxLength: 255
            schema:
              type: object
              oneOf:
              - type: object
                description: String with enum validation
                required:
                - type
                - enum
                properties:
                  type:
                    type: string
                    example: string
                  enum:
                    type: array
                    items:
                      type: string
              - type: object
                description: String with length validation
                required:
                - type
                - minLength
                - maxLength
                properties:
                  type:
                    type: string
                    example: string
                  minLength:
                    type: integer
                  maxLength:
                    type: integer
              - type: object
                description: String with pattern validation
                required:
                - type
                - pattern
                properties:
                  type:
                    type: string
                    example: string
                  pattern:
                    type: string
              - type: object
                description: Integer with range validation
                required:
                - type
                - minimum
                - maximum
                properties:
                  type:
                    type: integer
                    example: 42
                  minimum:
                    type: integer
                  maximum:
                    type: integer
              - type: object
                description: Integer with enum validation
                required:
                - type
                - enum
                properties:
                  type:
                    type: integer
                    example: 42
                  enum:
                    type: array
                    items:
                      type: integer
              - type: object
                description: Number with range validation
                required:
                - type
                - minimum
                - maximum
                properties:
                  type:
                    type: number
                    example: 3.14
                  minimum:
                    type: number
                  maximum:
                    type: number
              - type: object
                description: Boolean
                required:
                - type
                properties:
                  type:
                    type: boolean
                    example: true
              - type: object
                description: Datetime
                required:
                - type
                - format
                properties:
                  type:
                    type: string
                    example: string
                  format:
                    type: string
                    example: date-time
              - type: object
                description: Date
                required:
                - type
                - format
                properties:
                  type:
                    type: string
                    example: string
                  format:
                    type: string
                    example: date
              - type: object
                description: Time
                required:
                - type
                - format
                properties:
                  type:
                    type: string
                    example: string
                  format:
                    type: string
                    example: time
              - type: object
                description: Email
                required:
                - type
                - format
                properties:
                  type:
                    type: string
                    example: string
                  format:
                    type: string
                    example: email
              - type: object
                description: URI
                required:
                - type
                - format
                properties:
                  type:
                    type: string
                    example: string
                  format:
                    type: string
                    example: uri
              - type: object
                description: UUID
                required:
                - type
                - format
                properties:
                  type:
                    type: string
                    example: string
                  format:
                    type: string
                    example: uuid
      required:
      - attributes
      - type
      - id
    extended_attributes:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/extended_attribute_properties-data'
        meta:
          type: object
    errors_response:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error_response'
      required:
      - errors
    extended_attribute_2:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              enum:
              - extended_attributes
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: Description of extended attribute
                  minLength: 1
                  maxLength: 255
                schema:
                  type: object
                  oneOf:
                  - type: object
                    description: String with enum validation
                    required:
                    - type
                    - enum
                    properties:
                      type:
                        type: string
                        example: string
                      enum:
                        type: array
                        items:
                          type: string
                  - type: object
                    description: String with length validation
                    required:
                    - type
                    - minLength
                    - maxLength
                    properties:
                      type:
                        type: string
                        example: string
                      minLengt

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