Get External Value

Get a list of external values.

Request

URI

POST

https://{api_host}/blueprint/api/blueprints/form/external-value/sources

COPY

Request Body

FormExtValueSourceSearchRequest of type(s) application/json

Required

{
    "externalSource": "string",
    "filter": "string",
    "resultSize": 0,
    "valueType": {
        "dataType": "string",
        "fields": [
            {
                "constraints": {
                    "constraints": {
                        "constraints": {}
                    },
                    "matchConstraint": {
                        "match": {}
                    }
                },
                "default": {},
                "description": "string",
                "id": "string",
                "label": "string",
                "placeholder": "string",
                "refresh": {
                    "type": "string"
                },
                "shortValueName": [
                    "string"
                ],
                "signpost": "string",
                "step": "number",
                "type": "FormSchemaFieldType Object",
                "valueList": {},
                "valueTree": {}
            }
        ],
        "isMultiple": false,
        "referenceType": "string"
    }
}

string

externalSource

Optional

externalSource

string

filter

Optional

filter

integer As int32 As int32

resultSize

Optional

resultSize

object

valueType

Optional

valueType

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

'Success' with a list of external value results

Returns FormExtValueSourceSearchResponse of type(s) application/json

{
    "partialResult": false,
    "result": [
        {
            "category": "string",
            "description": "string",
            "fqn": "string",
            "inputParameters": [
                {
                    "paramName": "string",
                    "paramType": {
                        "dataType": "string",
                        "fields": [
                            "ComplexTypeField Object"
                        ],
                        "isMultiple": false,
                        "referenceType": "string"
                    }
                }
            ],
            "name": "string",
            "resultType": {
                "dataType": "string",
                "fields": [
                    "ComplexTypeField Object"
                ],
                "isMultiple": false,
                "referenceType": "string"
            }
        }
    ],
    "resultMaxSize": 0,
    "resultSize": 0,
    "resultTotalSize": 0
}

boolean

partialResult

Optional

partialResult

array of object

result

Optional

result

integer As int32 As int32

resultMaxSize

Optional

resultMaxSize

integer As int32 As int32

resultSize

Optional

resultSize

integer As int32 As int32

resultTotalSize

Optional

resultTotalSize

400

'Bad Request' if FormExtValueSourceSearchRequest is in invalid format

Returns FormExtValueSourceSearchResponse of type(s) application/json

{
    "partialResult": false,
    "result": [
        {
            "category": "string",
            "description": "string",
            "fqn": "string",
            "inputParameters": [
                {
                    "paramName": "string",
                    "paramType": {
                        "dataType": "string",
                        "fields": [
                            "ComplexTypeField Object"
                        ],
                        "isMultiple": false,
                        "referenceType": "string"
                    }
                }
            ],
            "name": "string",
            "resultType": {
                "dataType": "string",
                "fields": [
                    "ComplexTypeField Object"
                ],
                "isMultiple": false,
                "referenceType": "string"
            }
        }
    ],
    "resultMaxSize": 0,
    "resultSize": 0,
    "resultTotalSize": 0
}

boolean

partialResult

Optional

partialResult

array of object

result

Optional

result

integer As int32 As int32

resultMaxSize

Optional

resultMaxSize

integer As int32 As int32

resultSize

Optional

resultSize

integer As int32 As int32

resultTotalSize

Optional

resultTotalSize

403

'Forbidden' no forms viewer access rights

Returns FormExtValueSourceSearchResponse of type(s) application/json

"FormExtValueSourceSearchResponse Object"

boolean

partialResult

Optional

partialResult

array of object

result

Optional

result

integer As int32 As int32

resultMaxSize

Optional

resultMaxSize

integer As int32 As int32

resultSize

Optional

resultSize

integer As int32 As int32

resultTotalSize

Optional

resultTotalSize

404

Not Found

Returns FormExtValueSourceSearchResponse of type(s) application/json

"FormExtValueSourceSearchResponse Object"

boolean

partialResult

Optional

partialResult

array of object

result

Optional

result

integer As int32 As int32

resultMaxSize

Optional

resultMaxSize

integer As int32 As int32

resultSize

Optional

resultSize

integer As int32 As int32

resultTotalSize

Optional

resultTotalSize

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/blueprint/api/blueprints/form/external-value/sources

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Blueprint Form Operations

POST

Lookup External Resources

POST