コンテンツにスキップ

drawings

drawings/では、描画処理の実行や処理結果の取得ができます。

エンドポイント 説明
GET /drawings 実行した描画処理の一覧の取得
GET /drawings/:id 指定した id に該当する動画情報の取得
POST /drawings 抽出したキーポイントを動画像に対して描画する処理の実行

Important

リクエストする際には各種エンドポイントの末尾に / を付与してしてください。 具体的には、 /drawings/123 という URL に対するリクエストは /drawings/123/ としてリクエストをします。

GET /drawings

これまでに実行した描画の処理一覧を取得します。

リクエスト

HTTPリクエスト

1
GET https://api.customer.jp/anymotion/v1/drawings/

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer <アクセストークン>

リクエストパラメータ

パラメータ 説明 必須
page ページ番号 -
size ページサイズ -
execStatus 実行ステータス -

レスポンス

レスポンスボディ

プロパティ タイプ 説明
next String 次ページのURL
previous String 前ページのURL
maxPage Integer 最大ページ番号
data[].id Integer 描画ID
data[].keypoint Integer 対象キーポイントID
data[].comparison Integer 比較ID
data[].execStatus String 実行ステータス
UNPROCESSED, SUCCESS, PROCESSING, FAILURE
data[].createdAt String 作成時刻
data[].updatedAt String 更新時刻

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "next": "https://api.customer.jp/anymotion/v1/drawings/?page=3&size=2",
    "previous": "https://api.customer.jp/anymotion/v1/drawings/?page=1&size=2",
    "maxPage": 10,
    "data": [
      {
          "id": 18,
          "keypoint": 60,
          "comparison": null,
          "execStatus": "UNPROCESSED",
          "createdAt": "2019-06-18T00:51:21.983029Z",
          "updatedAt": "2019-06-18T00:51:21.983080Z"
      },
      {
          "id": 17,
          "keypoint": null,
          "comparison": 50,
          "execStatus": "UNPROCESSED",
          "createdAt": "2019-06-18T10:51:21.983029Z",
          "updatedAt": "2019-06-18T10:51:21.983080Z"
      }
    ]
}

GET /drawings/:id

描画処理の実行結果情報を取得します。

リクエスト

HTTPリクエスト

1
GET https://api.customer.jp/anymotion/v1/drawings/:id/

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer <アクセストークン>

レスポンス

レスポンスボディ

プロパティ タイプ 説明
id Integer 描画ID
keypoint Integer キーポイントID
comparison Integer 比較ID
drawingUrl String 描画ファイルダウンロードURL
rule Object 描画ルール
backgroundRule Object 背景の描画ルール
execStatus String 実行ステータス
UNPROCESSED, SUCCESS, PROCESSING, FAILURE
failureDetail String Failureの詳細
createdAt String 作成時刻
updatedAt String 更新時刻

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "id": 34,
    "keypoint": 52,
    "comparison": null,
    "drawingUrl": "https://example.com/download/url",
    "execStatus": "SUCCESS",
    "failureDetail": null,
    "rule": {
      "drawingType": "keypoint",
      "color": "red",
      "size": 1,
      "points": [{
        "pointType": "single",
        "ponitName": "nose"
      }]
    },
    "backgroundRule": {
      "skeletonOnly": true
    },
    "createdAt": "2019-06-18T05:32:51.771785Z",
    "updatedAt": "2019-06-18T05:54:58.298409Z"
}

Note

execStatusFAILURE場合はこちらよりお問い合わせください。

POST /drawings

アップロード済みの動画像に対して描画処理を実行します。 動画像に対しての描画は処理が大きいため非同期APIとなります。実行結果は execStatus に格納されます。

リクエスト

HTTPリクエスト

1
POST https://api.customer.jp/anymotion/v1/drawings/

リクエストヘッダー

リクエストヘッダー 説明
Authorization Bearer <アクセストークン>

リクエストパラメータ

プロパティ タイプ 説明 必須
keypointId Integer キーポイントID 1
comparisonId Integer 比較ID 1
rule Object or Array キーポイントの描画ルール -
backgroundRule Object 背景の描画ルール -

Infomation

keypointIdcomparisonIdは指定しない場合や両方指定した場合はエラーレスポンスとなります。

ruleを指定しない場合は、デフォルトのルールで描画します。

Hint

ruleまたはbackgroundRuleについては描画についてを参照してください

レスポンス

レスポンスボディ

プロパティ タイプ 説明
id Integer 描画ID
keypoint Integer キーポイントID
comparison Integer 比較ID
rule Object 描画ルール
backgroundRule Object 背景の描画ルール
execStatus String 実行ステータス
UNPROCESSED, SUCCESS, PROCESSING, FAILURE
createdAt String 作成時刻
updatedAt String 更新時刻

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
    "id": 33,
    "keypoint": 52,
    "comparison": null,
    "execStatus": "UNPROCESSED",
    "rule": {
      "drawingType": "keypoint",
      "color": "red",
      "size": 1,
      "points": [{
        "pointType": "single",
        "pointName": "nose"
      }]
    },
    "backgroundRule": {
      "skeletonOnly": true
    },
    "createdAt": "2019-06-18T05:29:53.803264Z",
    "updatedAt": "2019-06-18T05:29:53.803550Z"
}

Note

ruleの値が長さによっては、リクエストがエラーになる場合があります。その際は、こちらよりお問い合わせください。


  1. keypointIdcomparisonIdは指定しない場合や両方指定した場合はエラーレスポンスとなります。