Get Form

Get Form

Retrieve the Form definition of a form with the specified ID.

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/form-service/api/forms/{id}
COPY
Path Parameters
string
id
Required

Form identifier

Query Parameters
string
formFormat
Optional
Constraints: default: JSON

Form definition format

Possible values are : YAML, JSON,
Authentication
This operation uses the following authentication methods.
Responses
200

'Success' with the form.

Returns FormDefinition of type(s) application/json 
{
    "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"
}
string
tenant
Optional

tenant

string As uuid As uuid
id
Optional

id

string
name
Required

name

string
form
Optional

form

string
styles
Optional

styles

string
sourceType
Optional

sourceType

string
sourceId
Optional

sourceId

string
type
Optional

type

string
status
Required

status

Possible values are : off, on, invalid, generated,
string As date-time As date-time
createdDate
Optional

createdDate

string As date-time As date-time
modifiedDate
Optional

modifiedDate

string
formFormat
Optional

formFormat

Possible values are : YAML, JSON,
string
providerRef
Optional

providerRef


403

'Forbidden' when the user has no user access rights.

Operation doesn't return any data structure

404

'Not found' if no form with the provided ID.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/form-service/api/forms/{id}
On This Page
Form Definition Operations
POST
Search Form Status
POST
Create Form
GET
Get Form
DELETE
Delete Form
GET
Search Form Definitions
GET
Get Form 1
GET
Search By Source And Type
DELETE
Delete Form 1