Get Policy
Get policy
Request
URI
GET
https://{api_host}/vco/api/policies/{id}
COPY
Path Parameters
string
Responses
200
The request is successful
Returns policy of type(s) application/json
{
"policy-item": [
{
"name": "string",
"description": "string",
"eventHandlers": [
{
"eventId": "string",
"workflow": {
"customized-icon": false,
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": false
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": false
},
"linked-workflow-id": "string",
"comparator": 0,
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": 0,
"resumeFromFailedMode": 0,
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
]
},
"min-value": "number",
"bindings": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"description": "string",
"type": "string",
"script": "string",
"max-value": "number"
}
]
}
],
"startup": "string",
"parameter": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"name": "string",
"description": "string",
"eventHandlers": [
{
"eventId": "string",
"workflow": {
"customized-icon": false,
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": false
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": false
},
"linked-workflow-id": "string",
"comparator": 0,
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": 0,
"resumeFromFailedMode": 0,
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"name": "string",
"description": "string",
"href": "string",
"id": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"inputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
]
},
"min-value": "number",
"bindings": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"description": "string",
"type": "string",
"script": "string",
"max-value": "number"
}
],
"href": "string",
"state": "string",
"id": "string",
"started-by": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
},
"priority": "string"
}string
startup
Optional
startup
Possible values are : MANUAL, AUTOMATIC,
string
name
Required
name
string
description
Optional
description
string
href
Optional
href
string
state
Optional
state
Possible values are : STARTED, STOPPED, STOPPING, STARTING,
string
id
Optional
id
string
started-by
Optional
started-by
string
priority
Optional
priority
Possible values are : VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH,
401
The user is not authorized
Operation doesn't return any data structure
404
Cannot find a policy with the specified ID or the user does not have 'read' rights over it
Operation doesn't return any data structure
Policy Service Operations
POST
Create Policy
POST
Create Policy Template
DELETE
Delete Policy
DELETE
Delete Policy Template
GET
Get All Policies
GET
Get All Policy Templates
GET
Get Policies For State
GET
Get Policy
GET
Get Policy Logs
GET
Get Policy State
GET
Get Policy Template
PUT
Update Policy Template