AFaffinda
Deprecated End Points

Get list of all data points

Changed on

Returns your custom data points as well as Affinda's off-the-shelf data points.

get/v3/data_points

Request

Query parameters

offsetinteger

The number of documents to skip before starting to collect the result set.

limitinteger
Example:20

The numbers of results to return.

organizationstring

Uniquely identify an organization.

Example:mEFayXdO

Filter by organization.

include_publicboolean

Allows you to include public data points in the response when you're filtering by organization.

extractorstring

Uniquely identify an extractor.

Example:resume

Filter by extractor.

slugstring

Filter by slug.

descriptionstring

Filter by description.

annotation_content_typestring

Filter by annotation content type, e.g. text, integer, float, date, etc.

identifierDataPointPropertiesIdentifier[]

Filter by specific identifiers.

[
  "XprEvgai"
]

Response

All matching data points.

identifierstring required

Uniquely identify a data point.

namestring required

Name of the data point.

slugstring required

A camelCase string that will be used as the key in the API response.

descriptionstring nullable
annotationContentType'text' | 'integer' | 'float' | 'decimal' | 'date' | 'datetime' | 'daterange' | 'boolean' | 'enum' | 'location' | 'phonenumber' | 'json' | 'table' | 'expectedremuneration' | 'jobtitle' | 'language' | 'skill' | 'yearsexperience' | 'group' | 'table_deprecated' | 'url' | 'image' | 'docclf' required

The different data types of annotations

extractorstring required

Uniquely identify an extractor.

multipleboolean
noRectboolean
parentstring nullable

The identifier of the parent data point if applicable.

childrenDataPoint[] circular
mappingDataSourcestring nullable

If populated, the model will learn to predict this field using the data source, rather than relying on fuzzy string matching.

manualEntryboolean

If true, the model will not be used to predict this data point. Instead, the user will be able to manually enter the value in the validation tool.

Example response

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

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 - Data Point 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