Skip to content

GET Form Field.

GET
/api/shape/csd/namespaces/{namespace}/formFields/{id}
curl --request GET \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/csd/namespaces/example/formFields/example \
--header 'Authorization: <Authorization>'

GET form field for the name of the form field.

Examples of this operation.

namespace
required
string

Namespace Namespace.

id
required
string

ID ID of the form field.

A successful response.

Media typeapplication/json
GetFormFieldResponse

Response to GET form field.

object
associated_scripts
associated_scripts

Associated scripts of the form field.

Array<string>
id
id

ID of the form field.

string
>= 1 <= 4094 <= 1024 characters
name
name

Name of the form field.

string
>= 6 characters <= 1024 characters
Examplegenerated
{
"associated_scripts": [
"example"
],
"id": "example",
"name": "example"
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example