POST
/
v3
/
collections
/
{identifier}
/
create_data_field
Create data field for a collection along with a new data point.
curl --request POST \
  --url https://{region}.affinda.com/v3/collections/{identifier}/create_data_field \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "categoryLabel": "<string>",
  "field": {
    "label": "<string>",
    "fieldType": "text",
    "mandatory": true,
    "showDropdown": true,
    "displayEnumValue": true,
    "autoValidationThreshold": 0.5,
    "enableAutoValidationThreshold": true,
    "dataSource": "<string>",
    "mapping": "<string>",
    "displayRawText": true
  },
  "dataPoint": {
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "type": "text",
    "multiple": true,
    "noRect": true,
    "parent": "DdCbJhhx",
    "manualEntry": true,
    "mappingDataSource": "mEFayXdO"
  }
}'
{
  "categoryLabel": "<string>",
  "field": {
    "label": "<string>",
    "fieldType": "text",
    "mandatory": true,
    "showDropdown": true,
    "displayEnumValue": true,
    "autoValidationThreshold": 0.5,
    "enableAutoValidationThreshold": true,
    "enabledChildFields": [
      {
        "label": "<string>",
        "dataPoint": "<string>",
        "fieldType": "text",
        "dataSource": "<string>",
        "mapping": "<string>",
        "mandatory": true,
        "autoValidationThreshold": 0.5,
        "enableAutoValidationThreshold": true,
        "showDropdown": true,
        "displayEnumValue": true,
        "hideEnumDetail": true,
        "dropNull": true,
        "enabledChildFields": [
          {}
        ],
        "disabledChildFields": [
          {}
        ],
        "slug": "<string>",
        "displayRawText": true,
        "fields": [
          {}
        ]
      }
    ],
    "disabledChildFields": [
      {
        "label": "<string>",
        "dataPoint": "<string>",
        "fieldType": "text",
        "dataSource": "<string>",
        "mapping": "<string>",
        "mandatory": true,
        "autoValidationThreshold": 0.5,
        "enableAutoValidationThreshold": true,
        "showDropdown": true,
        "displayEnumValue": true,
        "hideEnumDetail": true,
        "dropNull": true,
        "enabledChildFields": [
          {}
        ],
        "disabledChildFields": [
          {}
        ],
        "slug": "<string>",
        "displayRawText": true,
        "fields": [
          {}
        ]
      }
    ],
    "dataSource": "<string>",
    "mapping": "<string>",
    "displayRawText": true
  },
  "dataPoint": {
    "identifier": "XprEvgai",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "type": "text",
    "multiple": true,
    "noRect": true,
    "parent": "DdCbJhhx",
    "children": [
      {
        "identifier": "XprEvgai",
        "name": "<string>",
        "slug": "<string>",
        "description": "<string>",
        "annotationContentType": "text",
        "organization": {
          "identifier": "mEFayXdO",
          "name": "Grove Street King",
          "userRole": "admin",
          "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
          "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
          "isTrial": true,
          "validationToolConfig": {
            "theme": {
              "palette": {
                "mode": "light",
                "background": "<string>",
                "text": {
                  "primary": "<string>",
                  "secondary": "<string>",
                  "disabled": "<string>"
                },
                "divider": "<string>",
                "primary": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "secondary": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "success": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "annotation": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "error": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "info": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                },
                "warning": {
                  "main": "<string>",
                  "light": "<string>",
                  "dark": "<string>",
                  "contrastText": "<string>"
                }
              },
              "typography": {
                "fontFamily": "<string>",
                "fontSize": "<string>",
                "fontWeightRegular": "<string>",
                "fontWeightMedium": "<string>",
                "fontWeightBold": "<string>"
              },
              "borderRadius": 123,
              "fontUrl": "<string>"
            },
            "hideActions": true,
            "hideCollection": true,
            "hideEditPages": true,
            "hideExport": true,
            "hideFilename": true,
            "hideReject": true,
            "hideReparse": true,
            "hideRunOcr": true,
            "hideTags": true,
            "hideWarnings": true,
            "restrictDocumentSplitting": true,
            "disableCurrencyFormatting": true,
            "disableEditDocumentMetadata": true
          },
          "showCustomFieldCreation": true
        },
        "extractor": "resume",
        "multiple": true,
        "noRect": true,
        "parent": "DdCbJhhx",
        "children": [
          {}
        ],
        "availableDataSources": [
          {
            "identifier": "mEFayXdO",
            "name": "My supplier list",
            "keyProperty": "value",
            "displayProperty": "value",
            "organization": "mewlkWEKL",
            "workspace": "mewlkWEKL",
            "schema": {
              "type": "object",
              "$schema": "http://json-schema.org/draft-07/schema#",
              "required": [
                "label"
              ],
              "properties": {
                "label": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                }
              }
            }
          }
        ],
        "mappingDataSource": "mEFayXdO",
        "manualEntry": true
      }
    ],
    "manualEntry": true,
    "availableDataSources": [
      {
        "identifier": "mEFayXdO",
        "name": "My supplier list",
        "keyProperty": "value",
        "displayProperty": "value",
        "organization": "mewlkWEKL",
        "workspace": "mewlkWEKL",
        "schema": {
          "type": "object",
          "$schema": "http://json-schema.org/draft-07/schema#",
          "required": [
            "label"
          ],
          "properties": {
            "label": {
              "type": "string"
            },
            "description": {
              "type": "string"
            }
          }
        }
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

identifier
string
required

Collection's identifier

Example:

"mEFayXdO"

Body

application/json

The data field and data point to be created.

The body is of type object.

Response

200
application/json

Successfully created data field and data point.

The response is of type object.