Lookup External Resources

Retrieve external resource value depending on provided value source type

Request

URI

POST

https://vra-interop-222-139.lvn.broadcom.net/form-service/api/forms/renderer/external-resources

COPY

Request Body

FormExtValueRequest of type(s) application/json

Required

{
    "item": {
        "id": "string",
        "label": "string",
        "type": "string",
        "value": "string",
        "description": "string"
    },
    "filter": "string",
    "valueSource": {
        "id": "string",
        "type": "string",
        "parameters": [
            {
                "$type": {
                    "dataType": "string",
                    "referenceType": "string",
                    "fields": [
                        "ComplexTypeField Object"
                    ],
                    "isMultiple": false
                }
            }
        ],
        "isPageable": false,
        "externalSourceProviderType": "string"
    },
    "valueType": {
        "dataType": "string",
        "referenceType": "string",
        "fields": [
            "ComplexTypeField Object"
        ],
        "isMultiple": false
    },
    "context": {
        "context": {
            "dataType": "string",
            "value": "string"
        }
    },
    "projectId": "string"
}

object

item

Optional

item

string

filter

Optional

filter

object

valueSource

Optional

valueSource

object

valueType

Optional

valueType

object

context

Optional

context

string

projectId

Optional

projectId

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

'Success' with list of external resources matching search criteria

Returns FormExtValueResponseObject of type(s) application/json

"FormExtValueResponseObject Object"

array of object

items

Optional

items

integer As int32 As int32

totalCount

Optional

totalCount

string

error

Optional

error

400

'Bad Request' if external value request is in invalid format

Returns FormExtValueResponseObject of type(s) application/json

"FormExtValueResponseObject Object"

array of object

items

Optional

items

integer As int32 As int32

totalCount

Optional

totalCount

string

error

Optional

error

403

'Forbidden' no forms viewer access rights

Returns FormExtValueResponseObject of type(s) application/json

"FormExtValueResponseObject Object"

array of object

items

Optional

items

integer As int32 As int32

totalCount

Optional

totalCount

string

error

Optional

error

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/form-service/api/forms/renderer/external-resources

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Form Renderer Operations

POST

Fetch Form

POST