Unqork Data Model Records API

openapi: 3.2.0
info:
  version: 1.0.0
  x-logo:
    url: https://developers.unqork.io/unqork-logo.png
    backgroundColor: '#FFFFFF'
  title: Unqork Customer Data Model Records API
  description: Unqork's customer REST API, based on open standards, allows you to set and retrieve module submission data, as well as control other aspects of your Unqork environment.
servers:
- url: https://{host}/api/1.0
  variables:
    host:
      default: env.unqork.io
      description: Environment host
security:
- OAuth2: []
tags:
- name: Data Model Records
paths:
  /models/validateFromSchema:
    post:
      x-unqork-service: true
      tags:
      - Data Model Records
      summary: Validate From Schema
      description: 'Requires `enable-data-models-feature` feature flag. Validate data against a json schema, either by schema definition or schema ID. `jsonSchema` or `schemaId` are required parameters.

        ### Authorization Required:

        - Authenticated'
      parameters:
      - name: validateRequiredFields
        in: query
        description: If false, ignore required fields of a schema and validate the format only
        schema:
          type: boolean
          default: true
      requestBody:
        content:
          application/json:
            schema:
              required:
              - data
              properties:
                data:
                  description: Data to validate against
                  type: object
                draftVersion:
                  description: JSON Schema draft version. For more information on JSON Schema draft versions - https://json-schema.org/specification-links
                  type: string
                  default: draft-07
                  enum:
                  - draft-06
                  - draft-07
                  - draft-2019-09
                  - draft-2020-12
                fieldMapping:
                  description: 'Field map to validate against


                    e.g. `[{ field: ''name'', model: ''modelId'', type: ''string'', connectedTo: ''name1'' }, { field: ''price'', model: ''modelId'', type: ''number'', connectedTo: ''price1'' }]`

                    '
                  type: array
                  items:
                    type: object
                    properties:
                      connectedTo:
                        type: string
                        description: Property ID of the component that is mapped to the data property
                      field:
                        type: string
                        description: Property ID of the data property
                      model:
                        type: string
                        description: ID of the data model the field belongs to
                      type:
                        type: string
                        description: Type of the data property
                jsonSchema:
                  description: Schema to validate data
                  type: object
                schemaId:
                  description: Schema ID to validate data
                  type: string
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                description: 'An object with a key of `data`, with a value that is an object. That object has keys that are the `fieldMapping` `field` with the matching data property as the value. If no `fieldMapping` is passed, then the passed `data` is returned if no errors are encountered.

                  e.g. Given the data below plus the `fieldMapping` example -


                  **data:** `{ name1: ''shirt'', price1: 1, addProp: ''extra'' }`


                  **jsonSchema:** `{ title: ''Sample Schema'', type: ''object'', properties: { name: { type: ''string'' }, price: { type: ''number'' } }, required: [''name''] }`


                  **Response:**


                  `{ data: { ''modelId'': { name: ''shirt'', price: 1 } } }`

                  '
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: postModelsValidateFromSchema
      x-operation-id-source: derived
components:
  schemas:
    Error:
      type: object
      description: Error
      required:
      - code
      - message
      properties:
        code:
          description: HTTP status code
          type: integer
          format: int32
          enum:
          - 400
          - 401
          - 403
          - 404
          - 412
          - 500
        message:
          description: Error message
          type: string
  securitySchemes:
    OAuth2:
      description: "The Unqork API implements the [OAuth 2.0 Client Credentials Grant](https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.4) and the [OAuth 2.0 Password Grant](https://tools.ietf.org/html/rfc6749#section-1.3.3). Access via OAuth2 Client Credentials Grant can be utilized by creating Client Credentials through the API Access Management Administration page. Access via OAuth2 Password Grant can be enabled for all users in Environment Administration. Once OAuth2 Password Grant is enabled, all Unqork users can use their Unqork username/password to retrieve an access token.\n\nIn order to utilize any of the API resources, you must first retrieve an access token by POSTing your credentials to the access token URL, e.g. using `curl`:\n```\n  $ curl -u '{clientId}:{clientSecret}' -X POST --basic https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token -d \"grant_type=client_credentials\"\n```\nOr:\n```\n  $ curl -X POST https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token -d \"grant_type=password&username={username}&password={password}\"\n```\nThis returns an \"access_token\", which you would then retain and use in any subsequent resource requests. **Access tokens expire after one hour, at which point you must retrieve a new one.** The access token should be included in a request header:\n```\n  $ curl -H \"Authorization: Bearer {access_token}\" https://xyzfinancial.unqork.io/api/1.0/{endpoint}\n```\n"
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
          scopes:
            none: N/A
        password:
          tokenUrl: https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
          scopes:
            none: N/A