Get an existing category

Prev Next
Get
/v{version}/Categories/{id}
Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
id
integer (int32) Required

Unique ID of the category

version
stringRequired

The requested API version

Responses
200

OK

Expand All
object

Category details

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the category

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the category

ParentId
integer (int32)

Unique ID of the parent category

Permissions
object

Permissions of the spot group

property*
object additionalProperties

A set containing multiple entries containing one user group and its available permissions

Read
boolean
Write
boolean
Selectable
boolean

If true, the category is selectable in the IXM Platform. Default: false.

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
404

Not found

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties