Loading
API docs by Redocly

DFS Resource Services API (latest)

Download OpenAPI specification:

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

Response samples

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

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:
required
name
string or null

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

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

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

Response samples

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

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

Response samples

Content type
application/json
{
  • "id": 0,
  • "resourceSetId": 0,
  • "name": "string",
  • "description": "string",
  • "values": [
    ]
}

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:
required
name
string or null
description
string or null
Array of objects or null (Api.Resources.ModifyResource.ResourceValue)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "values": [
    ]
}

Response samples

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

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

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Dashboard",
  • "values": [
    ]
}

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:
required
name
string or null

Responses

Request samples

Content type
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0
}

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:
required
name
string or null
description
string or null
Array of objects or null (Api.Resources.CreateResource.ResourceValue)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "values": [
    ]
}

Response samples

Content type
application/json
{
  • "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:
required
page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
ids
Array of integers or null <int32> [ items <int32 > ]
names
Array of strings or null
search
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "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:
required
page
integer <int32>
pageSize
integer <int32>
sortBy
string or null
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
ids
Array of integers or null <int32> [ items <int32 > ]
names
Array of strings or null
resourceSetIds
Array of integers or null <int32> [ items <int32 > ]
resourceSetNames
Array of strings or null
search
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "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

Response samples

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

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>

The csv file containing the resources and associated values of a given resource set.

Responses

Response samples

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