Get Policy
Get policy
Request
URI
GET
https://{api_host}/vco/api/policies/{id}
COPY
Path Parameters
string
id
Required
id
Responses
200
The request is successful
Returns
WsPolicy
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"
}
]
},
"name": "string",
"description": "string",
"parameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"priority": "string",
"startup": "string",
"state": "string",
"id": "string",
"href": "string",
"policy-items": [
{
"name": "string",
"description": "string",
"event-source": {},
"event-handler": [
{
"bindings": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
],
"type": "string",
"eventId": "string",
"script": "string",
"runtime": "string",
"workflow": {
"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",
"version": "string",
"description": "string",
"href": "string",
"schema-workflow": {
"description": "string",
"position": {
"y": "number",
"x": "number"
},
"input": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"output": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"attrib": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
},
"schemaLocation": "string",
"id": "string",
"version": "string",
"restartMode": 0,
"resumeFromFailedMode": 0,
"display-name": "string",
"category-id": "string",
"ref-types": "string",
"error-handler": [
{
"position": {
"y": "number",
"x": "number"
},
"name": "string",
"throw-bind-name": "string"
}
],
"workflow-item": [
{
"description": "string",
"position": {
"y": "number",
"x": "number"
},
"runtime": "string",
"script": {
"encoded": false,
"text": "string"
},
"conditions": {
"condition": [
{
"name": "string",
"type": "string",
"comparator": "string",
"label": "string",
"text": "string"
}
]
},
"condition": [
{
"name": "string",
"type": "string",
"comparator": "string",
"label": "string",
"text": "string"
}
],
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
},
"name": "string",
"type": "string",
"color": "string",
"interaction": "string",
"comparator": 0,
"environment": {
"id": "string",
"name": "string"
},
"display-name": "string",
"in-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"out-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"iteration-catch-block": {
"script": {
"encoded": false,
"text": "string"
}
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"name": "string",
"linked-workflow-id": "string",
"display-name": "string",
"in-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"out-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
}
}
]
},
"out-name": "string",
"alt-out-name": "string",
"catch-name": "string",
"throw-bind-name": "string",
"end-mode": "string",
"script-module": "string",
"business-status": "string",
"prototype-id": "string",
"content-mode": "string",
"launched-workflow-id": "string",
"linked-workflow-id": "string",
"validation-message": "string"
}
],
"workflow-note": [
{
"description": "string",
"x": "number",
"y": "number",
"w": "number",
"h": "number",
"color": "string"
}
],
"root-name": "string",
"object-name": "string",
"icon-id": "string",
"api-version": "string",
"allowed-operations": "string",
"editor-version": "string"
},
"inputParameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"outputParameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"customized-icon": false,
"category-id": "string"
},
"id": "string",
"environment": {
"id": "string",
"name": "string"
},
"min-value": "number",
"max-value": "number",
"validation-message": "string"
}
]
}
],
"event-handler": [
{
"bindings": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
],
"type": "string",
"eventId": "string",
"script": "string",
"runtime": "string",
"workflow": {
"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",
"version": "string",
"description": "string",
"href": "string",
"schema-workflow": {
"description": "string",
"position": {
"y": "number",
"x": "number"
},
"input": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"output": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"attrib": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
},
"schemaLocation": "string",
"id": "string",
"version": "string",
"restartMode": 0,
"resumeFromFailedMode": 0,
"display-name": "string",
"category-id": "string",
"ref-types": "string",
"error-handler": [
{
"position": {
"y": "number",
"x": "number"
},
"name": "string",
"throw-bind-name": "string"
}
],
"workflow-item": [
{
"description": "string",
"position": {
"y": "number",
"x": "number"
},
"runtime": "string",
"script": {
"encoded": false,
"text": "string"
},
"conditions": {
"condition": [
{
"name": "string",
"type": "string",
"comparator": "string",
"label": "string",
"text": "string"
}
]
},
"condition": [
{
"name": "string",
"type": "string",
"comparator": "string",
"label": "string",
"text": "string"
}
],
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
},
"name": "string",
"type": "string",
"color": "string",
"interaction": "string",
"comparator": 0,
"environment": {
"id": "string",
"name": "string"
},
"display-name": "string",
"in-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"out-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"iteration-catch-block": {
"script": {
"encoded": false,
"text": "string"
}
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"name": "string",
"linked-workflow-id": "string",
"display-name": "string",
"in-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
},
"out-binding": {
"bind": [
{
"description": "string",
"name": "string",
"type": "string",
"export-name": "string"
}
]
}
}
]
},
"out-name": "string",
"alt-out-name": "string",
"catch-name": "string",
"throw-bind-name": "string",
"end-mode": "string",
"script-module": "string",
"business-status": "string",
"prototype-id": "string",
"content-mode": "string",
"launched-workflow-id": "string",
"linked-workflow-id": "string",
"validation-message": "string"
}
],
"workflow-note": [
{
"description": "string",
"x": "number",
"y": "number",
"w": "number",
"h": "number",
"color": "string"
}
],
"root-name": "string",
"object-name": "string",
"icon-id": "string",
"api-version": "string",
"allowed-operations": "string",
"editor-version": "string"
},
"inputParameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"outputParameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"customized-icon": false,
"category-id": "string"
},
"id": "string",
"environment": {
"id": "string",
"name": "string"
},
"min-value": "number",
"max-value": "number",
"validation-message": "string"
}
],
"started-by": "string",
"running-instance-id": "string"
}
object
relations
Optional
relations
string
name
Required
Constraints:
minLength: 1
maxLength: 100
name
string
description
Optional
Constraints:
minLength: 0
maxLength: 1024
description
array of
object
parameters
Optional
parameters
string
priority
Optional
priority
Possible values are :
very-low,
low,
medium,
high,
very-high,
string
startup
Optional
startup
Possible values are :
manual,
automatic,
string
state
Optional
state
Possible values are :
started,
stopped,
stopping,
starting,
string
id
Optional
id
string
href
Optional
href
array of
object
policy-items
Optional
policy-items
array of
object
event-handler
Optional
event-handler
string
started-by
Optional
started-by
string
running-instance-id
Optional
running-instance-id
401
The user is not authorized
Returns
WsPolicy
of type(s)
application/json
"WsPolicy Object"
object
relations
Optional
relations
string
name
Required
Constraints:
minLength: 1
maxLength: 100
name
string
description
Optional
Constraints:
minLength: 0
maxLength: 1024
description
array of
object
parameters
Optional
parameters
string
priority
Optional
priority
Possible values are :
very-low,
low,
medium,
high,
very-high,
string
startup
Optional
startup
Possible values are :
manual,
automatic,
string
state
Optional
state
Possible values are :
started,
stopped,
stopping,
starting,
string
id
Optional
id
string
href
Optional
href
array of
object
policy-items
Optional
policy-items
array of
object
event-handler
Optional
event-handler
string
started-by
Optional
started-by
string
running-instance-id
Optional
running-instance-id
404
Cannot find a policy with the specified ID or the user does not have 'read' rights over it
Returns
WsPolicy
of type(s)
application/json
"WsPolicy Object"
object
relations
Optional
relations
string
name
Required
Constraints:
minLength: 1
maxLength: 100
name
string
description
Optional
Constraints:
minLength: 0
maxLength: 1024
description
array of
object
parameters
Optional
parameters
string
priority
Optional
priority
Possible values are :
very-low,
low,
medium,
high,
very-high,
string
startup
Optional
startup
Possible values are :
manual,
automatic,
string
state
Optional
state
Possible values are :
started,
stopped,
stopping,
starting,
string
id
Optional
id
string
href
Optional
href
array of
object
policy-items
Optional
policy-items
array of
object
event-handler
Optional
event-handler
string
started-by
Optional
started-by
string
running-instance-id
Optional
running-instance-id
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/vco/api/policies/{id}
Policy Service Operations
GET
Get Policy
PUT
Update Policy
DELETE
Delete Policy
GET
Get Policy State
PUT
Update Policy State
GET
Get Policy Template
PUT
Update Policy Template
DELETE
Delete Policy Template
GET
Get All Policies
POST
Create Policy
GET
Get All Policy Templates
POST
Create Policy Template
GET
Get Policy Logs
GET
Find Policy Template Usages
GET
Find Policy Template Dependencies
GET
Get Policies For State