Loading
API docs by Redocly

DFS DynamicSchema Services API (latest)

Download OpenAPI specification:

Contains functionality around dynamic schemas.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

DynamicSchema

Delete dynamic schema

Deletes an existing dynamic schema.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the dynamic schema

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get a dynamic schema

Gets a dynamic schema. This includes the JSON schema data.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": "string",
  • "name": "string",
  • "dynamicSchemaType": {
    }
}

Modify a dynamic schema

Modifies an existing dynamic schema.

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Id of the dynamic schema that will be modified

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Patch dynamic schema request

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

object (UpdateableProperty<>)

Wrapper around properties used in patch requests

Responses

Request samples

Content type
{
  • "data": {
    },
  • "name": {
    }
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get a list of all the dynamic schema filtered by type

Gets a list of all the dynamic schema filtered by type. This does not include the JSON schema data.

Authorizations:
Bearer
path Parameters
schemaTypeId
required
integer <int32>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all the dynamic schema types

Gets all the existing dynamic schema types.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new dynamic schema

Creates a new dynamic schema.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

Create dynamic schema request

data
required
string non-empty
name
required
string non-empty
dynamicSchemaTypeId
required
integer <int32>

Responses

Request samples

Content type
{
  • "data": "string",
  • "name": "string",
  • "dynamicSchemaTypeId": 0
}

Response samples

Content type
application/json
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}