Loading
Documentation Powered by ReDoc

DFS DynamicSchema Services API (latest)

Download OpenAPI specification:Download

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.0/credit-schemas/{id}
https://example-host/v1.0/credit-schemas/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/credit-schemas/{id}
https://example-host/v1.0/credit-schemas/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "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:
application/json

Patch dynamic schema request

data
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

name
object (UpdateableProperty%3C%3E)

Wrapper around properties used in patch requests

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.0/credit-schemas/{id}
https://example-host/v1.0/credit-schemas/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    {
    },
  • "name":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.0/credit-schemas/type/{schemaTypeId}
https://example-host/v1.0/credit-schemas/type/{schemaTypeId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1.0/credit-schemas/types
https://example-host/v1.0/credit-schemas/types

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

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:
application/json

Create dynamic schema request

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

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.0/credit-schemas
https://example-host/v1.0/credit-schemas

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data": "string",
  • "name": "string",
  • "dynamicSchemaTypeId": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}