Perform External Validation

Perform External Validation
Perform external validations for a form (for the UI)

Perform external validations for a form (for the UI)

Request
URI
POST
https://vcf-stls-wcp-pod13-137.lvn.broadcom.net/workitem/api/workitems/external-validation
COPY
Query Parameters
string
projectId
Optional

The projectId of the project chosen for the request.

string
sourceId
Optional

sourceId

Request Body
ExternalValidationContext of type(s) application/json
Required 
{
    "context": {
        "context": {
            "dataType": "string",
            "value": "string"
        }
    },
    "externalValidations": [
        {
            "label": "string",
            "source": {
                "externalSourceProviderType": "string",
                "id": "string",
                "isPageable": false,
                "parameters": [
                    {
                        "$type": {
                            "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"
                        },
                        "parameterMap": {
                            "parameterMap": {}
                        }
                    }
                ],
                "type": "string"
            },
            "target": [
                "string"
            ]
        }
    ]
}
object
context
Optional

context

array of object
externalValidations
Optional

externalValidations

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with list of validation messages

[
    {
        "fieldId": "string",
        "message": "string",
        "severity": "string",
        "validationType": "string"
    }
]
array of object
Optional

400

'Bad Request' if the external validation context body is not in specified format

[
    {
        "fieldId": "string",
        "message": "string",
        "severity": "string",
        "validationType": "string"
    }
]
array of object
Optional

403

'Forbidden' no approval access rights

[
    "FormValidationMessage Object"
]
array of FormValidationMessage
Optional

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/workitem/api/workitems/external-validation
On This Page
Work Item Service Operations
GET
Get Work Items
GET
Get Work Items For Deployment
GET
Lookup External Resource
POST
Lookup External Resources
POST
Perform External Validation
POST
Execute External Actions
GET
Get Work Items For Deployment Request
GET
Get Work Item By Id
POST
Answer Work Item
POST
Reject Work Item