List Form Fields By Script.

GET

/api/shape/csd/namespaces/{namespace}/scripts/{id}/formFields

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/scripts/example/formFields \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

List all the form fields for a script depending on start time and end time.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace.

id

required

string

ID script ID.

Query Parameters

start_time

string

X-required format: unix epoch timestamp in seconds fetch form fields whose timestamp >= start_time.

end_time

string

X-required format: unix epoch timestamp in seconds fetch form fields whose timestamp <= end_time.

Responses

200

A successful response.

Media typeapplication/json

ListFormFieldsByScriptResponse

Response to list form fields for input script.

object

form_fields

form_fields

List of form fields for input script depending on start time and end time.

Array<object>

FormFieldByScript

Form field information filtered by script.

object

first_read

first_read

Format: unix epoch timestamp in milliseconds First read time of the form field by the script.

string

<= 1024 characters

id

id

ID of the form field.

string

>= 1 <= 4094 <= 1024 characters

last_read

last_read

Format: unix epoch timestamp in milliseconds Last read time of the form field by the script.

string

<= 1024 characters

name

name

Name of the form field.

string

>= 6 characters <= 1024 characters

risk_level

risk_level

Risk level of the form field read by script.

string

<= 1024 characters

status

status

Status of the script.

string

>= 17 characters <= 1024 characters

total_size

total_size

Total size of scripts.

integer format: int32

Example^generated

{
  "form_fields": [
    {
      "first_read": "example",
      "id": "example",
      "last_read": "example",
      "name": "example",
      "risk_level": "example"
    }
  ],
  "status": "example",
  "total_size": 1
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

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

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example