Get Form By parent and type

Get Form By parent and type

Retrieve the details of a specified Form.

Request
URI
GET
https://{api_host}/forms-service/api/forms/parent/{parent}/type/{type}
COPY
Path Parameters
string
parent
Required

The id of the parent object.

string
type
Required

The type of the form.


Responses
200

'Success' with the Form

Returns formDefinition of type(s) */*
{
    "parent": "string",
    "form": {
        "designerLayout": {
            "pages": [
                {
                    "id": "string",
                    "label": "string",
                    "state": {
                        "dependencies": [
                            "string"
                        ],
                        "facets": [
                            {}
                        ]
                    },
                    "sections": [
                        {
                            "designerHidden": false,
                            "id": "string",
                            "label": "string",
                            "state": {
                                "dependencies": [
                                    "string"
                                ],
                                "facets": [
                                    {}
                                ]
                            },
                            "rows": [
                                {
                                    "items": [
                                        {
                                            "size": 0
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "name": "string"
    },
    "formTypeData": {
        "formData": "string",
        "type": "string"
    },
    "name": "string",
    "formData": "string",
    "styles": "string",
    "id": "string",
    "type": "string",
    "tenant": "string"
}
string
parent
Optional

parent

form
Optional

form

formTypeData
Optional

formTypeData

string
name
Required

name

string
formData
Optional

formData

string
styles
Optional

styles

string As uuid As uuid
id
Optional

id

string
type
Optional

type

string
tenant
Optional

tenant


404

'Not found' if no Form with provided parent and type

Operation doesn't return any data structure