/api/v1/things/{id}/extract

POST

/api/v1/things/{id}/extract

curl --request POST \
  --url https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/extract \
  --header 'Content-Type: application/json' \
  --data '{ "attachmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "mode": "thing" }'

Parameters

Path Parameters

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body^required

Media typeapplication/json

object

attachmentId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

mode

string

Allowed values: thing label reading

Responses

202

Default Response

Media typeapplication/json

object

extractionId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example^generated

{
  "extractionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}