REST APIリファレンス

前へ次へ

オブジェクトのプル

pullリソースを使用して、グローバルリポジトリからアセットやプロジェクトなどのオブジェクトを取得し、組織にロードします。

プロジェクトをプルすると、プロジェクトとプロジェクトのフォルダ内のすべてのソース管理アセットがプルに含まれます。アセットがターゲット組織にすでに存在する場合、その内容は、指定されたコミットハッシュでのアセットの状態と一致するように上書きされます。プロジェクトとプロジェクトのフォルダがターゲット組織にすでに存在する場合、それらは再利用されます。

他のプロジェクトにある依存オブジェクトはプルには含まれません。プルリクエストで依存オブジェクトが欠落している場合、応答には欠落している依存オブジェクトをリストするエラーメッセージが含まれます。

アセットの接続、ランタイム環境、またはスケジュールがターゲット組織に存在する場合、それらは再利用されます。アセットでターゲット組織内の別の接続またはランタイム環境を使用する場合は、objectSpecificationオブジェクトを使用して、その接続またはランタイム環境を組織内の接続またはランタイム環境にマッピングできます。

例えば、アセットは開発組織ではSecureAgent_devランタイム環境を使用し、テスト組織ではSecureAgent_testランタイム環境を使用します。objectSpecificオブジェクトを使用して、SecureAgent_devランタイム環境をSecureAgent_testランタイム環境にマッピングできます。

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

POST要求

リポジトリから組織に最新バージョンのオブジェクトをロードするには、次のURIを使用します。

/public/core/v3/pull

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

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

フィールド	タイプ	必須	説明
commitHash	String	○	単一のコミットハッシュ。コミットハッシュは操作中に検証されます。 GitHubリポジトリを使用する場合は、完全な文字列の代わりにハッシュの最初の7文字を送信することで、リクエストに部分的なハッシュを含めることができます。
relaxObjectSpecificationValidation	Boolean	×	objectSpecificationオブジェクトで指定されたソースが、プルされるアセットに存在する必要があるかどうか。次のいずれかの値を使用します。 true。プルに含まれるアセットにソースが存在しない場合、objectSpecificationオブジェクトは無視されます。 false。プルに含まれるアセットにobjectSpecificationソースが存在しない場合、エラーが発生します。デフォルトはfalseです。
objects	List<Object>	はい	プルされるすべてのオブジェクトのリストを含みます。
path	List<String>	はい（IDが含まれない場合）。	objectsオブジェクトに含めます。プルされるオブジェクトのフルパス。
id	String	はい（パスが含まれない場合）。	objectsオブジェクトに含めます。オブジェクトのID。
type	String	-	objectsオブジェクトに含めます。プルされるアセットのタイプ。指定されていない場合、デフォルトはprojectです。次のいずれかのタイプです。 DTEMPLATE。マッピング。 MTT。マッピングタスク。 DSS。同期タスク。 DMASK。マスキングタスク。 DRS。レプリケーションタスク。 MAPPLET。 BSERVICE。ビジネスサービス定義。 HSCHEMA。階層スキーマ。 PCS。PowerCenterタスク。 FWCONFIG。固定長の設定。 CUSTOMSOURCE。保存済みクエリ。 MI_TASK。一括取り込みタスク。 WORKFLOW。リニアタスクフロー。 VISIOTEMPLATE TASKFLOW
objectSpecification	List<Object>	-	接続環境とランタイム環境のオブジェクト仕様。
source	Object	はい（objectSpecificationオブジェクトが含まれる場合）およびrelaxObjectSpecificationValidation値がtrueでない	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要求の例

1回のPOST要求で、1つ以上のアセットまたはプロジェクトにプル操作を要求できます。パスフィールドを使用して複数のプロジェクトのプル操作を要求し、プルするプロジェクトを指定するには、次の例のような要求を送信します。

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

{
    "commitHash": "7c525831c247cf792f595d1663396d1ae2c85033",
     "objects": [
        {           
            "path": ["Project2"]
        },
        {
            "path": ["Default"]
        }
    ]
}

プロジェクトIDを使用してプロジェクトのプル操作を要求するには、次の例のような要求を送信します。

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

{
    "commitHash": "7c525831c247cf792f595d1663396d1ae2c85033",
     "objects": [
        {           
            "id": "4gmWUVziA1qe7zXbyN1l6E"
        },
        {
            "id": "4TjbmrAGrk2eal3DOwdIk8"
        }
    ]
}

アセットに対するPOST要求の例

POST要求で1つ以上のアセットにプル操作を要求できます。パスフィールドを使用してアセットのプル操作を要求し、プルするアセットを指定するには、次の例のような要求を送信します。

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

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

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

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

{
    "commitHash": "1013f61bf318758cccec08f2165f59bbbb41e8f0",
     "objects": [
        {           
            "id": "6wLjSK4tS4rdjKq5uGuC0T"
        }
    ]
}

アセットIDを使用してプル操作を要求し、接続を含めるには、次の例のような要求を送信します。

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

{
 
    "commitHash": "1013f61bf318758cccec08f2165f59bbbb41e8f0",
     "objects": [
        {           
            "id": "6wLjSK4tS4rdjKq5uGuC0T"
        }
    ],
    "objectSpecification":[
     {
        "source":
        {
            "path":["ff"],
            "type":"Connection"
        },
        "target":
        {
            "path":["target_connection"],
            "type":"Connection"
        }
     }   
   ]
}

アセットID、ソースランタイム環境、およびターゲットIDを使用してプル操作を要求するには、次の例のような要求を送信します。

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

{
 
    "commitHash": "1013f61bf318758cccec08f2165f59bbbb41e8f0",
     "objects": [
        {           
            "id": "6wLjSK4tS4rdjKq5uGuC0T"
        }
    ],
    "objectSpecification":[
     {
        "source":
        {
            "path":["USW1MJ02YNFB"],
            "type":"AgentGroup"
        },
        "target":
        {
            "id":"7UPtJVbrESTj0VkCBYAcUv"
        }
     }   
   ]
}

POST応答の例

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

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

ソース管理

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

オブジェクトのプル

オブジェクトのプル

POST要求

POST応答

プロジェクトに対するPOST要求の例

アセットに対するPOST要求の例

POST応答の例