Query for external field values like VRO inventory objects Or any kind Of objects return As A result Of VRO action execution.

This operation can be used to search for vRO inventory objects or any kind of resources and returns a list of [value:label] elements and count of all elements.

Request

URI

POST

https://{api_host}/forms-service/api/externalvalues/search

COPY

Request Body

FormExtValueRequest of type(s) application/json

Optional

{
    "filter": "string",
    "valueType": {
        "dataType": "string",
        "referenceType": "string",
        "isMultiple": false,
        "fields": [
            "ComplexTypeField Object"
        ]
    },
    "valueSource": {
        "id": "string",
        "type": "string",
        "parameters": [
            {}
        ]
    }
}

string

filter

Optional

filter

FormSchemaFieldType

valueType

Optional

valueType

object

context

Optional

context

ExternalValueSource

valueSource

Optional

valueSource

Responses

200

'Success' with the Action Search

Returns RestEntity of type(s) */*

{
    "setLocation": false,
    "httpStatus": "string"
}

boolean

setLocation

Optional

setLocation

string

httpStatus

Optional

httpStatus

Possible values are : CONTINUE, SWITCHING_PROTOCOLS, PROCESSING, CHECKPOINT, OK, CREATED, ACCEPTED, NON_AUTHORITATIVE_INFORMATION, NO_CONTENT, RESET_CONTENT, PARTIAL_CONTENT, MULTI_STATUS, ALREADY_REPORTED, IM_USED, MULTIPLE_CHOICES, MOVED_PERMANENTLY, FOUND, MOVED_TEMPORARILY, SEE_OTHER, NOT_MODIFIED, USE_PROXY, TEMPORARY_REDIRECT, PERMANENT_REDIRECT, BAD_REQUEST, UNAUTHORIZED, PAYMENT_REQUIRED, FORBIDDEN, NOT_FOUND, METHOD_NOT_ALLOWED, NOT_ACCEPTABLE, PROXY_AUTHENTICATION_REQUIRED, REQUEST_TIMEOUT, CONFLICT, GONE, LENGTH_REQUIRED, PRECONDITION_FAILED, PAYLOAD_TOO_LARGE, REQUEST_ENTITY_TOO_LARGE, URI_TOO_LONG, REQUEST_URI_TOO_LONG, UNSUPPORTED_MEDIA_TYPE, REQUESTED_RANGE_NOT_SATISFIABLE, EXPECTATION_FAILED, I_AM_A_TEAPOT, INSUFFICIENT_SPACE_ON_RESOURCE, METHOD_FAILURE, DESTINATION_LOCKED, UNPROCESSABLE_ENTITY, LOCKED, FAILED_DEPENDENCY, UPGRADE_REQUIRED, PRECONDITION_REQUIRED, TOO_MANY_REQUESTS, REQUEST_HEADER_FIELDS_TOO_LARGE, INTERNAL_SERVER_ERROR, NOT_IMPLEMENTED, BAD_GATEWAY, SERVICE_UNAVAILABLE, GATEWAY_TIMEOUT, HTTP_VERSION_NOT_SUPPORTED, VARIANT_ALSO_NEGOTIATES, INSUFFICIENT_STORAGE, LOOP_DETECTED, BANDWIDTH_LIMIT_EXCEEDED, NOT_EXTENDED, NETWORK_AUTHENTICATION_REQUIRED,

object

httpHeaders

Optional

httpHeaders

object

body

Optional

body

400

Invalid request - bad data.

Operation doesn't return any data structure

403