Generate JSON Schema dynamically.

POST 
/form-definitions/forms-action-dynamic-schema

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Generate JSON Schema dynamically.

Request

Header Parameters

X-SailPoint-Experimental stringrequired
Default value: true
Use this header to enable this experimental API.
Example: true

application/json

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

Returns a form elements dynamic schema

application/json

Schema

Schema

outputSchema

object

OutputSchema holds a JSON schema generated dynamically

property name* any

OutputSchema holds a JSON schema generated dynamically

Example (from schema)

{
  "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"
    }
  }
}

400

An error with the request occurred

application/json

Schema

Schema

detailCode string

messages

object[]

Array [

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

Example (from schema)

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

401

An error with the authorization occurred

application/json

Schema

Schema

detailCode string

messages

object[]

Array [

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

Example (from schema)

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

403

An error with the user permissions occurred

application/json

Schema

Schema

detailCode string

messages

object[]

Array [

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

Example (from schema)

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

404

An error with the item not found

application/json

Schema

Schema

detailCode string

messages

object[]

Array [

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

Example (from schema)

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

429

Too many requests

application/json

Schema

Schema

detailCode string

DetailCode is the text of the status code returned

messages

object[]

Array [

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

Example (from schema)

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

500

An internal server error occurred

application/json

Schema

Schema

detailCode string

messages

object[]

Array [

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

Example (from schema)

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

Loading...