api-specs/idn/beta/paths/form-definition-data-source.yaml

post:
  tags:
    - Custom Forms
  summary: Preview form definition data source.
  operationId: showPreviewDataSource
  parameters:
    - name: formDefinitionID
      in: path
      description: Form definition ID
      required: true
      schema:
        type: string
        x-go-name: FormDefinitionID
      example: 00000000-0000-0000-0000-000000000000
      x-go-name: FormDefinitionID
    - name: limit
      in: query
      description: |-
        Limit

        Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
        If it is not specified, a default limit is used.
      schema:
        type: integer
        format: int64
        maxLength: 250
        minLength: 0
        default: 10
        x-go-name: Limit
      example: 10
      required: false
      x-go-name: Limit
    - name: filters
      in: query
      description: >-
        Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)


        Filtering is supported for the following fields and operators:


        **value**: *eq, gt, sw, in*


        **label**: *eq, gt, sw, in*


        **subLabel**: *eq, gt, sw, in*
      schema:
        type: string
        x-go-name: Filters
      example: label sw "my label"
      required: false
      x-go-name: Filters
    - name: query
      in: query
      description: |-
        Query
        
        String specifying to query against
      schema:
        type: string
        x-go-name: Query
      example: support
      required: false
      x-go-name: Query
  requestBody:
    description: Body is the request payload to create a form definition dynamic
      schema
    content:
      application/json:
        schema:
          $ref: '../schemas/forms/FormElementPreviewRequest.yaml'
    required: false
  responses:
    "200":
      description: Returns a preview of a form definition data source
      content:
        application/json:
          schema:
            $ref: '../schemas/forms/PreviewDataSourceResponse.yaml'
    "400":
      description: An error with the request occurred
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
    "401":
      description: An error with the authorization occurred
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
    "403":
      description: An error with the user permissions occurred
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
    "404":
      description: An error with the item not found
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
    "429":
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '../schemas/forms/Error.yaml'
    "500":
      description: An internal server error occurred
      content:
        application/json:
          schema:
            type: object
            properties:
              detailCode:
                type: string
                x-go-name: DetailCode
              messages:
                type: array
                items:
                  $ref: '../schemas/forms/ErrorMessage.yaml'
                x-go-name: Messages
              statusCode:
                type: integer
                format: int64
                x-go-name: StatusCode
              trackingId:
                type: string
                x-go-name: TrackingID
  security:
    - UserContextAuth:
        - sp:forms:manage