REST APIリファレンス

前へ次へ

fetchStateジョブの開始

POST要求を使用してfetchStateジョブを開始します。

POST要求

ジョブを開始するには、次のURIを使用します。

/public/core/v3/fetchState

要求に次のフィールドを含めます。

フィールド	タイプ	必須	説明
name	String		fetchStateジョブの名前。空白の場合はデフォルトでjob-<currentTimeInMilliseconds>になります。
objects	Collection<複合型>	はい	オブジェクトの状態パッケージに状態を含めるオブジェクトID。 1つのパッケージに含めるオブジェクトは1000個以内にすることをお勧めします。
id	String	○	objectsオブジェクトに含まれます。状態を要求するオブジェクトのグローバル一意識別子。これは、プロジェクト、フォルダ、またはアセットのIDです。
includeDependencies	Boolean		objectsオブジェクトに含まれます。依存オブジェクトの状態を含めるかどうかを決定します。デフォルトはTrueです。

POST要求の例

次の例のような要求を使用できます。

POST <baseApiUrl>/public/core/v3/fetchstate
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
    "name" : "fetchStateJob1",
    "objects" : [
        {
            "id": "l7bgB85m5oGiXObDxwnvK9",
            "includeDependencies" : true
        },
        {
            "id": "1MW0GDAE1sFgnvWkvom7mK",
            "includeDependencies" : false
        },
        {
            "id": "iIVBNZSpUKFg4N6g2PKUox"
        }
    ]
}

POST応答

成功した場合、fetchStateジョブの次の情報が返されます。

フィールド	タイプ	説明
id	String	fetchStateジョブのID。
createTime	String	オブジェクトの状態パッケージが作成された時刻。
updateTime	String	オブジェクトの状態パッケージの最終更新時刻。
name	String	fetchStateジョブの名前。
startTime	String	fetchStateジョブが開始された時刻。
endTime	String	fetchStateジョブが終了した時刻。
status	複合型	ジョブのステータス。
state	String	ステータスのオブジェクトで返されます。「実行中」、「成功」、「失敗」など、fetchStateジョブのステータス。
message	String	ステータスのオブジェクトで返されます。ジョブのステータスメッセージ。
objects	Collection	オブジェクトおよびオブジェクトレベルのステータスのコレクション。空白の場合、NULLを返します。

POST応答の例

成功した場合、次の例のような応答を受信します。

{
  "id": "7evG9CokA1whk8ehF3opKM",
  "createTime": "2018-10-26T08:15:48.502Z",
  "updateTime": "2018-10-26T08:15:48.502Z",
  "name": "fetchStateJob1",
  "startTime": "2018-10-26T08:15:48.501Z",
  "endTime": null,
  "status": {
    "state": "IN_PROGRESS",
    "message": "In Progress"
  },
  "objects": null
}

エラーを受信した場合、次の例のような応答が表示されます。

{
  "error": {
    "code": "MigrationSvc_034",
    "message": "User does not have required permissions.",
    "requestId": "2ataXVlgw3ydI1Yb2MA4sq"
  }
}

fetchState

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal