Get Policy

Get Policy

Get policy

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

The request is successful

Returns WsPolicy of type(s) application/json 
{
    "policy-item": [
        {
            "handlers": [
                {
                    "workflow": {
                        "customized-icon": false,
                        "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",
                                "description": "string",
                                "type": "string",
                                "value": {
                                    "objectType": "string"
                                },
                                "updated": false
                            }
                        ],
                        "version": "string",
                        "outputParameters": [
                            {
                                "scope": "string",
                                "name": "string",
                                "description": "string",
                                "type": "string",
                                "value": {
                                    "objectType": "string"
                                },
                                "updated": false
                            }
                        ]
                    },
                    "description": "string",
                    "type": "string",
                    "event-id": "string",
                    "script": "string"
                }
            ],
            "name": "string",
            "description": "string"
        }
    ],
    "startup": "string",
    "parameter": [
        {
            "scope": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "value": {
                "objectType": "string"
            },
            "updated": false
        }
    ],
    "name": "string",
    "description": "string",
    "href": "string",
    "state": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "rel": "string",
                "attribute": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "type": "string"
            }
        ]
    },
    "priority": "string"
}
array of WsPolicyItem
policy-item
Optional

policy-item

string
startup
Optional

startup

Possible values are : MANUAL, AUTOMATIC,
array of parameter
parameter
Optional

parameter

string
name
Optional

name

string
description
Optional

description

string
href
Optional

href

string
state
Optional

state

Relations
relations
Optional

relations

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

On This Page
Policy Service Operations
POST
Create Policy
DELETE
Delete Policy
GET
Get All Policies
GET
Get Policy