REST APIリファレンス

前へ次へ

loadStateジョブの開始

POST要求を使用して、loadStateジョブを指定して開始します。

POST要求

オブジェクトを指定してloadStateジョブを開始するには、次のURIを使用します。

/public/core/v3/loadState/<id>

<id>は、オブジェクトの状態パッケージのアップロードのPOST応答で受信されるloadStateジョブのIDです。

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

フィールド	タイプ	必須	説明
name	String		loadStateジョブの名前。デフォルトの名前はjob-<currentTimeInMilliseconds>です。
importSpecification	複合型		含めるオブジェクトを指定するために使用します。
includeObjects	Collection<String>		importSpecificationオブジェクトに含まれます。ロードするオブジェクトです。指定しない場合、オブジェクトの状態パッケージのすべての状態が含まれます。指定したオブジェクトがプロジェクトの場合、そのプロジェクトに属するすべてのオブジェクトとすべての依存オブジェクトの状態が含まれます。
objectSpecification	Collection<複合型>		importSpecificationオブジェクトに含まれます。オブジェクトのプロパティを指定します。
sourceObjectId	String	○	objectSpecificationオブジェクトに含まれます。オブジェクトの状態パッケージファイルのコンテナIDです。 objectSpecificationが存在する場合は必須です。
targetObjectId	String	○	objectSpecificationオブジェクトに含まれます。コンテナ間マッピングに使用されます。 objectSpecificationが存在する場合は必須です。

POST要求の例

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

POST <baseApiUrl>/public/core/v3/loadState/2oZb7vFI2QQg4ncd4AyCGn HTTP/1.0
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
    "name" : "stateImportJob",
    "importSpecification" : {
        "includeObjects" : ["iIVBNZSpUKFg4N6g2PKUox","ejZY66c19YUccBdbGwKG4P"],
        "objectSpecification" : [{
            "sourceObjectId" : "iIVBNZSpUKFg4N6g2PKUox"
        },
        {
            "sourceObjectId" : "5FA0DnMzeuDbYZnn3hdto9",
            "targetObjectId" : "5KgUiEkW95NkjLRRefWKiG"
        }]
    }
}

POST応答

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

フィールド	タイプ	説明
Id	String	loadStateジョブのID。
createTime	String	loadStateジョブが作成された時刻。
updateTime	String	loadStateジョブの最終更新時刻。
name	String	loadStateジョブの名前。
startTime	String	loadStateジョブの開始時刻。
endTime	String	loadStateジョブの終了時刻。
status	Collection	パッケージのアップロードステータス。
state	String	ステータスのオブジェクトで返されます。「実行中」、「成功」、「失敗」、「スキップ」など、個々のオブジェクトのロード状態。
message	String	ステータスのオブジェクトで返されます。ジョブのステータスメッセージ。
objects	Collection	loadStateジョブに含まれるオブジェクトと、オブジェクトレベルのステータス。
sourceOrgId	String	オブジェクトの状態パッケージを作成した組織の組織ID。
checksumValid	Boolean	インポートパッケージのチェックサムが有効かどうかを示します。

POST応答の例

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

{
    "id": "a7oaBNCyc8DdhxQD4mY4ul",
    "createTime": "2019-01-10T01:35:45.000Z",
    "updateTime": "2019-01-10T21:08:41.398Z",
    "name": "job-1547154520680",
    "startTime": "2019-01-10T21:08:41.389Z",
    "endTime": null,
    "status": {
        "state": "IN_PROGRESS",
        "message": "In Progress"
    },
    "objects": null,
    "sourceOrgId": "2wy21a5fkUphzTVNKaPowg",
    "checksumValid": true
}

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

{
    "error": {
        "message": "Import request with identifier [a7oaBNCyc8DdhxQD4mY4u] doesnt exist.",
        "requestId": "9MopwrDFAOGbuMM9utiTqJ"
    }
}

loadState

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal