Add Root Category

Add Root Category
Add root category

Endpoint for adding categories in root.

Request
URI
POST
https://ip-42.net-99.vm.sof-mbu.broadcom.net/vco/api/categories
COPY
Request Body
category-context of type(s) application/json
Required 
{
    "categoryType": "string",
    "name": "string",
    "description": "string",
    "parent-category-id": "string"
}
string
categoryType
Optional

categoryType

Possible values are : ResourceElementCategory, ConfigurationElementCategory, WorkflowCategory, PolicyTemplateCategory, ScriptModuleCategory,
string
name
Optional

name

string
description
Optional

description

string
parent-category-id
Optional

parent-category-id

Authentication
This operation uses the following authentication methods.
Responses
201

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


400

Category name must be specified

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


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 name

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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/vco/api/categories
On This Page
Category Service Operations
GET
Get Category
PUT
Update Category
POST
Add Child Category
DELETE
Delete Category
GET
List Categories
POST
Add Root Category