撮影ジョブの実行結果を取得する

run にその回の状態と撮れた枚数・失敗した枚数、deliveries に写真 1 枚ごとの撮影と送信の結果が入ります。run.status が completed・interrupted・failed のどれかになれば、その回は終わっています。スコープは capture が要ります。

GET/capture/runs/{id}

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstringrequired

実行の ID（撮影ジョブの実行で返った runId）

Responses

200

実行結果

runCaptureRunrequired

Show properties

idstringrequired

jobIdstring | nullrequired

ジョブを消した後は null

jobNamestringrequired

deviceIdstringrequired

triggerstringrequired

実行のきっかけ

Allowed:scheduleedgeapimanualevent

statusstringrequired

requested はエッジPC が受け付けて撮り始める前

Allowed:requestedrunningcompletedinterruptedfailed

plannedCountintegerrequired

撮る予定の枚数

capturedCountintegerrequired

failedCountintegerrequired

errorstring | nullrequired

startedAtstring<date-time> | nullrequired

finishedAtstring<date-time> | nullrequired

createdAtstring<date-time>required

deliveriesCaptureDelivery[]required

Show properties

Array of CaptureDelivery

idstringrequired

jobIdstring | nullrequired

runIdstring | nullrequired

jobNamestringrequired

presetNamestring | nullrequired

viewNamestring | nullrequired

撮った向きの名前

deviceIdstringrequired

triggerstringrequired

Allowed:scheduleedgeapimanualevent

statusstringrequired

pending は送信待ち（再送中を含む）、sent は送信先が 2xx を返した、failed は撮影できなかった、abandoned は再送の上限に達した、captured は外部送信先へ送らないジョブで撮影できた

Allowed:pendingsentfailedabandonedcaptured

httpStatusinteger | nullrequired

外部送信先が返したステータス

attemptsintegerrequired

送信を試みた回数

errorstring | nullrequired

sizeBytesinteger | nullrequired

capturedAtstring<date-time> | nullrequired

finishedAtstring<date-time> | nullrequired

createdAtstring<date-time>required

401

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

errorstringrequired

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

403

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

errorstringrequired

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

404

対象が無い（他の組織のものを含む）

errorstringrequired

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

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idpath*実行の ID（撮影ジョブの実行で返った `runId`）

Request

curl -X GET 'https://api.thingsconnect.app/api/v1/capture/runs/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.thingsconnect.app/api/v1/capture/runs/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.thingsconnect.app/api/v1/capture/runs/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "run": {
    "id": "string",
    "jobId": "string",
    "jobName": "string",
    "deviceId": "string",
    "trigger": "schedule",
    "status": "requested",
    "plannedCount": 0,
    "capturedCount": 0,
    "failedCount": 0,
    "error": "string",
    "startedAt": "2019-08-24T14:15:22Z",
    "finishedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "deliveries": [
    {
      "id": "string",
      "jobId": "string",
      "runId": "string",
      "jobName": "string",
      "presetName": "string",
      "viewName": "string",
      "deviceId": "string",
      "trigger": "schedule",
      "status": "pending",
      "httpStatus": 0,
      "attempts": 0,
      "error": "string",
      "sizeBytes": 0,
      "capturedAt": "2019-08-24T14:15:22Z",
      "finishedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": "Unauthorized"
}

{
  "error": "data スコープが必要です"
}

{
  "error": "string"
}