POST
Returns all Acro
The following example returns a contained fields in a given PDF document.
# Request:
curl --location --request POST 'https://trial.dsserver.io/documentprocessing/pdf/acroforms/fields' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer fePFHv8OtIyRSCAdOnn7USc9kKdYB2rg' \
--data-raw '"JVBERi0xLjY[..]="'
# Result:
[
{
"value": "",
"fieldName": "TextField1",
"alternateFieldName": "",
"fieldType": "FormTextField",
"bounds": {
"x": 2498,
"y": 13138,
"width": 7996,
"height": 440
}
},
{
"isChecked": false,
"fieldName": "Check Box2",
"alternateFieldName": "",
"fieldType": "FormCheckBox",
"bounds": {
"x": 3519,
"y": 12567,
"width": 7398,
"height": 360
}
}
]
Type | Value |
---|---|
string | The PDF document encoded as a Base64 string. |
Status | Type | Description |
---|---|---|
200 | Form |
On success, the HTTP status code in the response header is 200 (OK). The response body contains an array of Form |
Name | Type | Value | Optional |
---|---|---|---|
alternate |
String | The alternate field name. | yes |
field |
String | The field name. | yes |
field |
String | The field type. | yes |
bounds | Rectangle | The rectangle bounds of the field in the document in points. | yes |
Form |
Inherited object. See description below. | yes | |
Form |
Inherited object. See description below. | yes | |
Form |
Inherited object. See description below. | yes | |
Form |
Inherited object. See description below. | yes | |
Form |
Inherited object. See description below. | yes | |
Form |
Inherited object. See description below. | yes |
Name | Type | Value | Optional |
---|---|---|---|
x | Integer | The horizontal position of the rectangle. | no |
y | Integer | The vertical position of the rectangle. | no |
width | Integer | The width of the rectangle. | no |
height | Integer | The height of the rectangle. | no |
Name | Type | Value | Optional |
---|---|---|---|
is |
Boolean | Specifies whether the check box is checked or not. | yes |
Name | Type | Value | Optional |
---|---|---|---|
options | String[] | Gets or sets the option elements of a choice field. | yes |
can |
Boolean | Specifies whether a field can be edited. | yes |
sort | Boolean | Specifies whether the list can be sorted. | yes |
multi |
Boolean | Specifies whether multiple options can be selected. | yes |
do |
Boolean | Specifies whether spell checking is enabled or not. | yes |
commit |
Boolean | Specifies whether the form is submitted when the selected is changed. | yes |
value | String | Gets or sets the selected value of a choice list. | yes |
Name | Type | Value | Optional |
---|---|---|---|
options | String[] | Gets or sets the option elements of a choice field. | yes |
can |
Boolean | Specifies whether a field can be edited. | yes |
sort | Boolean | Specifies whether the list can be sorted. | yes |
multi |
Boolean | Specifies whether multiple options can be selected. | yes |
do |
Boolean | Specifies whether spell checking is enabled or not. | yes |
commit |
Boolean | Specifies whether the form is submitted when the selected is changed. | yes |
value | String | Gets or sets the selected value of a choice list. | yes |
Name | Type | Value | Optional |
---|---|---|---|
options | String[] | Gets or sets the option elements of a choice field. | yes |
can |
Boolean | Specifies whether a field can be edited. | yes |
sort | Boolean | Specifies whether the list can be sorted. | yes |
multi |
Boolean | Specifies whether multiple options can be selected. | yes |
do |
Boolean | Specifies whether spell checking is enabled or not. | yes |
commit |
Boolean | Specifies whether the form is submitted when the selected is changed. | yes |
value | String | Gets or sets the selected value of a choice list. | yes |
Status | Description |
---|---|
401 | A 401 (Unauthorized) is returned, if the user is not authorized. |
400 | A 400 (Bad Request) is returned, if DS Server is not licensed or the license is invalid. |
400 | A 400 (Bad Request) is returned, if no fields are found in the PDF document. |
400 | A 400 (Bad Request) is returned, if the uploaded document is not valid. |