Skip to main content
POST
/
api
/
dataForms
/
{organizationSlug}
cURL
curl --request POST \
  --url http://localhost/api/dataForms/{organizationSlug} \
  --header 'Content-Type: application/json' \
  --data '{
  "ref": "<string>",
  "template": true,
  "orgSlug": "<string>",
  "slug": "<string>",
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "version": "<string>",
  "get_id": "<string>",
  "publicAccess": true,
  "imageUrl": "<string>",
  "icon": "<string>",
  "overviewMarkdown": "<string>",
  "provider": "<string>",
  "providerUrl": "<string>",
  "providerImageUrl": "<string>",
  "deleteProtection": true,
  "checksum": "<string>",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "entrypoints": [
    "<string>"
  ],
  "options": [
    {
      "groupOptions": [
        {}
      ],
      "properties": {},
      "tabName": "<string>",
      "name": "<string>",
      "aliases": [
        "<string>"
      ],
      "label": "<string>",
      "falseLabel": "<string>",
      "hint": "<string>",
      "required": true,
      "type": "<string>",
      "subType": "<string>",
      "listType": "<string>",
      "displayProperties": {},
      "listLabel": "<string>",
      "listDescription": "<string>",
      "featureFlag": "<string>",
      "default": {},
      "description": "<string>",
      "supportArticle": "<string>",
      "overviewMarkdown": "<string>",
      "showIf": "<string>",
      "developerOnly": true,
      "showOnPopup": true,
      "possibleValues": [
        {
          "label": "<string>",
          "value": {},
          "description": "<string>"
        }
      ]
    }
  ],
  "cards": [
    {
      "id": "<string>",
      "type": "<string>",
      "properties": {},
      "children": [
        {}
      ]
    }
  ]
}'
{
  "ref": "<string>",
  "template": true,
  "orgSlug": "<string>",
  "slug": "<string>",
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "version": "<string>",
  "get_id": "<string>",
  "publicAccess": true,
  "imageUrl": "<string>",
  "icon": "<string>",
  "overviewMarkdown": "<string>",
  "provider": "<string>",
  "providerUrl": "<string>",
  "providerImageUrl": "<string>",
  "deleteProtection": true,
  "checksum": "<string>",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "entrypoints": [
    "<string>"
  ],
  "options": [
    {
      "groupOptions": [
        {}
      ],
      "properties": {},
      "tabName": "<string>",
      "name": "<string>",
      "aliases": [
        "<string>"
      ],
      "label": "<string>",
      "falseLabel": "<string>",
      "hint": "<string>",
      "required": true,
      "type": "<string>",
      "subType": "<string>",
      "listType": "<string>",
      "displayProperties": {},
      "listLabel": "<string>",
      "listDescription": "<string>",
      "featureFlag": "<string>",
      "default": {},
      "description": "<string>",
      "supportArticle": "<string>",
      "overviewMarkdown": "<string>",
      "showIf": "<string>",
      "developerOnly": true,
      "showOnPopup": true,
      "possibleValues": [
        {
          "label": "<string>",
          "value": {},
          "description": "<string>"
        }
      ]
    }
  ],
  "cards": [
    {
      "id": "<string>",
      "type": "<string>",
      "properties": {},
      "children": [
        {}
      ]
    }
  ]
}

Path Parameters

​
organizationSlug
string
required

Query Parameters

​
templateRef
string
required
​
projectId
string

Body

application/json

A data form is a way to allow validation and editing of data extracted from a document

​
orgSlug
string
required

The slug of the organization that owns this metadata object

​
slug
string
required

The slug used when referencing this metadata object

​
type
string
required

The type of metadata object

​
name
string
required

The name of the object

​
version
string
required

The version of the object

​
ref
string

The reference to the metadata object

​
template
boolean

Is this component a template that can be used to create new components

​
description
string

The description of the object

​
get_id
string

An internal identifier (not for public use)

​
publicAccess
boolean

Is the metadata object publicly accessible by other organizations

​
imageUrl
string

URL of image when presenting this object in a UI

​
icon
string

Material Icon name to use in the UI

​
overviewMarkdown
string

Markdown that is used to present the overview of the object

​
provider
string

The details of the of provider

​
providerUrl
string

The link to the provider website

​
providerImageUrl
string

The link to the model image

​
deleteProtection
boolean

Delete protection status

​
checksum
string

The checksum of the metadata, calculated by the platform and used to determine if the metadata has changed

​
deprecated
boolean

The resource is marked for deprecation

​
extensionPackRef
string

The reference to the extension pack (if the metadata object was created by an extension pack)

​
entrypoints
string[]
​
options
object[]
​
cards
object[]

Response

OK

A data form is a way to allow validation and editing of data extracted from a document

​
orgSlug
string
required

The slug of the organization that owns this metadata object

​
slug
string
required

The slug used when referencing this metadata object

​
type
string
required

The type of metadata object

​
name
string
required

The name of the object

​
version
string
required

The version of the object

​
ref
string

The reference to the metadata object

​
template
boolean

Is this component a template that can be used to create new components

​
description
string

The description of the object

​
get_id
string

An internal identifier (not for public use)

​
publicAccess
boolean

Is the metadata object publicly accessible by other organizations

​
imageUrl
string

URL of image when presenting this object in a UI

​
icon
string

Material Icon name to use in the UI

​
overviewMarkdown
string

Markdown that is used to present the overview of the object

​
provider
string

The details of the of provider

​
providerUrl
string

The link to the provider website

​
providerImageUrl
string

The link to the model image

​
deleteProtection
boolean

Delete protection status

​
checksum
string

The checksum of the metadata, calculated by the platform and used to determine if the metadata has changed

​
deprecated
boolean

The resource is marked for deprecation

​
extensionPackRef
string

The reference to the extension pack (if the metadata object was created by an extension pack)

​
entrypoints
string[]
​
options
object[]
​
cards
object[]
⌘I