Get Updates To the Request Form Of A Component In A Requested Blueprint

Get updates to the request form of a component in a requested blueprint, given a catalog request id and based on provided inputs. Example uses of this API include returning dynamic property value choices.

Request

URI

POST

https://{api_host}/composition-service/api/requests/catalog/{cafeRequestId}/hierarchy/{fieldPath}/form/{formType}/update

COPY

Path Parameters

string

cafeRequestId

Required

The id of the catalog request.

string

fieldPath

Required

The path of the component whose form to update.

string

formType

Required

The type of the request form.

Possible values are : composition.request.submission, composition.request.details,

Request Body

batchElementUpdateRequest2 of type(s) application/json

Optional

{
    "formValues": {
        "entries": [
            {
                "key": "string"
            }
        ]
    },
    "trigger": "string",
    "triggeredDetailsLayout": {
        "pages": [
            {
                "id": "string",
                "label": "string",
                "state": {
                    "dependencies": [
                        "string"
                    ],
                    "facets": [
                        {}
                    ]
                },
                "sections": [
                    {
                        "id": "string",
                        "label": "string",
                        "state": {
                            "dependencies": [
                                "string"
                            ],
                            "facets": [
                                {}
                            ]
                        },
                        "rows": [
                            {
                                "items": [
                                    {
                                        "size": 0
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "affectedElements": [
        "string"
    ]
}

literalMap

formValues

Required

formValues

string

trigger

Optional

trigger

layout

triggeredDetailsLayout

Optional

triggeredDetailsLayout

array of string

affectedElements

Optional

affectedElements

Responses

200

Success - return an ElementMetadataResponse containing changes to elements.

Returns formUpdateResponse of type(s) */*

{
    "elementUpdates": [
        {
            "permissibleValues": [
                {
                    "label": "string"
                }
            ],
            "extensionRendererContext": {
                "entries": [
                    {
                        "key": "string"
                    }
                ]
            },
            "facetValues": {
                "facets": [
                    {
                        "type": "string"
                    }
                ]
            },
            "id": "string",
            "detailLayout": {
                "pages": [
                    {
                        "id": "string",
                        "label": "string",
                        "state": {
                            "dependencies": [
                                "string"
                            ],
                            "facets": [
                                {}
                            ]
                        },
                        "sections": [
                            {
                                "id": "string",
                                "label": "string",
                                "state": {
                                    "dependencies": [
                                        "string"
                                    ],
                                    "facets": [
                                        {}
                                    ]
                                },
                                "rows": [
                                    {
                                        "items": [
                                            {
                                                "size": 0
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            },
            "errors": [
                "string"
            ]
        }
    ]
}

array of updateElementEntry

elementUpdates

Optional

elementUpdates

On This Page

Description

Request

Path Parameters

Request Body

Response

200 Response Body

Internal Api Operations