Skip to navigation

Get a Dimension Set by its name

This endpoint retrieves the Dimension Set with the given name. The response carries an ETag. Send that value back as If-Match when replacing or deleting the Dimension Set, so a change made by someone else in the meantime is rejected rather than overwritten.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

namestringRequired

The name of the Dimension Set. Business keys occupy a single path segment, so a value containing a / is rejected rather than silently changing the route.

Response headers

ETagstringOptional

Current entity tag of the resource. Supply it as If-Match on a subsequent update or deactivation.

Response

OK
namestringOptionalRead-only

The name that identifies the Dimension Set. It is returned in responses; on a write the name in the path is used and any name in the body is ignored.

descriptionstringOptional
What the Dimension Set is used for.
attributeslist of stringsOptional
The Journal Line fields in the Dimension Set. A write replaces the whole list. The mandatory fields of the Journal Line Definition may be included or left out, and are always listed first when you read the Dimension Set back.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
5XX
Server Error