REST APIリファレンス

前へ次へ

オブジェクトのチェックアウト

チェックアウトリソースを使用して、ソース管理オブジェクトをチェックアウトし、変更を加えられるようにします。オブジェクトをチェックアウトすると、そのオブジェクトはロックされるため、他のユーザーはそのオブジェクトを変更できません。

1回の要求で、複数のプロジェクト、フォルダ、またはアセットをチェックアウトできます。

複数のオブジェクトがチェックアウトに含まれていて、それらのいずれかでチェックアウトが失敗した場合、どのオブジェクトもチェックアウトされません。成功したオブジェクトのステータスは［キャンセル］になります。

チェックアウトステータスの詳細については、ソース管理操作のステータスの取得を参照してください。

POST要求

オブジェクトをリポジトリからチェックアウトするには、次のURIを使用します。

/public/core/v3/checkout

要求では、オブジェクトIDまたはフルパスとオブジェクトタイプのいずれかを指定する必要があります。

要求に以下のフィールドを含めることができます。

フィールド	タイプ	必須	説明
objects	List<Object>	はい	チェックアウトされるすべてのオブジェクトのリストを含みます。
id	String	はい（パスとタイプが含まれない場合）	objectsオブジェクトに含めます。オブジェクトのID。
path	List<String>	はい（IDが含まれない場合）。	objectsオブジェクトに含めます。チェックアウトされるオブジェクトのフルパス。
type	String	はい（IDが含まれない場合）。	objectsオブジェクトに含めます。チェックアウトされるアセットのタイプ。次のいずれかのタイプです。 DTEMPLATE。マッピング。 MTT。マッピングタスク。 DSS。同期タスク。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 MAPPLET。 BSERVICE。ビジネスサービス定義。 HSCHEMA。階層スキーマ。 PCS。PowerCenterタスク。 FWCONFIG。固定長の設定。 CUSTOMSOURCE。保存済みクエリ。 MI_TASK。一括取り込みタスク。 WORKFLOW。リニアタスクフロー。 VISIOTEMPLATE TASKFLOW PROCESS。アプリケーションの統合プロセス。 AI_CONNECTION。アプリケーションの統合アプリの接続。 AI_SERVICE_CONNECTOR。アプリケーションの統合サービスコネクタ。 GUIDE。アプリケーションの統合ガイド。 PROCESS_OBJECT。アプリケーションの統合プロセスオブジェクト。 HUMAN_TASK。アプリケーションの統合ヒューマンタスク。
includeContainerAssets	Boolean	-	objectsオブジェクトに含めます。プロジェクトまたはフォルダ内のすべてのオブジェクトがチェックインに含まれているかどうか。以下のいずれかの値を使用します。 true。プロジェクトまたはフォルダ内のすべてのオブジェクトを含めます。 false。プロジェクトまたはフォルダ内のオブジェクトを含めません。デフォルトはfalseです。

POST応答

成功した場合、POST要求は次の情報を返します。

フィールド	タイプ	説明
Id	String	チェックアウト操作のID。
status	Object	チェックアウト操作のステータス。
state	String	ステータスのオブジェクトで返されます。チェックアウト操作の初期状態。要求が成功した場合、値は常にNOT_STARTEDになります。操作開始後にステータスを確認するには、ソース管理操作のステータスの取得リソースを使用します。
message	String	ステータスのオブジェクトで返されます。チェックアウト操作のわかりやすいステータスメッセージ。

POST要求の例

プロジェクトのチェックアウト操作を要求し、プロジェクトにすべてのアセットを含めるには、次の例のような要求を送信します。

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

{
  "objects": [
    {
      "id": "ejZY66c19YUccBdbGwKG4P",
      "includeContainerAssets": true
    }
  ]
}

プロジェクトのチェックアウト操作を要求し、プロジェクトに2つのアセットを含めるには、次の例のような要求を送信します。

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

{
  "objects": [
    {
      "id": "iIVBNZSpUKFg4N6g2PKUox",
      "includeContainerAssets": false
    },
    {
      "id": "l7bgB85m5oGiXObDxwnvK9"
    },
    {
      "id": "1MW0GDAE1sFgnvWkvom7mK"
    }
  ]
}

DefaultプロジェクトにあるTest_Mappingと名付けられたセットにチェックアウト操作を要求するには、次の例のような要求を送信します。

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

{
  "objects": [
    {
      "path": [
        "Default",
        "Test_Mapping"
      ],
      "type": "DTEMPLATE"
    }
  ]
}

アセットIDを使用してチェックアウト操作を要求するには、次の例のような要求を送信します。

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

{
  "objects": [
    {
      "id": "3iWWHkLbM2giVppBmJmZgV"
    }
  ]
}

POST応答の例

次の例のような応答を受信します。

{
    "id": "awRrziMMWXol7i42aTm1ih",
    "status": {
        "state": "NOT_STARTED",
        "message": "Initialized"
    }
}

ソース管理

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

オブジェクトのチェックアウト

オブジェクトのチェックアウト

POST要求

POST応答

POST要求の例

POST応答の例