Get a list of categories of an existing location

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Locations/{id}/Categories

The user must have access to the specified location. Categories are implicitly filtered by the user's read permission.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
id
integer (int32) Required

Unique ID of the location

version
stringRequired

The requested API version

Default"1.18"
Responses
200

OK

Array of object
object

Location's category

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the category

Inherited
boolean

If true, this category is inherited from the parent location. Default: false.

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 category

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
403

Forbidden

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

Location not found

500

Unexpected error

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