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: 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 location
version
stringRequired
The requested API version
Responses
200
Returns the list of categories.
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
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401
Unauthorized
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403
Forbidden if user doesn't have access.
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
404
Location not found.
object
Detail
string
Instance
string
Status
integer (int32)
Title
string
Type
string
property*
object additionalProperties
500
Unexpected error
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties