DFS v26.1
Loading
API docs by Redocly

DFS Target Market Services API (latest)

Download OpenAPI specification:

Contains functionality around target market.

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.

DefinitionManagement

Retrieve allowed attributes and values for a given definition.

Retrieves allowed attributes and values for a given definition.

Authorizations:
Bearer
path Parameters
definitionKey
required
string

Definition Key

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "nameResourceKey": "string",
  • "definition": [
    ]
}

InstanceManagement

Retrieve attribute and value pairs saved for a specific entity.

Retrieves attribute and value pairs saved for a specific entity.

Authorizations:
Bearer
path Parameters
entityUid
required
string <uuid>

The entity UID

header Parameters
Accept-Language
string

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

Responses

Response samples

Content type
application/json
{
  • "definitionKey": "string",
  • "instance": [
    ]
}

Set a list of attribute and value pairs for a specific entity.

Sets a list of attribute and value pairs for a specific entity. More than one value may be saved for a specific attribute. Only attributes which are in the specified target market may be passed. Only values associated with the attribute may be passed for a specific attribute.

Authorizations:
Bearer
path Parameters
entityUid
required
string <uuid>

Entity id

header Parameters
Accept-Language
string

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

Request Body schema:

The parameter DTO

definitionKey
string or null
Array of objects or null (TargetMarketInstanceRequest)

Responses

Request samples

Content type
{
  • "definitionKey": "DefinitionKey",
  • "instance": [
    ]
}

Response samples

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

Search instances based on a common definition

Searches instances based on a common definition. Only attributes which are in the specified target market may be passed. Only values associated with the attribute may be passed for a specific attribute.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:

The parameter DTO

definitionKey
string or null
Array of objects or null (TargetMarketInstanceSearchParametersRequest)

Responses

Request samples

Content type
{
  • "definitionKey": "DefinitionKey",
  • "searchParameters": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Validate target market instance

Validates a passed target market instance against the target market of a passed list of references.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema:
definitionKey
required
string non-empty
referenceUids
required
Array of strings <uuid> [ items <uuid > ]
required
Array of objects (TargetMarketInstanceAttributeKeyToValueKeysRequest)

Responses

Request samples

Content type
{
  • "definitionKey": "Security",
  • "referenceUids": [
    ],
  • "instanceToValidate": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "isSuitable": true,
  • "validations": [
    ]
}