REST APIリファレンス

前へ次へ

ソース管理操作のステータスの取得

sourceControlActionリソースを使用してソース管理操作のステータスを取得します。

ソース管理操作のステータスを要求することができます。

GET要求

ソース管理操作のステータスを受け取るには、次のURIにアクションIDを含めます。

/public/core/v3/sourceControlAction/<action ID>

ソース管理操作内の各オブジェクトのステータスを受け取るには、次のURIを使用します。

/public/core/v3/sourceControlAction/<action ID>?expand=objects

GET応答

ソース管理操作に対する次の情報を返します。

フィールド	タイプ	説明
id	String	ソース管理操作のID。
action	String	操作のタイプ。次のいずれかの値を返します。 CHECKIN CHECKOUT PULL UNLINK UNDO_CHECKOUT
commitHash	String	単一のコミットハッシュ。要求がチェックイン操作およびプル操作の場合に含まれます。
startTime	TimeStamp	操作の開始時刻。
endTime	TimeStamp	操作の終了時刻。
status	Object	操作のプルステータス情報が含まれます。
state	String	ステータスオブジェクトに含まれます。操作のステータス。次のいずれかの値を返します。 NOT_STARTED IN_PROGRESS SUCCESSFUL FAILED 注意（WARNING）
message	String	ステータスオブジェクトに含まれます。操作のわかりやすいステータスメッセージ。
objects	List<Object>	操作に含まれる各オブジェクトを一覧表示します。 URIにexpand=objectsが含まれるときに返されます。
target	Object	objectsオブジェクトに含まれます。ターゲットオブジェクト
id	String	ターゲットオブジェクトに含まれます。ターゲットオブジェクトのID。
path	List<String>	ターゲットオブジェクトに含まれます。ターゲットオブジェクトの完全なパス。例えば、「Default」、「mt_MappingTask1」。
type	String	ターゲットオブジェクトに含まれます。ターゲットオブジェクトのアセットタイプ。
status	Object	ターゲットオブジェクトに含まれます。ターゲットオブジェクトのステータス情報。
state	String	ステータスオブジェクトに含まれます。操作のステータス。次のいずれかの値を返します。 NOT_STARTED IN_PROGRESS SUCCSSFUL FAILED SKIPPED。 CANCELLED 注意（WARNING）
message	String	ステータスオブジェクトに含まれます。操作のわかりやすいステータスメッセージ。

GET応答の例

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

{
  "id": "drLV4N8PFiuhAbcprrur2W",
  "action": "CHECKIN"
  "commitHash": "1234567abcdefg"
  "startTime": "2020-03-24T22:07:44Z",
  "endTime": "2020-03-24T22:08:14Z",
  "status": {
    "state": "SUCCESSFUL",
    "message": "Checkin Successful"
  },
  "objects": [
    {
      "target": {
        "path": [
          "Versioned_Project",
          "Versioned_Folder",
          "Versioned Mapping - Rename"
        ],
        "id": "2CefbUuBsYxhG6eeKXvGmh",
        "type": "MAPPING"
      },
      "status": {
        "state": "SUCCESSFUL",
        "message": "Checkin Successful"
      }
    },
    {
      "target": {
        "path": [
          "Versioned_Project",
          "Versioned_Folder",
          "Versioned Mapping - Edit"
        ],
        "id": "2CefbUuBsYxhG6eeKXvGmh",
        "type": "MAPPING"
      },
      "status": {
        "state": "FAILED",
        "message": "Checkin Failed."
     }
  ]
}

ソース管理

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal