Field Data

You can get field data values from a drawing with the following APIs.

Get Drawing Field Data

Get field data value by drawing id.

GET https://api.arcsite.com/v1/drawings/<id>/field_data

curl "https://api.arcsite.com/v1/drawings/<ID>/field_data" \
  -H "Authorization: Bearer your_api_token_here"

const response = await fetch("https://api.arcsite.com/v1/drawings/<ID>/field_data", {
  headers: {
    Authorization: "Bearer your_api_token_here",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.arcsite.com/v1/drawings/<ID>/field_data",
    headers={"Authorization": "Bearer your_api_token_here"},
)
data = response.json()

{
  "groups": [
    {
      "name": "Default Group",
      "field_data": [
        {
          "name": "Property Address",
          "type": "TEXT",
          "value": "Address 1, Address 2"
        },
        {
          "name": "No Visible Evidence",
          "type": "SWITCH",
          "value": true
        },
        {
          "name": "Sign by Seller(s) or Owner",
          "type": "SELECT",
          "value": ["Seller(s)"]
        }
      ]
    }
  ]
}

Query Parameters

Parameter	Type	In	Description
drawing_version_id	String (optional)	query	The ID of the drawing version. A version of another drawing returns `404`.

Response Schema

Name	Type	Description
groups	List[Group]	List of field data groups in the drawing

Group

Name	Type	Description
name	String	The name of the field data group
field_data	List[FieldData]	List of field data items within this group

FieldData

Name	Type	Description
name	String	The name of the field
type	String	The type of the field. One of `TEXT`, `PARAGRAPH`, `SELECT`, `SWITCH`, `DATETIME`.
value	Any	The value of the field. The data type depends on the field type: String for TEXT/PARAGRAPH/DATETIME, Boolean for SWITCH, Array of Strings for SELECT