DFS Resource Services API (latest)

Download OpenAPI specification:Download

Contains functionality related to resources.

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.

Resource

Delete resource set

Deletes a resource set.

Authorizations:

Bearer

path Parameters

resourceSetName

required

string

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

Server Error

delete/v1.0/resourcesets/{resourceSetName}

https://example-host/v1.0/resourcesets/{resourceSetName}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Update resource set

Updates a resource set.

Authorizations:

Bearer

path Parameters

resourceSetName

required

string

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

name	string Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/resourcesets/{resourceSetName}

https://example-host/v1.0/resourcesets/{resourceSetName}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Delete resource

Deletes resource by name.

Authorizations:

Bearer

path Parameters

resourceSetName required	string The name of the resource set.
resourceName required	string The name of the resource to delete.

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

Server Error

delete/v1.0/resourcesets/{resourceSetName}/resources/{resourceName}

https://example-host/v1.0/resourcesets/{resourceSetName}/resources/{resourceName}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get resource

Gets resource by name.

Authorizations:

Bearer

path Parameters

resourceSetName required	string The name of the resource set to return.
resourceName required	string The name of the resource to return.

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

Server Error

get/v1.0/resourcesets/{resourceSetName}/resources/{resourceName}

https://example-host/v1.0/resourcesets/{resourceSetName}/resources/{resourceName}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0,
"resourceSetId": 0,
"name": "string",
"description": "string",
"values": 
[
{"languageCode": "string",
"value": "string"
}
]
}

Update resource

Updates a resource

Authorizations:

Bearer

path Parameters

resourceSetName required	string The name of the resource set.
resourceName required	string The name of the resource to modify.

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

name	string Nullable
description	string Nullable
values	Array of objects (Api.Resources.ModifyResource.ResourceValue) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/resourcesets/{resourceSetName}/resources/{resourceName}

https://example-host/v1.0/resourcesets/{resourceSetName}/resources/{resourceName}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"description": "string",
"values": 
[
{"value": "string",
"languageCode": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Get resource sets

Returns a list of all resource sets in the system.

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

Server Error

get/v1.1/resourcesets

https://example-host/v1.1/resourcesets

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"resourceSets": 
[
{"id": 1,
"name": "Dashboard",
"values": 
[
{"resourceId": 1,
"name": "Page.Title",
"value": "Dashboard"
},
{"resourceId": 2,
"name": "Page.Description",
"value": "Displays all your important application data at one glance."
},
{"resourceId": 3,
"name": "Messages.Title",
"value": "Messages"
},
{"resourceId": 4,
"name": "Messages.Inbox",
"value": "Your Inbox"
},
{"resourceId": 5,
"name": "Messages.Outbox",
"value": "Your Outbox"
}
]
},
{"id": 2,
"name": "Profile",
"values": 
[
{"resourceId": 1,
"name": "Page.Title",
"value": "Your Profile"
},
{"resourceId": 2,
"name": "Page.Description",
"value": "View and edit your personal data and preferences."
},
{"resourceId": 3,
"name": "PersonalData.Title",
"value": "Personal data"
},
{"resourceId": 4,
"name": "PersonalData.Nickname",
"value": "Your nickname to be displayed to others"
},
{"resourceId": 5,
"name": "PersonalData.Birthday",
"value": "Your birthday"
},
{"resourceId": 6,
"name": "PersonalData.Description",
"value": "Tell others about you"
}
]
}
]
}

Create resource set

Creates a new resource set

Authorizations:

Bearer

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

name	string Nullable

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/resourcesets

https://example-host/v1.1/resourcesets

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Get resource set by name.

Returns a specific resource set that matches the passed resourceSetName.

Authorizations:

Bearer

path Parameters

resourceSetName

required

string

The name of the resource set to return.

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

Server Error

get/v1.1/resourcesets/{resourceSetName}

https://example-host/v1.1/resourcesets/{resourceSetName}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 1,
"name": "Dashboard",
"values": 
[
{"resourceId": 1,
"name": "Page.Title",
"value": "Dashboard"
},
{"resourceId": 2,
"name": "Page.Description",
"value": "Displays all your important application data at one glance."
},
{"resourceId": 3,
"name": "MessagesWidget.Title",
"value": "Messages"
},
{"resourceId": 4,
"name": "MessagesWidget.Inbox",
"value": "Your Inbox"
},
{"resourceId": 5,
"name": "MessagesWidget.Outbox",
"value": "Your Outbox"
}
]
}

Create resource

Creates a new resource.

Authorizations:

Bearer

path Parameters

resourceSetName

required

string

header Parameters

Accept-Language

string

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

Request Body schema:
application/json

name	string Nullable
description	string Nullable
values	Array of objects (Api.Resources.CreateResource.ResourceValue) Nullable

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/resourcesets/{resourceSetName}/resources

https://example-host/v1.0/resourcesets/{resourceSetName}/resources

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "string",
"description": "string",
"values": 
[
{"languageCode": "string",
"value": "string"
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"id": 0
}

Search resource sets

Searches for resource sets and returns a list with resource sets (and key attributes) matching the passed request parameters.

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"
ids	Array of integers <int32> Nullable
names	Array of strings Nullable
search	string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/resourcesets/search

https://example-host/v1.0/resourcesets/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "Ascending",
"ids": 
[0
],
"names": 
["string"
],
"search": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"name": "string"
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

Search resources

Searches for resources and returns a list with resources (and key attributes) matching the passed request parameters.

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"
ids	Array of integers <int32> Nullable
names	Array of strings Nullable
resourceSetIds	Array of integers <int32> Nullable
resourceSetNames	Array of strings Nullable
search	string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/resourcesets/resources/search

https://example-host/v1.0/resourcesets/resources/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "Ascending",
"ids": 
[0
],
"names": 
["string"
],
"resourceSetIds": 
[0
],
"resourceSetNames": 
["string"
],
"search": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"id": 0,
"resourceSetId": 0,
"name": "string",
"description": "string"
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

Export resources file

Produces a CSV file containing the resources (and associated values) of a given resource set.

Authorizations:

Bearer

path Parameters

resourceSetName

required

string

The name of the resource set.

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

Server Error

post/v1.0/resourcesets/{resourceSetName}/resources/export-file

https://example-host/v1.0/resourcesets/{resourceSetName}/resources/export-file

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

Import resources file

Imports a CSV file containing the resources (and associated values) of a given resource set.

Authorizations:

Bearer

path Parameters

resourceSetName

required

string

The name of the resource set.

header Parameters

Accept-Language

string

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

Request Body schema: multipart/form-data

file	string <binary>

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/resourcesets/{resourceSetName}/resources/import-file

https://example-host/v1.0/resourcesets/{resourceSetName}/resources/import-file

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

DFS Resource Services API (latest)

Resource

Delete resource set

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update resource set

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete resource

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get resource

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update resource

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get resource sets

Authorizations:

header Parameters

Responses

Response samples

Create resource set

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get resource set by name.

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Create resource

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Search resource sets

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Search resources

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Export resources file

Authorizations:

path Parameters

header Parameters

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json