Get Context 1
Get the evaluation context of an item.
Request
URI
GET
https://{api_host}/vco/api/forms/{id}/{itemId}/evaluationContext
COPY
Path Parameters
string
id
Required
id
string
itemId
Required
itemId
Responses
200
The request is successful
Returns
FormEvaluationContext
of type(s)
application/json
{
"token": "string",
"actions": {
"actions": {
"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",
"module": "string",
"description": "string",
"version": "string",
"fqn": "string",
"script": "string",
"runtime": "string",
"outputParameterType": "string",
"href": "string",
"input-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
}
],
"output-type": "string",
"iconId": "string",
"bundleHasContent": false,
"runtimeMemoryLimit": 0,
"runtimeTimeout": 0,
"entryPoint": "string",
"actionEnvironmentId": "string",
"actionEnvironmentName": "string",
"validationMessage": "string"
}
},
"context": [
{
"id": "string",
"value": {},
"type": {
"dataType": "string",
"isMultiple": false,
"referenceType": "string",
"fields": [
"FieldDefinition Object"
]
}
}
],
"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
}
]
}
string
token
Optional
token
object
actions
Optional
actions
array of
object
context
Optional
context
array of
object
parameters
Optional
parameters
401
The user is not authorized
Returns
FormEvaluationContext
of type(s)
application/json
"FormEvaluationContext Object"
string
token
Optional
token
object
actions
Optional
actions
array of
object
context
Optional
context
array of
object
parameters
Optional
parameters
404
Can not find item evaluation context
Returns
FormEvaluationContext
of type(s)
application/json
"FormEvaluationContext Object"
string
token
Optional
token
object
actions
Optional
actions
array of
object
context
Optional
context
array of
object
parameters
Optional
parameters
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/vco/api/forms/{id}/{itemId}/evaluationContext