Create Or Update Resource Action

Create Or Update Resource Action
Create resource action.

Create resource action.

Request
URI
POST
https://vcfa-10-162-161-9.vcfd.broadcom.net/form-service/api/custom/resource-actions
COPY
Query Parameters
boolean
generateUnvalidatableExternalValuesSchema
Optional

generateUnvalidatableExternalValuesSchema


Request Body
ResourceAction of type(s) application/json
Required
{
    "id": "string",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "providerName": "string",
    "resourceType": "string",
    "status": "string",
    "projectId": "string",
    "orgId": "string",
    "runnableItem": {
        "id": "string",
        "name": "string",
        "description": "string",
        "projectId": "string",
        "type": "string",
        "inputParameters": [
            {
                "type": "string",
                "name": "string",
                "description": "string"
            }
        ],
        "outputParameters": [
            {
                "type": "string",
                "name": "string",
                "description": "string"
            }
        ],
        "endpointLink": "string",
        "inputBindings": [
            {
                "inputKey": "string",
                "value": "string",
                "type": {
                    "dataType": "string",
                    "referenceType": "string",
                    "fields": [
                        {
                            "label": "string",
                            "description": "string",
                            "signpost": "string",
                            "type": "FormSchemaFieldType Object",
                            "step": "number",
                            "default": {},
                            "valueList": {},
                            "placeholder": "string",
                            "constraints": {
                                "matchConstraint": {
                                    "match": {}
                                },
                                "constraints": {
                                    "constraints": {}
                                }
                            },
                            "refresh": {
                                "type": "string"
                            },
                            "shortValueName": [
                                "string"
                            ],
                            "id": "string",
                            "valueTree": {}
                        }
                    ],
                    "isMultiple": false
                },
                "bindingAction": {
                    "actionName": "string",
                    "actionInputs": [
                        "Binding Object"
                    ]
                }
            }
        ]
    },
    "formDefinition": {
        "tenant": "string",
        "id": "string",
        "name": "string",
        "form": "string",
        "styles": "string",
        "sourceType": "string",
        "sourceId": "string",
        "type": "string",
        "status": "string",
        "createdDate": "string",
        "modifiedDate": "string",
        "formFormat": "string",
        "providerRef": "string",
        "externalSourceFormSchemas": [
            {
                "externalSourceId": "string",
                "parentId": "string",
                "elementId": "string",
                "elementType": "string",
                "facet": "string",
                "parameters": [
                    {
                        "validatable": false,
                        "name": "string",
                        "isValidatable": false
                    }
                ]
            }
        ]
    },
    "criteria": {
        "matchExpression": [
            {}
        ]
    }
}
string
id
Optional

id

string
name
Optional

name

string
displayName
Optional

displayName

string
description
Optional

description

string
providerName
Optional

providerName

string
resourceType
Optional

resourceType

string
status
Optional

status

Possible values are : released, draft,
string
projectId
Optional

projectId

string
orgId
Optional

orgId

object
runnableItem
Optional

Runnable item

object
formDefinition
Optional

formDefinition

object
criteria
Optional

criteria

Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with created/updated resource action

Returns ResourceAction of type(s) */*
{
    "id": "string",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "providerName": "string",
    "resourceType": "string",
    "status": "string",
    "projectId": "string",
    "orgId": "string",
    "runnableItem": {
        "id": "string",
        "name": "string",
        "description": "string",
        "projectId": "string",
        "type": "string",
        "inputParameters": [
            {
                "type": "string",
                "name": "string",
                "description": "string"
            }
        ],
        "outputParameters": [
            {
                "type": "string",
                "name": "string",
                "description": "string"
            }
        ],
        "endpointLink": "string",
        "inputBindings": [
            {
                "inputKey": "string",
                "value": "string",
                "type": {
                    "dataType": "string",
                    "referenceType": "string",
                    "fields": [
                        "ComplexTypeField Object"
                    ],
                    "isMultiple": false
                },
                "bindingAction": "BindingAction Object"
            }
        ]
    },
    "formDefinition": {
        "tenant": "string",
        "id": "string",
        "name": "string",
        "form": "string",
        "styles": "string",
        "sourceType": "string",
        "sourceId": "string",
        "type": "string",
        "status": "string",
        "createdDate": "string",
        "modifiedDate": "string",
        "formFormat": "string",
        "providerRef": "string",
        "externalSourceFormSchemas": [
            {
                "externalSourceId": "string",
                "parentId": "string",
                "elementId": "string",
                "elementType": "string",
                "facet": "string",
                "parameters": [
                    {
                        "validatable": false,
                        "name": "string",
                        "isValidatable": false
                    }
                ]
            }
        ]
    },
    "criteria": {
        "matchExpression": [
            {}
        ]
    }
}

400

'Bad Request' if ResourceAction is not in specified format

Operation doesn't return any data structure

403

'Forbidden' no resource action managing rights

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/form-service/api/custom/resource-actions