Generate JSON Schema dynamically.

Generate JSON Schema dynamically.

application/json

Request Body

Body is the request payload to create a form definition dynamic schema

• attributes object

  formDefinitionId string

  FormDefinitionID is a unique guid identifying this form definition

• description string

  Description is the form definition dynamic schema description text

• id string

  ID is a unique identifier

• type string

  Type is the form definition dynamic schema type

• versionNumber int64

  VersionNumber is the form definition dynamic schema version number

Responses

• 200
• 400
• 401
• 403
• 404
• 429
• 500

---

Returns a form elements dynamic schema

application/json

• Schema
• Example (from schema)

---

Schema

• outputSchema object

  OutputSchema holds a JSON schema generated dynamically

{
  "outputSchema": {
    "outputSchema": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "additionalProperties": false,
      "properties": {
        "firstName": {
          "title": "First Name",
          "type": "string"
        },
        "fullName": {
          "title": "Full Name",
          "type": "string"
        },
        "lastName": {
          "title": "Last Name",
          "type": "string"
        },
        "startDate": {
          "format": "date-time",
          "title": "Start Date",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}

An error with the request occurred

application/json

• Schema
• Example (from schema)

---

Schema

• detailCode string
• messages object[]

  locale string

  Locale is the current Locale

  localeOrigin string

  LocaleOrigin holds possible values of how the locale was selected

  text string

  Text is the actual text of the error message

• statusCode int64
• trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

An error with the authorization occurred

application/json

• Schema
• Example (from schema)

---

Schema

• detailCode string
• messages object[]

  locale string

  Locale is the current Locale

  localeOrigin string

  LocaleOrigin holds possible values of how the locale was selected

  text string

  Text is the actual text of the error message

• statusCode int64
• trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

An error with the user permissions occurred

application/json

• Schema
• Example (from schema)

---

Schema

• detailCode string
• messages object[]

  locale string

  Locale is the current Locale

  localeOrigin string

  LocaleOrigin holds possible values of how the locale was selected

  text string

  Text is the actual text of the error message

• statusCode int64
• trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

An error with the item not found

application/json

• Schema
• Example (from schema)

---

Schema

• detailCode string
• messages object[]

  locale string

  Locale is the current Locale

  localeOrigin string

  LocaleOrigin holds possible values of how the locale was selected

  text string

  Text is the actual text of the error message

• statusCode int64
• trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

Too many requests

application/json

• Schema
• Example (from schema)

---

Schema

• detailCode string

  DetailCode is the text of the status code returned

• messages object[]

  locale string

  Locale is the current Locale

  localeOrigin string

  LocaleOrigin holds possible values of how the locale was selected

  text string

  Text is the actual text of the error message

• trackingId string

  TrackingID is the request tracking unique identifier

{
  "detailCode": "Internal Server Error",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "trackingId": "9cd03ef80e6a425eb6b11bdbb057cdb4"
}

An internal server error occurred

application/json

• Schema
• Example (from schema)

---

Schema

• detailCode string
• messages object[]

  locale string

  Locale is the current Locale

  localeOrigin string

  LocaleOrigin holds possible values of how the locale was selected

  text string

  Text is the actual text of the error message

• statusCode int64
• trackingId string

{
  "detailCode": "string",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "This is an error"
    }
  ],
  "statusCode": 0,
  "trackingId": "string"
}

Loading...