AFaffinda
Data Sources

Create a data source

Changed on

Create a custom mapping data source.

post/v3/mapping_data_sources

Request

Request body

namestring nullable
organizationstring nullable

The organization that this mapping data source belongs to.

workspacestring nullable

The workspace that this mapping data source belongs to.

keyPropertystring

Attribute in the schema which uniquely identifiers the value

displayPropertystring

Attribute in the schema which is used to display the value

valuesobject[]
schemaobject

The schema of the mapping data source.

Example request

{
  "name": "My supplier list",
  "organization": "mewlkWEKL",
  "workspace": "mewlkWEKL",
  "keyProperty": "value",
  "displayProperty": "label",
  "schema": {
    "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.

identifierstring required

Uniquely identify a mapping data source.

namestring nullable
keyPropertystring required

Attribute in the schema which uniquely identifiers the value

displayPropertystring required

Attribute in the schema which is used to display the value

organizationstring nullable required

The organization that this mapping data source belongs to.

workspacestring nullable required

The workspace that this mapping data source belongs to.

schemaobject

The schema of the mapping data source.

Example response

{
  "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"
      }
    }
  }
}

Changes

  • 978cf99a2ac0Revision changes
    • info

      api tag Data Sources added

    • info

      api tag Document API - Mapping Data Sources removed

  • 98132617d3e3Revision changes
    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became optional

    • info

      added the required property to the response with the status