Get Category

Get Category

Endpoint for retrieving details for a category.

Request
URI
GET
https://{api_host}/vco/api/categories/{id}
COPY
Path Parameters
string
Required
Responses
200

The request is successful

Returns category of type(s) application/json 
{
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "attribute": [
                    {
                        "displayValue": "string",
                        "value": "string",
                        "name": "string"
                    }
                ],
                "href": "string",
                "type": "string",
                "rel": "string"
            }
        ]
    },
    "id": "string",
    "name": "string",
    "description": "string",
    "path": "string",
    "type": "string"
}
string
href
Optional

href

Relations
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, ScriptModuleCategory,

401

User is not authorized

Operation doesn't return any data structure

404

Cannot find a category with the specified ID

Operation doesn't return any data structure

On This Page
Category Service Operations
POST
Add Child Category
POST
Add Root Category
DELETE
Delete Category
DELETE
Delete Permission Rule
DELETE
Delete Permissions For Object
GET
Get Category
GET
Get Permission Rule
GET
Get Permissions For Object
POST
Insert Permissions For Object
GET
List Categories
PUT
Update Permission Rule