POST
/
v3
/
mapping_data_sources
Create a data source
curl --request POST \
  --url https://{region}.affinda.com/v3/mapping_data_sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My supplier list",
  "organization": "mewlkWEKL",
  "workspace": "mewlkWEKL",
  "keyProperty": "value",
  "displayProperty": "label",
  "values": [
    {}
  ],
  "schema": {
    "type": "object",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "required": [
      "label"
    ],
    "properties": {
      "label": {
        "type": "string"
      },
      "description": {
        "type": "string"
      }
    }
  }
}'
{
  "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.

Body

application/json

A mapping data source is used to map from raw data found by our AI models to records in your database.

​
name
string | null
Example:

"My supplier list"

​
organization
string | null

The organization that this mapping data source belongs to.

Example:

"mewlkWEKL"

​
workspace
string | null

The workspace that this mapping data source belongs to.

Example:

"mewlkWEKL"

​
keyProperty
string

Attribute in the schema which uniquely identifiers the value

Example:

"value"

​
displayProperty
string

Attribute in the schema which is used to display the value

Example:

"label"

​
values
object[]
​
schema
object

The schema of the mapping data source.

Example:
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": ["label"],
  "properties": {
    "label": { "type": "string" },
    "description": { "type": "string" }
  }
}

Response

Successfully created a mapping data source.

A mapping data source is used to map from raw data found by our AI models to records in your database.

​
identifier
string
required

Uniquely identify a mapping data source.

Example:

"mEFayXdO"

​
keyProperty
string
required

Attribute in the schema which uniquely identifiers the value

Example:

"value"

​
displayProperty
string
required

Attribute in the schema which is used to display the value

Example:

"value"

​
organization
string | null
required

The organization that this mapping data source belongs to.

Example:

"mewlkWEKL"

​
workspace
string | null
required

The workspace that this mapping data source belongs to.

Example:

"mewlkWEKL"

​
name
string | null
Example:

"My supplier list"

​
schema
object

The schema of the mapping data source.

Example:
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": ["label"],
  "properties": {
    "label": { "type": "string" },
    "description": { "type": "string" }
  }
}