openapi: 3.2.0
info:
  title: Folio Custom Properties API
  version: 7.3.0
  contact:
    name: Knowledge Integration
    url: https://www.k-int.com
  description: 'Operations tagged Custom Properties across 2 of this provider''s published API definitions: folio-mod-licenses-openapi.json, folio-mod-licenses-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://folio-snapshot-okapi.dev.folio.org
- url: https://folio-snapshot-2-okapi.dev.folio.org
- url: https://folio-etesting-snapshot-kong.ci.folio.org
security:
- accessToken: []
- okapiToken: []
tags:
- name: Custom Properties
paths:
  /licenses/custprops:
    description: Supports search and creation of custom property definitions
    parameters:
    - $ref: '#/components/parameters/x-okapi-tenant'
    get:
      tags:
      - Custom Properties
      summary: Get a set of custom property definition records
      operationId: getCustomPropertyDefinitions
      parameters:
      - $ref: '#/components/parameters/filters'
      - $ref: '#/components/parameters/match'
      - $ref: '#/components/parameters/term'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/stats'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/CustomPropertyDefinitionResults'
                - $ref: '#/components/schemas/CustomPropertyDefinitionResultsArray'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
    post:
      tags:
      - Custom Properties
      summary: Create custom property definition record
      operationId: postCustomPropertyDefinition
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomPropertyDefinition'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomPropertyDefinition'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /licenses/custprops/{custPropId}:
    get:
      tags:
      - Custom Properties
      summary: Get a specified custom property definition record
      operationId: getCustomPropertyDefinition
      parameters:
      - $ref: '#/components/parameters/custPropId'
      - $ref: '#/components/parameters/x-okapi-tenant'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomPropertyDefinition'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
    put:
      tags:
      - Custom Properties
      summary: Update custom property definition record
      operationId: putCustomPropertyDefinition
      parameters:
      - $ref: '#/components/parameters/custPropId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomPropertyDefinition'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomPropertyDefinition'
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found error
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
    delete:
      tags:
      - Custom Properties
      summary: Delete a specified custom property definition record
      operationId: deleteCustomPropertyDefinition
      parameters:
      - $ref: '#/components/parameters/custPropId'
      responses:
        '204':
          description: No content
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
  /licenses/custprops/contexts:
    get:
      tags:
      - Custom Properties
      summary: Get the distinct set of contexts in use across custom property definitions
      operationId: getCustomPropertyDefinitionContexts
      parameters:
      - $ref: '#/components/parameters/x-okapi-tenant'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: Distinct context values (the ctx field) found across custom property definitions
                items:
                  type: string
        '400':
          description: Bad request error
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GrailsErrorResponse'
    servers:
    - url: https://folio-snapshot-okapi.dev.folio.org
    - url: https://folio-snapshot-2-okapi.dev.folio.org
    - url: https://folio-etesting-snapshot-kong.ci.folio.org
components:
  parameters:
    filters:
      in: query
      name: filters
      required: false
      schema:
        type: string
    page:
      in: query
      name: page
      required: false
      schema:
        type: integer
    sort:
      in: query
      name: sort
      required: false
      schema:
        type: string
    perPage:
      in: query
      name: perPage
      required: false
      schema:
        type: integer
    x-okapi-tenant:
      in: header
      name: x-okapi-tenant
      required: true
      schema:
        type: string
    offset:
      in: query
      name: offset
      required: false
      schema:
        type: integer
    custPropId:
      in: path
      name: custPropId
      description: ID for a custom property definition
      required: true
      schema:
        type: string
    term:
      in: query
      name: term
      required: false
      schema:
        type: string
    stats:
      in: query
      name: stats
      required: false
      schema:
        type: boolean
    match:
      in: query
      name: match
      required: false
      schema:
        type: string
  schemas:
    GrailsErrorResponse:
      type: object
      description: Error-handler body for an uncaught exception raised during request processing. `exception` and `stackTrace` usually suppressed in production systems
      required:
      - error
      - timestamp
      - message
      properties:
        error:
          type: integer
          description: HTTP status code
        timestamp:
          type: string
          format: date-time
        message:
          type: string
        exception:
          type: string
          description: Exception class and message.
        stackTrace:
          type: array
          items:
            type: string
    ValidationErrorResponse:
      description: 'Validation error body returned when a create/update request fails domain-object validation. Shape depends on the number of errors: a single ValidationError when there is exactly one, otherwise a wrapper with a count and an embedded array.'
      oneOf:
      - $ref: '#/components/schemas/ValidationError'
      - type: object
        required:
        - total
        - _embedded
        properties:
          total:
            type: integer
          _embedded:
            type: object
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/ValidationError'
    RefData:
      type: object
      required:
      - id
      properties:
        id:
          type: string
          readOnly: true
        label:
          type: string
        value:
          type: string
        owner:
          $ref: '#/components/schemas/RefDataCategory'
    CustomPropertyDefinitionResultsArray:
      type: array
      items:
        $ref: '#/components/schemas/CustomPropertyDefinition'
    RefDataCategory:
      type: object
      required:
      - id
      properties:
        desc:
          type: string
        id:
          type: string
          readOnly: true
        internal:
          type: boolean
        values:
          type: array
          items:
            $ref: '#/components/schemas/RefData'
    ResultsMeta:
      type: object
      properties:
        meta:
          type: object
        page:
          type: integer
        pageSize:
          type: integer
        total:
          type: integer
        totalPages:
          type: integer
        totalRecords:
          type: integer
    CustomPropertyDefinition:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        label:
          type: string
        description:
          type: string
        primary:
          type: boolean
        defaultInternal:
          type: boolean
        retired:
          type: boolean
        weight:
          type: integer
        type:
          type: string
          description: Java class name indicating the property type (e.g. CustomPropertyInteger, CustomPropertyText, CustomPropertyRefdata)
        category:
          $ref: '#/components/schemas/RefDataCategory'
    ValidationError:
      type: object
      required:
      - message
      - path
      - _links
      properties:
        message:
          type: string
        path:
          type: string
        _links:
          type: object
          required:
          - self
          properties:
            self:
              type: object
              required:
              - href
              properties:
                href:
                  type: string
                  format: uri
    CustomPropertyDefinitionResults:
      type: object
      required:
      - results
      allOf:
      - $ref: '#/components/schemas/ResultsMeta'
      - type: object
      - properties:
          results:
            $ref: '#/components/schemas/CustomPropertyDefinitionResultsArray'
  securitySchemes:
    okapiToken:
      type: apiKey
      in: header
      name: x-okapi-token
    accessToken:
      type: apiKey
      in: cookie
      name: folioAccessToken
x-refined-from:
- folio-mod-licenses-openapi.json
- folio-mod-licenses-openapi.yml