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 '
{
"field": {
"label": "<string>",
"mandatory": true,
"showDropdown": true,
"displayEnumValue": true,
"autoValidationThreshold": 0.5,
"enableAutoValidationThreshold": true,
"dataSource": "<string>",
"mapping": "<string>",
"displayRawText": true
},
"dataPoint": {
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"multiple": true,
"noRect": true,
"parent": "DdCbJhhx",
"manualEntry": true,
"mappingDataSource": "mEFayXdO"
},
"categoryLabel": "<string>"
}
'import requests
url = "https://{region}.affinda.com/v3/collections/{identifier}/create_data_field"
payload = {
"field": {
"label": "<string>",
"mandatory": True,
"showDropdown": True,
"displayEnumValue": True,
"autoValidationThreshold": 0.5,
"enableAutoValidationThreshold": True,
"dataSource": "<string>",
"mapping": "<string>",
"displayRawText": True
},
"dataPoint": {
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"multiple": True,
"noRect": True,
"parent": "DdCbJhhx",
"manualEntry": True,
"mappingDataSource": "mEFayXdO"
},
"categoryLabel": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
field: {
label: '<string>',
mandatory: true,
showDropdown: true,
displayEnumValue: true,
autoValidationThreshold: 0.5,
enableAutoValidationThreshold: true,
dataSource: '<string>',
mapping: '<string>',
displayRawText: true
},
dataPoint: {
name: '<string>',
slug: '<string>',
description: '<string>',
multiple: true,
noRect: true,
parent: 'DdCbJhhx',
manualEntry: true,
mappingDataSource: 'mEFayXdO'
},
categoryLabel: '<string>'
})
};
fetch('https://{region}.affinda.com/v3/collections/{identifier}/create_data_field', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"field": {
"label": "<string>",
"mandatory": true,
"displayEnumValue": true,
"autoValidationThreshold": 0.5,
"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": "<array>",
"disabledChildFields": "<array>",
"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": "<array>",
"disabledChildFields": "<array>",
"slug": "<string>",
"displayRawText": true,
"fields": [
{}
]
}
],
"fieldType": "text",
"showDropdown": true,
"enableAutoValidationThreshold": true,
"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>",
"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,
"hideShowRawValues": true,
"hideReject": true,
"hideReparse": true,
"hideRunOcr": true,
"hideTags": true,
"hideWarnings": true,
"restrictDocumentSplitting": true,
"disableCurrencyFormatting": true,
"disableEditDocumentMetadata": true,
"disableManualAnnotationEditing": true,
"hideDocumentStatus": true
},
"showCustomFieldCreation": true,
"allowDataSourceRecordCreation": true
},
"extractor": "resume",
"description": "<string>",
"multiple": true,
"noRect": true,
"parent": "DdCbJhhx",
"children": "<array>",
"availableDataSources": [
{
"identifier": "mEFayXdO",
"keyProperty": "value",
"displayProperty": "value",
"organization": "mewlkWEKL",
"workspace": "mewlkWEKL",
"name": "My supplier list",
"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",
"keyProperty": "value",
"displayProperty": "value",
"organization": "mewlkWEKL",
"workspace": "mewlkWEKL",
"name": "My supplier list",
"schema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"label"
],
"properties": {
"label": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
]
},
"categoryLabel": "<string>"
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}Deprecated End Points
Create data field for a collection along with a new data point.
deprecated
Create data field for a collection along with a new data point.
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 '
{
"field": {
"label": "<string>",
"mandatory": true,
"showDropdown": true,
"displayEnumValue": true,
"autoValidationThreshold": 0.5,
"enableAutoValidationThreshold": true,
"dataSource": "<string>",
"mapping": "<string>",
"displayRawText": true
},
"dataPoint": {
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"multiple": true,
"noRect": true,
"parent": "DdCbJhhx",
"manualEntry": true,
"mappingDataSource": "mEFayXdO"
},
"categoryLabel": "<string>"
}
'import requests
url = "https://{region}.affinda.com/v3/collections/{identifier}/create_data_field"
payload = {
"field": {
"label": "<string>",
"mandatory": True,
"showDropdown": True,
"displayEnumValue": True,
"autoValidationThreshold": 0.5,
"enableAutoValidationThreshold": True,
"dataSource": "<string>",
"mapping": "<string>",
"displayRawText": True
},
"dataPoint": {
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"multiple": True,
"noRect": True,
"parent": "DdCbJhhx",
"manualEntry": True,
"mappingDataSource": "mEFayXdO"
},
"categoryLabel": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
field: {
label: '<string>',
mandatory: true,
showDropdown: true,
displayEnumValue: true,
autoValidationThreshold: 0.5,
enableAutoValidationThreshold: true,
dataSource: '<string>',
mapping: '<string>',
displayRawText: true
},
dataPoint: {
name: '<string>',
slug: '<string>',
description: '<string>',
multiple: true,
noRect: true,
parent: 'DdCbJhhx',
manualEntry: true,
mappingDataSource: 'mEFayXdO'
},
categoryLabel: '<string>'
})
};
fetch('https://{region}.affinda.com/v3/collections/{identifier}/create_data_field', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"field": {
"label": "<string>",
"mandatory": true,
"displayEnumValue": true,
"autoValidationThreshold": 0.5,
"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": "<array>",
"disabledChildFields": "<array>",
"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": "<array>",
"disabledChildFields": "<array>",
"slug": "<string>",
"displayRawText": true,
"fields": [
{}
]
}
],
"fieldType": "text",
"showDropdown": true,
"enableAutoValidationThreshold": true,
"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>",
"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,
"hideShowRawValues": true,
"hideReject": true,
"hideReparse": true,
"hideRunOcr": true,
"hideTags": true,
"hideWarnings": true,
"restrictDocumentSplitting": true,
"disableCurrencyFormatting": true,
"disableEditDocumentMetadata": true,
"disableManualAnnotationEditing": true,
"hideDocumentStatus": true
},
"showCustomFieldCreation": true,
"allowDataSourceRecordCreation": true
},
"extractor": "resume",
"description": "<string>",
"multiple": true,
"noRect": true,
"parent": "DdCbJhhx",
"children": "<array>",
"availableDataSources": [
{
"identifier": "mEFayXdO",
"keyProperty": "value",
"displayProperty": "value",
"organization": "mewlkWEKL",
"workspace": "mewlkWEKL",
"name": "My supplier list",
"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",
"keyProperty": "value",
"displayProperty": "value",
"organization": "mewlkWEKL",
"workspace": "mewlkWEKL",
"name": "My supplier list",
"schema": {
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"label"
],
"properties": {
"label": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
]
},
"categoryLabel": "<string>"
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}{
"type": "validation_error",
"errors": [
{
"attr": "non_field_errors",
"code": "unique",
"detail": "This index name has already been used"
}
]
}Authorizations
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
Collection's identifier Uniquely identify a collection.
Example:
"mEFayXdO"
Body
application/json
The data field and data point to be created.
The field to be created.
Show child attributes
Show child attributes
The data point to be created for this field. If a data point with the same slug and collection already exists, it will be reused.
Show child attributes
Show child attributes
The label of the category that this field will be put into. If not provided, the field will be put into the default category. If no category exists with the specified label, a new category will be created.
Response
Successfully created data field and data point.
The field to be created.
Show child attributes
Show child attributes
The data point to be created for this field. If a data point with the same slug and collection already exists, it will be reused.
Show child attributes
Show child attributes
The label of the category that this field will be put into. If not provided, the field will be put into the default category. If no category exists with the specified label, a new category will be created.