Gets the detailed information about a skill

GET /api/publicapi/v1/skills/{skillId}

Gets the detailed information about a skill

cURL

curl --request GET \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/skills/{skillId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "name": "<string>",
  "fields": [
    {
      "name": "<string>",
      "type": "<string>",
      "textFormat": "<string>",
      "isRepeatable": "<string>",
      "children": "<array>"
    }
  ],
  "classes": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "skills": [
    {
      "id": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

skillId · string · required

Skill identifier. You can find it in the list of all skills.

Response

200

text/plain

Skill info is successfully returned

id · string | null

Id of the skill

name · string | null

Name of the skill

type · enum<string>

Available options: Classification, Document, Process, Ocr, Assembling

fields · object[] | null

For document skills.

Show child attributes

classes · object[] | null

For classification skills.

Show child attributes

skills · object[] | null

Show child attributes