REST APIリファレンス

前へ次へ

コミット内のオブジェクトのプル

pullByCommitHashリソースを使用して、特定のコミットによって変更されたオブジェクトを取得し、組織にロードします。

pullByCommitHashリソースを使用する場合は、要求にコミットハッシュを含めます。そのコミットで変更されたオブジェクトがプルに含まれます。パスまたはオブジェクトIDでオブジェクトをプルする場合は、代わりにpullリソースを使用してください。

プロジェクトレベルのリポジトリを使用する場合は、リポジトリ接続IDをpullByCommitHash要求に含めます。プロジェクトのリポジトリ接続IDは、repositoryConnection要求を送信することで確認できます。

リポジトリ接続IDの確認の詳細については、リポジトリ接続の詳細の取得を参照してください。

アセットで別の接続またはランタイム環境を使用する場合は、objectSpecificationオブジェクトを使用して、その接続またはランタイム環境を組織内の接続またはランタイム環境にマッピングできます。

プル要求に含めるオブジェクトは1000件未満にすることをお勧めします。

POST要求

特定のコミットで変更されたオブジェクトをリポジトリから組織にロードするには、次のURIを使用します。

/public/core/v3/pullByCommitHash

プル操作が完了する前にPOST要求に応答を受信します。

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

フィールド	タイプ	必須	説明
commitHash	String	○	単一のコミットハッシュ。コミットハッシュは操作中に検証されます。 GitHubリポジトリを使用する場合は、コミットハッシュの最初の7文字を送信することで、部分的なハッシュを含めることができます。他のリポジトリの場合は、完全な40文字のコミットハッシュを含めます。
searchCustomRepositories	Boolean	-	グローバルリポジトリのコミットハッシュが見つからなかった場合にプロジェクトレベルのリポジトリを検索するかどうかを示します。
repoConnectionId	文字列	-	検索するプロジェクトレベルのリポジトリの接続ID。
relaxObjectSpecificationValidation	Boolean	-	objectSpecificationオブジェクトで指定されたソースが、プルされるアセットに存在する必要があるかどうか。次のいずれかの値を使用します。 true。プルに含まれるアセットにソースが存在しない場合、objectSpecificationオブジェクトは無視されます。 false。プルに含まれるアセットにobjectSpecificationソースが存在しない場合、エラーが発生します。デフォルトはfalseです。
objectSpecification	List<Object>	-	接続環境とランタイム環境のオブジェクト仕様。
source	Object	はい（objectSpecificationオブジェクトが含まれる場合）	objectSpecificationオブジェクトに含めます。ソースオブジェクトに関する情報を含みます。
path	List<String>	はい（objectSpecificationオブジェクトが含まれる場合）	ソースオブジェクトに含めます。リポジトリの接続またはランタイム環境の名前。
type	String	はい（objectSpecificationオブジェクトが含まれる場合）	ソースオブジェクトに含めます。アセットタイプ。次のいずれかの値を使用します。接続 AgentGroup
target	Object	はい（objectSpecificationオブジェクトが含まれる場合）	objectSpecificationオブジェクトに含めます。ターゲットオブジェクトに関する情報を含みます。パスとタイプまたはIDを含めます。パス、タイプ、IDが含まれる場合、IDが優先されます。
path	List<String>	はい（IDが含まれない場合）。	ターゲットオブジェクトに含めます。接続またはランタイム環境の名前。タイプで使用します。
type	String	はい（IDが含まれない場合）。	ターゲットオブジェクトに含めます。アセットタイプ。パスで使用します。次のいずれかの値を使用します。接続 AgentGroup
id	String	はい（パスとタイプが含まれない場合）	ターゲットオブジェクトに含めます。ターゲットオブジェクトのID。

POST応答

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

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

POST要求の例

コミットで変更されたすべてのアセットにプル操作を要求するには、次の例のような要求を送信します。

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

{
    "commitHash": "7c525831c247cf792f595d1663396d1ae2c85033"
}

プロジェクトレベルのリポジトリに対して行われたコミット内の変更されたすべてのアセットに対してプル操作を要求するには、次の例のような要求を送信します:

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

{
    "commitHash": "7c525831c247cf792f595d1663396d1ae2c85033",
    "searchCustomRepositories": true
}

コミットで変更されたすべてのアセットにプル操作を要求し、接続とランタイム環境を含めるには、次の例のような要求を送信します。

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

{
 
    "commitHash": "1013f61bf318758cccec08f2165f59bbbb41e8f0",
    "objectSpecification":[
     {
        "source":
        {
            "path":["ff"],
            "type":"Connection"
        },
        "target":
        {
            "path":["target_connection"],
            "type":"Connection"
        }
     },
     {
        "source": {
            "path": ["USW1MJ02YNFB"],
            "type": "AgentGroup"
        },
        "target": {
            "id": "2ga6h3hRNZCf9Br0ZWB7EF"
        }
     }
   ]
}

POST応答の例

POST要求が成功した場合、応答は次の例のようになります。

{
    "pullActionId": "iW5TmGqUjmUcdZKk4c4VQH",
    "status": {
        "state": "NOT_STARTED",
        "message": "Initialized"
    }
}

ソース管理

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

コミット内のオブジェクトのプル

コミット内のオブジェクトのプル

POST要求

POST応答

POST要求の例

POST応答の例