Skip to content
API Enriched

List All Form Fields.

POST
/api/shape/csd/namespaces/{namespace}/formFields
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/csd/namespaces/example/formFields \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "filters": { "form_field_analysis_filter": { "analysis_strings": [ "example" ], "op": "IN" }, "form_field_name_filter": { "name_strings": [ "example" ], "op": "IN" } }, "namespace": "example", "page_number": 1, "page_size": 1, "page_token": "example", "sorts": [ { "field": "example", "order": "DESCENDING" } ], "start_time": "example" }'

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

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ListFormFieldsRequest

Request to list form fields of all the scripts.

object
end_time
end_time

Format: unix epoch timestamp in seconds fetch form fields whose timestamp <= end_time Required: YES.

string
<= 1024 characters
filters
object
form_field_analysis_filter
object
analysis_strings
Script Status Strings

An unordered list of script status strings Required: YES.

Array<string>
>= 1 items <= 10 items
op
string
default: IN
Allowed values: IN
form_field_name_filter
object
name_strings
Script Name Strings

An unordered list of form field name strings Required: YES.

Array<string>
>= 1 items <= 64 items
op
string
default: IN
Allowed values: IN
namespace
namespace

Namespace

string
>= 6 characters <= 1024 characters
page_number
page_number

One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.

integer format: int32
page_size
page_size

The maximum number of scripts to return per page.

integer format: int32
page_token
page_token

Page_token is the value of listformfieldsresponse.next_page_token from previous request.

string
<= 1024 characters
sorts
sorts

Additional sort criteria.

Array<object>
Sort

API query sort criteria.

object
field
Sort field

Field specification or configuration

string
<= 1024 characters
order
string
default: DESCENDING
Allowed values: DESCENDING ASCENDING
start_time
start_time

Format: unix epoch timestamp in seconds fetch form fields whose timestamp >= start_time Required: YES.

string
<= 1024 characters

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
ListFormFieldsResponse

Response to list form fields of all the scripts.

object
form_fields
form_fields

List of form fields for all the scripts.

Array<object>
FormField

Form field info of all the scripts.

object
analysis
object
updated_by
updated_by

Updated by.

string
<= 1024 characters
value
value

Value of the form field analysed by Client side defense.

string
>= 3 characters <= 1024 characters
associated_scripts
associated_scripts

Associated script which read the form field first.

Array<string>
first_read
first_read

Format: unix epoch timestamp in milliseconds First read time.

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.

string
<= 1024 characters
locations
locations

Locations where the form field is present.

Array<string>
name
name

Name of the form field.

string
>= 6 characters <= 1024 characters
next_page_token
next_page_token

Opaque value passed back alone with the additional calls. All filtering will stay the same.

string
<= 1024 characters
page_number
page_number

One-indexed page number.

integer format: int32
page_size
page_size

The maximum number of scripts to return per page.

integer format: int32
total_count
total_count

Total count of scripts available at time of query, and subject to change across queries.

integer format: int32
total_pages
total_pages

Total number of pages available depending upon requested page_size.

integer format: int32
total_size
total_size

Total size of scripts.

integer format: int32
Examplegenerated
{
  "form_fields": [
    {
      "analysis": {
        "updated_by": "example",
        "value": "example"
      },
      "associated_scripts": [
        "example"
      ],
      "first_read": "example",
      "id": "example",
      "last_read": "example",
      "locations": [
        "example"
      ],
      "name": "example"
    }
  ],
  "next_page_token": "example",
  "page_number": 1,
  "page_size": 1,
  "total_count": 1,
  "total_pages": 1,
  "total_size": 1
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example