Get Category
Endpoint for retrieving details for a category.
Request
URI
GET
https://{api_host}/vco/api/categories/{id}
COPY
Path Parameters
string
id
Required
id
Responses
200
The request is successful
Returns
WsCategory
of type(s)
application/json
{
"relations": {
"startIndex": 0,
"count": 0,
"total": 0,
"link": [
{
"rel": "string",
"type": "string",
"attributes": [
{
"name": "string",
"displayName": "string",
"value": "string",
"displayValue": "string"
}
],
"href": "string"
}
]
},
"id": "string",
"name": "string",
"description": "string",
"path": "string",
"type": "string",
"href": "string",
"path-ids": [
"string"
]
}
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
description
Optional
description
string
path
Optional
path
string
type
Optional
type
Possible values are :
ResourceElementCategory,
ConfigurationElementCategory,
WorkflowCategory,
PolicyTemplateCategory,
ScriptModuleCategory,
string
href
Optional
href
array of
string
path-ids
Optional
path-ids
401
User is not authorized
Returns
WsCategory
of type(s)
application/json
"WsCategory Object"
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
description
Optional
description
string
path
Optional
path
string
type
Optional
type
Possible values are :
ResourceElementCategory,
ConfigurationElementCategory,
WorkflowCategory,
PolicyTemplateCategory,
ScriptModuleCategory,
string
href
Optional
href
array of
string
path-ids
Optional
path-ids
404
Cannot find a category with the specified ID
Returns
WsCategory
of type(s)
application/json
"WsCategory Object"
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
description
Optional
description
string
path
Optional
path
string
type
Optional
type
Possible values are :
ResourceElementCategory,
ConfigurationElementCategory,
WorkflowCategory,
PolicyTemplateCategory,
ScriptModuleCategory,
string
href
Optional
href
array of
string
path-ids
Optional
path-ids
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/vco/api/categories/{id}
Category Service Operations
GET
Get Category
PUT
Update Category
POST
Add Child Category
DELETE
Delete Category
GET
List Categories
POST
Add Root Category