Loading
Documentation Powered by ReDoc

DFS ECS API (latest)

Download OpenAPI specification:Download

REST Services for managing ECS data

Content

Get the list of tags for all of the active and not expired contents

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error

get/v1.0/content/tags
https://example-host/v1.0/content/tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Get the content by its id

Gets both expired and non-expired content

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Content Id

query Parameters
includeSchema
boolean
Default: false

set to true if you want to get back the content's corresponding schema (defaults to false)

header Parameters
Accept-Language
string

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

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "schemaId": 0,
  • "name": "string",
  • "isActive": true,
  • "isPublished": true,
  • "createdDate": "2024-11-07T14:53:54Z",
  • "updatedDate": "2024-11-07T14:53:54Z",
  • "validUntil": "2024-11-07T14:53:54Z",
  • "data": "string",
  • "schema":
    {
    },
  • "contentFor":
    {
    },
  • "tags":
    [
    ],
  • "submissions":
    [
    ]
}

Get non-expired content by its id

Gets non-expired content

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Content Id

query Parameters
includeSchema
boolean
Default: false

set to true if you want to get back the content's corresponding schema (defaults to false)

header Parameters
Accept-Language
string

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

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

get/v1.0/content/latest/{id}
https://example-host/v1.0/content/latest/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "schemaId": 0,
  • "name": "string",
  • "isActive": true,
  • "isPublished": true,
  • "createdDate": "2024-11-07T14:53:54Z",
  • "updatedDate": "2024-11-07T14:53:54Z",
  • "validUntil": "2024-11-07T14:53:54Z",
  • "data": "string",
  • "schema":
    {
    },
  • "contentFor":
    {
    },
  • "tags":
    [
    ],
  • "submissions":
    [
    ]
}

Get the document of a content (both expired and non-expired) by its content Id

Gets the document associated with a content (both expired and non-expired) by its content Id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Content Id

language
required
string

The 2 letter language code (ISO 639-1)

header Parameters
Accept-Language
string

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

Responses

200

Success

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

get/v2.0/content/{id}/document/{language}
https://example-host/v2.0/content/{id}/document/{language}

Response samples

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

Get the document of a non-expired content by its content Id

Gets the document associated with a non-expired content by its content Id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Content Id

language
required
string

The 2 letter language code (ISO 639-1)

header Parameters
Accept-Language
string

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

Responses

200

Success

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

get/v2.0/content/{id}/latest/document/{language}
https://example-host/v2.0/content/{id}/latest/document/{language}

Response samples

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

Get the image of a content (both expired and non-expired) by its content Id

Gets the image associated with a content (both expired and non-expired) by its content Id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Content Id

language
required
string

The 2 letter language code (ISO 639-1)

header Parameters
Accept-Language
string

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

Responses

200

Success

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

get/v2.0/content/{id}/image/{language}
https://example-host/v2.0/content/{id}/image/{language}

Response samples

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

Get the image of a non-expired content by its content Id

Gets the image associated with a non-expired content by its content Id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Content Id

language
required
string

The 2 letter language code (ISO 639-1)

header Parameters
Accept-Language
string

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

Responses

200

Success

204

No Content

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

get/v2.0/content/{id}/latest/image/{language}
https://example-host/v2.0/content/{id}/latest/image/{language}

Response samples

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

Modify Engagement Content(s) status

Modify the status of a given set of Engagement Contents.

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json

The parameter DTO

contentIds
Array of integers <int32> Nullable

List of content id's which will be updated

status
boolean Nullable

The new status

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

422

UnprocessableEntity

500

Internal server error

patch/v1.0/content/status
https://example-host/v1.0/content/status

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contentIds":
    [
    ],
  • "status": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Get the list of contents

Gets the list of existing Engagement Contents. The service allows both filtering and sorting.

Authorizations:
Bearer
query Parameters
language
string
header Parameters
Accept-Language
string

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

Request Body schema: application/json
page
integer <int32>
pageSize
integer <int32>
sortBy
string Nullable
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
name
string Nullable

The Name of the content.

tags
Array of strings Nullable

The list of tags.

categories
Array of strings (SearchCategory) Nullable
Items Enum: "Security" "Portfolio" "Product" "RiskCategory" "Sector" "Currency" "AssetClass" "Country" "Focus" "EconomicalZone" "Rating" "RatingAgency" "ModelPortfolio"

The list of content categories.

contentFor
Array of strings <uuid> Nullable

The list of uid's.

isPublished
boolean Nullable

Determines if the content was published or not.

status
boolean Nullable

Determines if the content is active or not.

createdDateFrom
string <date-time> Nullable

The start value of the creation date.

createdDateTo
string <date-time> Nullable

The end value of the creation date.

validDateFrom
string <date-time> Nullable

The start value of the validity date.

validDateTo
string <date-time> Nullable

The end value of the validity date.

updateDateFrom
string <date-time> Nullable

The start value of the last updated date.

updateDateTo
string <date-time> Nullable

The end value of the last updated date.

schemaIds
Array of integers <int32> Nullable

The list of schema ids.

relatedTo
string Nullable

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

post/v1.1/content/search
https://example-host/v1.1/content/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "name": "string",
  • "tags":
    [
    ],
  • "categories":
    [
    ],
  • "contentFor":
    [
    ],
  • "isPublished": true,
  • "status": true,
  • "createdDateFrom": "2024-11-07T14:53:54Z",
  • "createdDateTo": "2024-11-07T14:53:54Z",
  • "validDateFrom": "2024-11-07T14:53:54Z",
  • "validDateTo": "2024-11-07T14:53:54Z",
  • "updateDateFrom": "2024-11-07T14:53:54Z",
  • "updateDateTo": "2024-11-07T14:53:54Z",
  • "schemaIds":
    [
    ],
  • "relatedTo": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalNumberOfResults": 0,
  • "contentMinimalResults":
    [
    ]
}

Get the contents (both expired and non-expired) by their schema id

Gets the contents (both expired and non-expired) by their schema id

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json
schemaId
required
integer <int32>

The schema Id of the contents.

pageNumber
integer <int32>

The result page number, starting by 1.

pageSize
integer <int32>

The number of items in a result page.

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

post/v1.0/content/schema
https://example-host/v1.0/content/schema

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "schemaId": 0,
  • "pageNumber": 0,
  • "pageSize": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalNumberOfResults": 0,
  • "contentMinimalResults":
    [
    ]
}

Get the non-expired contents by their schema id

Gets the non-expired contents by their schema id

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json
schemaId
required
integer <int32>

The schema Id of the contents.

pageNumber
integer <int32>

The result page number, starting by 1.

pageSize
integer <int32>

The number of items in a result page.

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

post/v1.0/content/latest/schema
https://example-host/v1.0/content/latest/schema

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "schemaId": 0,
  • "pageNumber": 0,
  • "pageSize": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalNumberOfResults": 0,
  • "contentMinimalResults":
    [
    ]
}

Get the contents by Tag

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json

The parameter DTO

tag
required
string non-empty

The tag of the content.

isPublished
boolean Nullable

Determines if the content was published or not.

isActive
boolean Nullable

Determines if the content is active or not.

isValid
boolean Nullable

Determines if the content is valid or not (compares the Validity of the Content with the current date).

createdDateFrom
string <date-time> Nullable

If this value is empty or null then all contents that were created starting from the very begining date until CreatedDateTo or today (if CreatedDateTo does not have a value set) will be return. The service supports the extended profile of the ISO 8601-1:2019 format - for example: 2019-07-26T16:59:57-05:00.

createdDateTo
string <date-time> Nullable

If this value is empty or null then all contents that were created starting from CreatedDateFrom or from the very begining date (if CreatedDateFrom does not have a value set) until today will be return. The service supports the extended profile of the ISO 8601-1:2019 format - for example: 2019-07-26T16:59:57-05:00.

pageNumber
integer <int32>

The result page number, starting by 1

pageSize
integer <int32>

The number of items in a result page

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

post/v2.0/content/tag
https://example-host/v2.0/content/tag

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "tag": "string",
  • "isPublished": true,
  • "isActive": true,
  • "isValid": true,
  • "createdDateFrom": "2024-11-07T14:53:54Z",
  • "createdDateTo": "2024-11-07T14:53:54Z",
  • "pageNumber": 0,
  • "pageSize": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "data":
    [
    ],
  • "totalResults": 0
}

Create a new content

Create a new content for a given schema

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json

The parameter DTO

schemaId
required
integer <int32>

The Schema Id.

data
required
string non-empty

The content body in JSON format.

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

post/v2.0/content
https://example-host/v2.0/content

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "schemaId": 0,
  • "isActive": true,
  • "isPublished": true,
  • "createdDate": "2024-11-07T14:53:54Z",
  • "updatedDate": "2024-11-07T14:53:54Z",
  • "validUntil": "2024-11-07T14:53:54Z",
  • "data": "string",
  • "contentFor":
    {
    },
  • "tags":
    [
    ],
  • "submissions":
    [
    ],
  • "uId": "string"
}

Update an existing content for a given schema

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json

The parameter DTO

id
required
integer <int32>

The Content Id.

data
required
string non-empty

The content body in JSON format.

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

422

UnprocessableEntity

500

Internal server error

put/v2.0/content
https://example-host/v2.0/content

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "validUntil": "2024-11-07T14:53:54Z",
  • "isPublished": true,
  • "updatedDate": "2024-11-07T14:53:54Z"
}

Schema

Delete an existing schema

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Schema Id

header Parameters
Accept-Language
string

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

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

422

UnprocessableEntity

500

Internal server error

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

Response samples

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

Get the schema by its Id

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Schema Id

header Parameters
Accept-Language
string

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

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "schema": "string",
  • "isActive": true,
  • "updatedDate": "2024-11-07T14:53:54Z"
}

Get the list of schemas

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json
pageNumber
integer <int32>

The result page number, starting by 1

pageSize
integer <int32>

The number of items in a result page

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

post/v1.0/schema/all
https://example-host/v1.0/schema/all

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "pageNumber": 0,
  • "pageSize": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "totalNumberOfResults": 0,
  • "schemaMinimalResults":
    [
    ]
}

Create a new schema

Create a new schema

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json

The parameter DTO

name
required
string non-empty

The name of the schema.

schema
required
string non-empty

The schema body in JSON format.

Responses

200

OK

201

Created

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

post/v1.0/schema
https://example-host/v1.0/schema

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "isActive": true,
  • "updatedDate": "2024-11-07T14:53:54Z"
}

Update an existing schema

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json

The parameter DTO

id
required
integer <int32>

The Id of the schema.

name
required
string non-empty

The name of the schema.

schema
required
string non-empty

The schema body in JSON format.

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not found

422

UnprocessableEntity

500

Internal server error

put/v1.0/schema
https://example-host/v1.0/schema

Request samples

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

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "updatedDate": "2024-11-07T14:53:54Z"
}

Search Engagement content schemas

Searches Engagement content schemas

Authorizations:
Bearer
header Parameters
Accept-Language
string

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

Request Body schema: application/json
page
integer <int32>
pageSize
integer <int32>
sortBy
string Nullable
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
name
string Nullable
isActive
boolean Nullable
updateDateFrom
string <date-time> Nullable
updateDateTo
string <date-time> Nullable

Responses

200

Success

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal server error

post/v1.0/schema/search
https://example-host/v1.0/schema/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "name": "string",
  • "isActive": true,
  • "updateDateFrom": "2024-11-07T14:53:54Z",
  • "updateDateTo": "2024-11-07T14:53:54Z"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}