コンテンツにスキップ
α(一般提供前)のサービスです。一般提供はしておらず、仕様変更・機能の追加削除・データの削除が予告なく発生する場合があります。
ThingsConnectThingsConnect ドキュメント
Esc
↑↓移動↵開く⌘Jプレビュー

撮影ジョブを実行する

撮影ジョブを 1 回実行します。エッジPC が依頼を受け付けて保存した時点で 202 を返すので、撮影と送信の結果は実行結果で確かめてください。撮影の前にエッジPC が再起動しても、起動後に撮影します(依頼から 10 分を過ぎても撮り始められなかったものは撮らずに失敗にします)。

payload に入れた値は外部送信先へ写真と一緒に送られます(JSON で 4096 バイトまで)。API からの実行を許可していないジョブは 403、無効にしたジョブは 409、エッジPC に届かなかった場合は 502 を返します。スコープは capture が要ります。

POST/capture/jobs/{id}/run
Authorization
AuthorizationBearer token · headerrequired

組織設定の「API・MCP」タブで発行した API トークン(tcn_ で始まる)。

Path parameters
idstringrequired

撮影ジョブの ID

Request body
application/json
payloadobject

外部送信先へ一緒に送る値(JSON で 4096 バイトまで)

Responses
202

受け付けた

runIdstringrequired

実行の ID。結果の確認に使う

400

入力の検証エラー、または対象の種類が合わない

errorstringrequired

人が読めるエラーメッセージ

401

トークンが無い、または無効

errorstringrequired

人が読めるエラーメッセージ

403

スコープが足りない、または操作が許可されていない

errorstringrequired

人が読めるエラーメッセージ

404

対象が無い(他の組織のものを含む)

errorstringrequired

人が読めるエラーメッセージ

409

今の状態ではできない操作

errorstringrequired

人が読めるエラーメッセージ

502

エッジPC まで届かなかった、またはエッジPC が失敗を返した

errorstringrequired

人が読めるエラーメッセージ

Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.thingsconnect.app/api/v1/capture/jobs/string/run' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "payload": {
    "orderId": "A-1024"
  }
}'
Response
{
  "runId": "string"
}