Field values
Last updated
Last updated
The examples below will take you through filling in the checklist of your record, for all kinds of checklists fields.
The value
attribute is a plaintext string.
Follow the same instructions as #adding-text to overwrite existing text.
The value
attribute is a numerical value.
Follow the same instructions as Filling a number to overwrite the existing number.
The value
attribute is either a string or an array of strings.
Follow the same instructions as Filling an option to overwrite the existing option(s).
The value
attribute is a date as a string, in the format yyyy-mm-dd
.
Follow the same instructions as Filling a date to overwrite the existing date.
You must first upload your file using the Upload file API. Then, you can attach it to the checklist using the file id and version id.
A comment (revision notes)
Data to copy over
Metadata
Checklist field values
Whether to use a custom signature or the default one
Whether to approve or reject
A comment
Your email and password
To add more values, the same API can be used. It will not overwrite existing values.
If you set linkAllVersions
to true
in Create new recordand Select existing record, all of the revisions of the linked record will also be automatically linked.
To link only a specific revision, you can remove that attribute from the payload.
See the above examples on how to fill the different types of fields.
Filling them when they are inside a form is exactly the same, but you will need to specify the formId query parameter when calling any of the APIs.
Use the API.
To clear all text, use the API and set the value
attribute to an empty string.
Use the API.
To delete the number, use the API and set the value
attribute to null
.
Use the API.
To delete all the options, use the API and set the value
attribute to []
or null
.
Use the API.
To delete the date, use the API and set the value
attribute to null
.
Use the API. The value
attribute is a JSON object or an array of JSON objects, representing either a user or a group.
Alternatively, you can use the API and specify a single user or group instead of all of them. This will effectively append a value to the existing values instead of overwriting them.
Use the API. The value
attribute is a JSON object representing the user or group you wish to delete
Use the API.
Use the API and set the value attribute to [] or null to delete all the files from the checklist field.
Alternatively, use the API to delete a single file from the checklist field.
Use the API. You do not need to send anything in the payload to generate the PDF.
Use the API. When creating a revision, you can specify the following options:
Use the API. When requesting an approval, you can specify users and groups that can sign the approval.
Use the API. When signing, you can specify the following options:
Use the API and set the revision
attribute to true
.
Use the API. The value
attribute would match the payload used in the API.
Use the API. The value
attribute is an array of record ID's. This will overwrite any existing records present in the field.
Alternatively, you can use the API and specify a single record ID. This will "append" a value to the existing values, without overwriting them.
To delete all the values, use the API and set the value
attribute to null
or []
.
To delete a single value, use the API and specify the value to be deleted in the payload.
Use the API. The value
attribute would match the payload used in the API.
Use the API. The value
attribute is an array of objects. This will overwrite any existing records present in the field.
Alternatively, you can use the API and specify a single record ID. This will "append" a value to the existing values, without overwriting them.
To delete a single value, use the API and specify the value to be deleted in the payload.
Use the API and specify the form template id.
The responses of and APIs for a form field will include two identifiers which might be confusing to distinguish.
Use the API and specify the form instance ID in the payload.