curl --request GET \
--url https://platform.kodexa.ai/api/data-forms/{id} \
--header 'x-api-key: <api-key>'{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"actions": [
{
"name": "<string>",
"properties": {},
"type": "<string>"
}
],
"cards": [
{
"children": "<array>",
"id": "<string>",
"properties": {},
"type": "<string>"
}
],
"views": [
{
"name": "<string>",
"properties": {}
}
]
},
"name": "<string>",
"publicAccess": true,
"slug": "<string>",
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": "<string>"
}Retrieves a single DataFormMetadata by its unique identifier. Data forms define structured data capture forms for documents.
curl --request GET \
--url https://platform.kodexa.ai/api/data-forms/{id} \
--header 'x-api-key: <api-key>'{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": {
"actions": [
{
"name": "<string>",
"properties": {},
"type": "<string>"
}
],
"cards": [
{
"children": "<array>",
"id": "<string>",
"properties": {},
"type": "<string>"
}
],
"views": [
{
"name": "<string>",
"properties": {}
}
]
},
"name": "<string>",
"publicAccess": true,
"slug": "<string>",
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": "<string>"
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Unique identifier (UUID) of the resource.
The DataFormMetadata
Data form metadata defines a structured data capture form for documents.
Optimistic locking version number.
Timestamp when the data form was created.
Whether this data form is deprecated.
Reference to the extension pack.
Unique identifier (UUID) for the data form.
Show child attributes
Display name of the data form.
Whether the data form is publicly accessible.
URL-friendly identifier for the data form.
Whether this data form is a template.
Timestamp when the data form was last updated.
Secondary UUID identifier.
Semantic version string.