AFaffinda
Deprecated End Points

Create data field for a collection along with a new data point.

Changed on

Create data field for a collection along with a new data point.

post/v3/collections/{identifier}/create_data_field

Request

Path parameters

identifierstring required

Uniquely identify a collection.

Example:mEFayXdO

Collection's identifier

Request body

categoryLabelstring

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.

Example request

{
  "dataPoint": {
    "parent": "DdCbJhhx",
    "mappingDataSource": "mEFayXdO"
  }
}

Response

Successfully created data field and data point.

categoryLabelstring

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.

Example response

{
  "dataPoint": {
    "identifier": "XprEvgai",
    "parent": "DdCbJhhx",
    "children": [
      {
        "identifier": "XprEvgai",
        "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"
        },
        "extractor": "resume",
        "parent": "DdCbJhhx",
        "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"
      }
    ],
    "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"
            }
          }
        }
      }
    ]
  }
}

Changes

  • acca5642c0bcRevision changes
    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      added the required property //// to the response with the status

  • 978cf99a2ac0Revision changes
    • info

      api tag Deprecated End Points added

    • info

      api tag Document API - Collection removed

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status