AFaffinda
Document API - Extractor

Get specific extractor

Changed on

Return a specific extractor.

get/v3/extractors/{identifier}

Request

Path parameters

identifierstring required

Uniquely identify an extractor.

Example:resume

Extractor's identifier

Response

Successfully retrieved extractor.

identifierstring required

Uniquely identify an extractor.

namestring required
namePluralstring required
categorystring nullable
validatableboolean required
isCustomboolean
createdDtstring date-time
lastTrainedDtstring date-time nullable

Example response

{
  "identifier": "resume",
  "baseExtractor": {
    "identifier": "resume"
  },
  "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"
  },
  "category": "Recruitment"
}

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

      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