ソース管理
Gitソース管理リポジトリを使用することにより、プロジェクト、フォルダ、アセットなどのInformatica Intelligent Cloud Servicesオブジェクトに加えた変更を管理および追跡できます。
組織のグローバルGitリポジトリを使用できます。組織の管理者がプロジェクトレベルのリポジトリを有効にしている場合は、プロジェクトレベルで設定されたリポジトリを使用するか、グローバルリポジトリを使用することができます。
以下のリソースを使用できます。
- •pull: オブジェクトをInformatica Intelligent Cloud Services組織にロードします。
- •pullByCommitHash.特定のコミットによって変更されたオブジェクトを取得し、組織にロードします。
- •checkout。オブジェクトをリポジトリからチェックアウトします。
- •undoCheckout。指定したオブジェクトのチェックアウトを取り消すか、チェックアウト操作に含まれていたすべてのオブジェクトのチェックアウトを取り消します。
- •checkin。更新されたオブジェクトをリポジトリにチェックインします。
- •commit。コミットに関する詳細をリポジトリから取得します。
- •commitHistory: 組織内の特定のオブジェクトまたはすべてのオブジェクトのコミット履歴を受け取ります。
- •repositoryConnection. プロジェクトレベルのリポジトリのリポジトリ接続IDを取得します。
- •sourceControlAction: ソース管理操作のステータスを取得します。
オブジェクトのプル
pullリソースを使用して、リポジトリからアセットやプロジェクトなどのオブジェクトを取得し、組織にロードします。
プロジェクトをプルすると、プロジェクトとプロジェクトのフォルダ内のすべてのソース管理アセットがプルに含まれます。アセットがターゲット組織にすでに存在する場合、その内容は、指定されたコミットハッシュでのアセットの状態と一致するように上書きされます。プロジェクトとプロジェクトのフォルダがターゲット組織にすでに存在する場合、それらは再利用されます。
オブジェクトは、グローバルリポジトリレベルまたはプロジェクトレベルでプルすることができます。プルするオブジェクトによって、使用されるリポジトリが決定されます。例えば、プロジェクトAがRepo1にリンクされている場合、プルはRepo1から行います。プロジェクトBがプロジェクトレベルのリポジトリにリンクされていない場合、プルはグローバルリポジトリから行います。
他のプロジェクトにある依存オブジェクトはプルには含まれません。プルリクエストで依存オブジェクトが欠落している場合、応答には欠落している依存オブジェクトをリストするエラーメッセージが含まれます。
アセットの接続、ランタイム環境、またはスケジュールがターゲット組織に存在する場合、それらは再利用されます。アセットでターゲット組織内の別の接続またはランタイム環境を使用する場合は、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。レプリケーションタスク。
- - DMAPPLET。データ統合で作成されたマップレット。
- - MAPPLET。PowerCenterマップレット。
- - BSERVICE。ビジネスサービス定義。
- - HSCHEMA。階層スキーマ。
- - PCS。PowerCenterタスク。
- - FWCONFIG。固定長の設定。
- - CUSTOMSOURCE。保存済みクエリ。
- - MI_TASK。一括取り込みタスク。
- - WORKFLOW。リニアタスクフロー。
- - TASKFLOW
- - UDF。ユーザー定義関数。
|
objectSpecification | List<Object> | - | 接続環境とランタイム環境のオブジェクト仕様。 |
source | Object | はい(objectSpecificationオブジェクトが含まれる場合)およびrelaxObjectSpecificationValidation値がtrueでない | objectSpecificationオブジェクトに含めます。 ソースオブジェクトに関する情報を含みます。 |
path | List<String> | はい(objectSpecificationオブジェクトが含まれる場合) | ソースオブジェクトに含めます。 リポジトリの接続またはランタイム環境のフルパス。 |
type | String | はい(objectSpecificationオブジェクトが含まれる場合) | ソースオブジェクトに含めます。 アセットタイプ。次のいずれかの値を使用します。 |
target | Object | はい(objectSpecificationオブジェクトが含まれる場合) | objectSpecificationオブジェクトに含めます。 ターゲットオブジェクトに関する情報を含みます。 パスとタイプまたはIDを含めます。パス、タイプ、IDが含まれる場合、IDが優先されます。 |
path | List<String> | はい(IDが含まれない場合)。 | ターゲットオブジェクトに含めます。 マップされている接続またはランタイム環境のパス。 タイプで使用します。 |
type | String | はい(IDが含まれない場合)。 | ターゲットオブジェクトに含めます。 アセットタイプ。 パスで使用します。 次のいずれかの値を使用します。 |
id | String | はい(パスとタイプが含まれない場合) | ターゲットオブジェクトに含めます。 ターゲットオブジェクトのID。 |
additionalProviderFlags | Collection<複合型> | いいえ | 追加のオブジェクト指定。 キーと値のペアを使用して、入出力パラメータ値やシーケンスジェネレータ値などの追加のオブジェクト指定を指定します。 |
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"
}
}
コミット内のオブジェクトのプル
pullByCommitHashリソースを使用して、特定のコミットによって変更されたオブジェクトを取得し、組織にロードします。
pullByCommitHashリソースを使用する場合は、要求にコミットハッシュを含めます。そのコミットで変更されたオブジェクトがプルに含まれます。パスまたはオブジェクトIDでオブジェクトをプルする場合は、代わりにpullリソースを使用してください。
プロジェクトレベルのリポジトリを使用する場合は、repoConnectionIdフィールドをpullByCommitHash要求に含めます。プロジェクトのrepoConnectionIdは、repositoryConnection要求を送信することで確認できます。repoConnectionIdの検索の詳細については、
リポジトリ接続の詳細の取得を参照してください。
アセットで別の接続またはランタイム環境を使用する場合は、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オブジェクトが含まれる場合) | ソースオブジェクトに含めます。 アセットタイプ。次のいずれかの値を使用します。 |
target | Object | はい(objectSpecificationオブジェクトが含まれる場合) | objectSpecificationオブジェクトに含めます。 ターゲットオブジェクトに関する情報を含みます。 パスとタイプまたはIDを含めます。パス、タイプ、IDが含まれる場合、IDが優先されます。 |
path | List<String> | はい(IDが含まれない場合)。 | ターゲットオブジェクトに含めます。 接続またはランタイム環境の名前。 タイプで使用します。 |
type | String | はい(IDが含まれない場合)。 | ターゲットオブジェクトに含めます。 アセットタイプ。 パスで使用します。 次のいずれかの値を使用します。 |
id | String | はい(パスとタイプが含まれない場合) | ターゲットオブジェクトに含めます。 ターゲットオブジェクトのID。 |
additionalProviderFlags | Collection<複合型> | いいえ | 追加のオブジェクト指定。 キーと値のペアを使用して、入出力パラメータ値やシーケンスジェネレータ値などの追加のオブジェクト指定を指定します。 |
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"
}
}
オブジェクトのチェックアウト
チェックアウトリソースを使用して、ソース管理オブジェクトをチェックアウトし、変更を加えられるようにします。オブジェクトをチェックアウトすると、そのオブジェクトはロックされるため、他のユーザーはそのオブジェクトを変更できません。
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。レプリケーションタスク。
- - DMAPPLET。データ統合で作成されたマップレット。
- - MAPPLET。PowerCenterマップレット。
- - BSERVICE。ビジネスサービス定義。
- - HSCHEMA。階層スキーマ。
- - PCS。PowerCenterタスク。
- - FWCONFIG。固定長の設定。
- - CUSTOMSOURCE。保存済みクエリ。
- - MI_TASK。一括取り込みタスク。
- - WORKFLOW。リニアタスクフロー。
- - TASKFLOW
- - UDF。ユーザー定義関数。
- - 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"
}
}
チェックアウトの取り消し
チェックアウトを元に戻すには、undoCheckoutリソースを使用します。オブジェクトは、プルされた最後のバージョンに戻ります。
アセット、プロジェクト、またはフォルダのチェックアウトを取り消すことができます。チェックアウトに含まれていたすべてのオブジェクトのチェックアウトを取り消すこともできます。管理者としてログインしている場合は、別のユーザーが実行したチェックアウトを取り消すことができます。
POST要求
チェックアウトを取り消すには、次のURIを使用します。
/public/core/v3/undoCheckout
要求には、チェックアウトの取り消し操作を実行する各オブジェクトのIDまたはパスとタイプを含めます。または、チェックアウト操作IDを含めて、チェックアウトアクションに含まれていたすべてのオブジェクトのチェックアウトを取り消します。
注: ソース管理ログは7日間保持されます。チェックアウトの実行から7日超が経過すると、チェックアウト操作IDは存在しなくなるため、チェックアウトの取り消し操作で使用できなくなります。
アセットで別の接続またはランタイム環境を使用する場合は、objectSpecificationオブジェクトを使用して、その接続またはランタイム環境を組織内の接続またはランタイム環境にマッピングできます。
要求に以下のフィールドを含めることができます。
フィールド | タイプ | 必須 | 説明 |
---|
checkoutOperationId | String | いいえ | チェックアウト操作ID。指定した場合、チェックアウト操作に含まれていたすべてのアセットが元の状態に戻ります。 |
objects | List<Object> | いいえ | チェックアウトの取り消し操作に含まれるすべてのオブジェクトのリストを含みます。 |
id | String | はい(オブジェクトのパスとタイプが含まれず、チェックアウト操作IDも含まれない場合) | objectsオブジェクトに含めます。 オブジェクトのID。 |
path | List<String> | はい(オブジェクトのIDが含まれず、チェックアウト操作IDも含まれない場合) | objectsオブジェクトに含めます。 オブジェクトのフルパス。 |
type | String | はい(オブジェクトのIDが含まれず、チェックアウト操作IDも含まれない場合) | objectsオブジェクトに含めます。 アセットのタイプ。 次のいずれかのタイプです。 - - DTEMPLATE。マッピング。
- - MTT。マッピングタスク。
- - DSS。同期タスク。
- - DMASK。マスキングタスク。
- - DRS。レプリケーションタスク。
- - DMAPPLET。データ統合で作成されたマップレット。
- - MAPPLET。PowerCenterマップレット。
- - BSERVICE。ビジネスサービス定義。
- - HSCHEMA。階層スキーマ。
- - PCS。PowerCenterタスク。
- - FWCONFIG。固定長の設定。
- - CUSTOMSOURCE。保存済みクエリ。
- - MI_TASK。一括取り込みタスク。
- - WORKFLOW。リニアタスクフロー。
- - TASKFLOW
- - UDF。ユーザー定義関数。
- - PROCESS。アプリケーションの統合プロセス。
- - AI_CONNECTION。アプリケーションの統合アプリの接続。
- - AI_SERVICE_CONNECTOR。アプリケーションの統合サービスコネクタ。
- - GUIDE。アプリケーションの統合ガイド。
- - PROCESS_OBJECT。アプリケーションの統合プロセスオブジェクト。
- - HUMAN_TASK。アプリケーションの統合ヒューマンタスク。
|
includeContainerAssets | Boolean | いいえ | objectsオブジェクトに含めます。 プロジェクトとフォルダに適用されます。 プロジェクトまたはフォルダ内のすべてのオブジェクトがチェックアウトの取り消し操作に含まれているかどうか。以下のいずれかの値を使用します。 - - true。プロジェクトまたはフォルダ内のすべてのオブジェクトを含めます。
- - false。プロジェクトまたはフォルダ内のオブジェクトを含めません。
デフォルトはfalseです。 |
objectSpecification | List<Object> | いいえ | 接続環境とランタイム環境のオブジェクト仕様。 |
source | Object | はい(objectSpecificationオブジェクトが含まれる場合) | objectSpecificationオブジェクトに含めます。 ソースオブジェクトに関する情報を含みます。 |
path | List<String> | はい(objectSpecificationオブジェクトが含まれる場合) | ソースオブジェクトに含めます。 リポジトリの接続またはランタイム環境のフルパス。 |
type | String | はい(objectSpecificationオブジェクトが含まれる場合) | ソースオブジェクトに含めます。 アセットタイプ。次のいずれかの値を使用します。 |
target | Object | はい(objectSpecificationオブジェクトが含まれる場合) | objectSpecificationオブジェクトに含めます。 ターゲットオブジェクトに関する情報を含みます。 パスとタイプまたはIDを含めます。パス、タイプ、IDが含まれる場合、IDが優先されます。 |
path | List<String> | はい(IDが含まれない場合)。 | ターゲットオブジェクトに含めます。 接続またはランタイム環境のパス。 タイプで使用します。 |
type | String | はい(IDが含まれない場合)。 | ターゲットオブジェクトに含めます。 アセットタイプ。 パスで使用します。 次のいずれかの値を使用します。 |
id | String | はい(パスとタイプが含まれない場合) | ターゲットオブジェクトに含めます。 ターゲットオブジェクトのID。 |
additionalProviderFlags | Collection<複合型> | いいえ | 追加のオブジェクト指定。 キーと値のペアを使用して、入出力パラメータ値やシーケンスジェネレータ値などの追加のオブジェクト指定を指定します。 |
POST応答
成功した場合、POST要求は次の情報を返します。
フィールド | タイプ | 説明 |
---|
id | String | チェックアウトの取り消し操作のID。 |
status | Object | チェックアウトの取り消し操作のステータス。 |
state | String | ステータスのオブジェクトで返されます。 チェックアウトの取り消し操作の初期状態。要求が成功した場合、値は常にNOT_STARTEDになります。 操作開始後にステータスを確認するには、 ソース管理操作のステータスの取得リソースを使用します。 |
message | String | ステータスのオブジェクトで返されます。 チェックアウトの取り消し操作のわかりやすいステータスメッセージ。 |
POST要求の例
アセットIDを使用してチェックアウトの取り消し操作を要求するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/undoCheckout
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"objects": [
{
"id": "4gmWUVziA1qe7zXbyN1l6E"
},
{
"id": "4TjbmrAGrk2eal3DOwdIk8"
}
]
}
パスでアセットにチェックアウトの取り消し操作を要求するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/undoCheckout
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"objects": [
{
"path": ["Default","Test_Mapping1"],
"type": "DTEMPLATE"
},
{
"path": ["Default","Test_Mapping2"],
"type": "DTEMPLATE"
}
]
}
アセットにチェックアウトの取り消し操作を要求し、ソース接続およびランタイム環境をターゲット接続およびランタイム環境にマッピングするには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/undoCheckout
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"objects": [
{
"id": "6wLjSK4tS4rdjKq5uGuC0T"
}
],
"objectSpecification":[
{
"source":
{
"path":["ff"],
"type":"Connection"
},
"target":
{
"path":["target_connection"],
"type":"Connection"
}
},
{
"source": {
"path": ["USW1MJ02YNFB"],
"type": "AgentGroup"
},
"target": {
"id": "2ga6h3hRNZCf9Br0ZWB7EF"
}
}
]
}
チェックアウト操作IDを使用してチェックアウトの取り消し操作を要求するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/undoCheckout
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"checkoutOperationId": "<checkout operation ID>"
}
POST応答の例
どの要求の例でも、次の例のような応答を受信します。
{
"id": "awRrziMMWXol7i42aTm1ih",
"status": {
"state": "NOT_STARTED",
"message": "Initialized"
}
}
オブジェクトのチェックイン
checkinリソースを使用して、更新されたオブジェクトをリポジトリにチェックインします。
POST要求
オブジェクトをリポジトリにチェックインするには、次のURIを使用します。
/public/core/v3/checkin
要求では、オブジェクトIDまたはフルパスとオブジェクトタイプのいずれかを指定する必要があります。
要求に以下のフィールドを含めることができます。
フィールド | タイプ | 必須 | 説明 |
---|
objects | List<Object> | はい | チェックインされるすべてのオブジェクトのリストを含みます。単一のアセットをチェックインすることも、任意の数のプロジェクトまたはフォルダをチェックインすることもできます。 |
id | String | はい(パスとタイプが含まれない場合) | objectsオブジェクトに含めます。 オブジェクトのID。 |
path | List<String> | はい(IDが含まれない場合)。 | objectsオブジェクトに含めます。 チェックインされるオブジェクトのフルパス。 |
type | String | はい(IDが含まれない場合)。 | objectsオブジェクトに含めます。 チェックインされるアセットのタイプ。 次のいずれかのタイプです。 - - DTEMPLATE。マッピング。
- - MTT。マッピングタスク。
- - DSS。同期タスク。
- - DMASK。マスキングタスク。
- - DRS。レプリケーションタスク。
- - DMAPPLET。データ統合で作成されたマップレット。
- - MAPPLET。PowerCenterマップレット。
- - BSERVICE。ビジネスサービス定義。
- - HSCHEMA。階層スキーマ。
- - PCS。PowerCenterタスク。
- - FWCONFIG。固定長の設定。
- - CUSTOMSOURCE。保存済みクエリ。
- - MI_TASK。一括取り込みタスク。
- - WORKFLOW。リニアタスクフロー。
- - TASKFLOW
- - UDF。ユーザー定義関数。
- - PROCESS。アプリケーションの統合プロセス。
- - AI_CONNECTION。アプリケーションの統合アプリの接続。
- - AI_SERVICE_CONNECTOR。アプリケーションの統合サービスコネクタ。
- - GUIDE。アプリケーションの統合ガイド。
- - PROCESS_OBJECT。アプリケーションの統合プロセスオブジェクト。
- - HUMAN_TASK。アプリケーションの統合ヒューマンタスク。
|
includeContainerAssets | Boolean | - | objectsオブジェクトに含めます。 プロジェクトまたはフォルダ内のすべてのオブジェクトがチェックインに含まれているかどうか。以下のいずれかの値を使用します。 - - true。プロジェクトまたはフォルダ内のすべてのオブジェクトを含めます。
- - false。プロジェクトまたはフォルダ内のオブジェクトを含めません。
デフォルトはfalseです。 |
サマリ | String | ○ | チェックインのサマリ。 最大長は255文字です。 |
description | String | - | チェックインの説明。 |
POST応答
成功した場合、POST要求は次の情報を返します。
フィールド | タイプ | 説明 |
---|
Id | String | チェックイン操作のID。 |
status | Object | チェックイン操作のステータス。 |
state | String | ステータスのオブジェクトで返されます。 チェックイン操作の初期状態。要求が成功した場合、値は常にNOT_STARTEDになります。 操作開始後にステータスを確認するには、sourceControlActionリソースを使用します。 |
message | String | ステータスのオブジェクトで返されます。 チェックイン操作のわかりやすいステータスメッセージ。 |
プロジェクトに対するPOST要求の例
1回のPOST要求で、1つ以上のプロジェクトにチェックイン操作を要求できます。プロジェクトのチェックイン操作を要求し、プロジェクトにすべてのアセットを含めるには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/checkin
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"objects": [
{
"id": "3iWWHkLbM2giVppBmJmZgV",
"includeContainerAssets": true
}
],
"summary": "Revised mappings",
"description": "Revised m_custArch and m_custNew"
}
パスとオブジェクトタイプを使用してアセットにチェックイン操作を要求するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/checkin
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"objects": [
{
"path": [
"Default",
"Test_Mapping"
],
"type": "DTEMPLATE"
}
]
}
アセットに対するPOST要求の例
POST要求で1つのアセットにチェックイン操作を要求できます。DefaultプロジェクトにあるTest_Mappingと名付けられたセットにチェックイン操作を要求するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/checkin
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"objects": [
{
"path": [
"Default",
"Test_Mapping"
],
"type": "DTEMPLATE"
}
]
}
アセットIDを使用してチェックイン操作を要求するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/checkin
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"objects": [
{
"id": "3iWWHkLbM2giVppBmJmZgV"
}
],
"summary": "Revised Revised m_custArch"
}
POST応答の例
POST応答は次の例のようになります。
{
"Id": "awRrziMMWXol7i42aTm1ih",
"status": {
"state": "NOT_STARTED",
"message": "Initialized"
}
}
コミットの詳細の取得
commitリソースを使用して、コミットに関する詳細をリポジトリから取得します。
GET要求
コミットの詳細を取得するには、次のURIを使用します:
/public/core/v3/commit/<commitHash>
URIでオプションのクエリパラメータを含めることができます。
フィールド | タイプ | 必須 | 説明 |
---|
searchCustomRepositories | Boolean | - | グローバルリポジトリのコミットハッシュが見つからなかった場合にプロジェクトレベルのリポジトリを検索するかどうかを示します。 |
repoConnectionId | String | - | 検索するプロジェクトレベルのリポジトリの接続ID。 リポジトリ接続IDを見つけるには、repositoryConnection要求を送信します。詳細については、<新しいリポジトリ接続の詳細の取得トピックへのリンク>を参照してください。 |
GET応答
成功した場合、GET要求は次の情報を返します。
フィールド | タイプ | 説明 |
---|
hash | String | コミットの一意のID。この値は、pullByCommitHash要求で使用できます。 |
サマリ | String | コミットハッシュに関連付けられたサマリ。 |
description | String | コミットハッシュに関連付けられた詳細な説明。 |
username | String | コミットを実行したユーザーの名前。 |
email | String | コミットを実行したユーザーの電子メールアドレス。 |
date | Date | コミットがyyyy-MM-dd'T'HH:mm:ss.SSSZ形式で送信されたときのタイムスタンプ |
committer | String | コミットをファイル作成したGitユーザー。 |
changes | List <Object> | コミットに含まれる各オブジェクトの変更の詳細を含みます。 |
id | String | changesオブジェクトに含まれます。 オブジェクトのグローバル一意識別子。 オブジェクトが現在組織に存在する場合に含まれます。 |
appContextId | String | changesオブジェクトに含まれます。 REST APIバージョン2の呼び出しで使用されるコンテキスト内のオブジェクトのID。 オブジェクトが現在組織に存在する場合に含まれます。 |
name | String | changesオブジェクトに含まれます。 アセット、プロジェクト、またはフォルダの名前。 |
type | String | changesオブジェクトに含まれます。 オブジェクトのタイプ。 |
path | List <String> | changesオブジェクトに含まれます。 オブジェクトのフルパス。 |
oldPath | List <String> | changesオブジェクトに含まれます。 コミット前のオブジェクトのリモートリポジトリパス。オブジェクトが移動されたかその名前が変更された場合に含まれます。 |
action | String | changesオブジェクトに含まれます。 コミット中にオブジェクトに加えられた変更のタイプを示します。次のいずれかの値を含みます。 - - ADDED
- - DELETED
- - MODIFIED
- - MOVED
|
GET応答の例
GET応答は次の例のようになります。
{
"hash": "aca30f6c44de9bef23db59ed16967653481c5e23",
"summary": "Update. ",
"description": "Restructured and updated.",
"username": "testuser",
"email": "user@gmail.com",
"date": "2019-05-13T17:50:46.000Z"
"committer": "Alexander Freeman",
"changes": [
{
"id": "5G15DJ19Fw3j20XGL6oooL",
"appContextId": "N0A1700000000001J",
"name": "Mapping1",
"type": "DTEMPLATE",
"path": ["Versioned_Project2","Mapping1"],
"action": "MODIFIED"
},
{
"id": "2jFxl7stzKgi3lKAtVpWi3",
"appContextId": "N0A17000000003A02",
"name": "Versioned_Project",
"type": "Project",
"path": ["Versioned_Project"],
"action": "ADDED"
},
{
"id": "k3SYVglqhAafSWHuQuZdm1",
"appContextId": "N0F17000000000291",
"name": "Versioned_Folder",
"type": "Folder",
"path": ["Versioned_Project", "Versioned_Folder"],
"oldPath": ["Versioned_Project", "Test_Folder"],
"action": "MOVED"
},
{
"id": null,
"appContextId": null,
"name": "Mapping2",
"type": "DTEMPLATE",
"path": ["Versioned_Project2","Mapping2"],
"action": "DELETED"
}
]
}
コミット履歴の取得
commitHistoryリソースを使用して、組織のソース管理オブジェクトのコミット履歴を取得します。
ソース管理オブジェクト、特定のプロジェクトまたはフォルダ、または特定のアセットすべてのコミット履歴を要求できます。クエリパラメータを使用して、特定の[エクスプローラ]ページまたは指定したページ数のオブジェクトすべてのコミット履歴を要求することもできます。
GET要求
組織のプロジェクトとアセットのすべてのコミット履歴を要求したり、特定のプロジェクトまたはアセットの履歴を要求できます。
コミット履歴を取得するには、次のURIを使用します。
/public/core/v3/commitHistory?<query parameters>
組織のすべてのオブジェクトのコミット履歴を取得するには、クエリパラメータを省略します。
特定のプロジェクトまたはアセットのコミット履歴を取得するには、次のクエリパラメータをURIに追加します。
パラメータ | タイプ | 説明 |
---|
q | String | クエリフィルタの文字列。オブジェクトID、プロジェクト名またはフォルダ名、またはアセットタイプを含めます。 |
perPage | String | ページごとに含まれるエントリの数。最大エントリ数は100です。 デフォルトは100です。 |
ページ | String | 結果の指定したページを示します。 デフォルトはページ1です。 |
以下のフィールドを使用してクエリフィルタを定義できます。
フィールド | タイプ | 演算子 | 説明 |
---|
id | String | == | プロジェクト、フォルダ、アセットのID。 |
path | String | == | アセットがあるプロジェクトまたはパス。 |
type | String | == | アセットタイプ。アセットのコミット履歴を受信するのに必須。 次のいずれかのタイプです。 - - DTEMPLATE。マッピング。
- - MTT。マッピングタスク。
- - DSS。同期タスク。
- - DMASK。マスキングタスク。
- - DRS。レプリケーションタスク。
- - DMAPPLET。データ統合で作成されたマップレット。
- - MAPPLET。PowerCenterマップレット。
- - BSERVICE。ビジネスサービス定義。
- - HSCHEMA。階層スキーマ。
- - PCS。PowerCenterタスク。
- - FWCONFIG。固定長の設定。
- - CUSTOMSOURCE。保存済みクエリ。
- - MI_TASK。一括取り込みタスク。
- - WORKFLOW。リニアタスクフロー。
- - TASKFLOW
- - UDF。ユーザー定義関数。
- - PROCESS。アプリケーションの統合プロセス。
- - AI_CONNECTION。アプリケーションの統合アプリの接続。
- - AI_SERVICE_CONNECTOR。アプリケーションの統合サービスコネクタ。
- - GUIDE。アプリケーションの統合ガイド。
- - PROCESS_OBJECT。アプリケーションの統合プロセスオブジェクト。
- - HUMAN_TASK。アプリケーションの統合ヒューマンタスク。
|
ブランチ | 文字列 | == | リポジトリブランチ(組織に設定されているブランチと異なる場合)。 |
クエリの例
クエリパラメータを使用して特定のオブジェクトのコミット履歴を取得する例を以下に示します。
- •IDを使用する単一のアセットまたはフォルダのコミット履歴:
GET /public/core/v3/commitHistory?q=id=='23546'
- •IDを使用する2つのプロジェクトのコミット履歴:
GET /public/core/v3/commitHistory?q=id=='23423' and id=='5645esf'
- •パスを使用する2つのプロジェクトのコミット履歴:
GET /public/core/v3/commitHistory?q=path=='project name 1' and path=='project name 2'
- •パスを使用するアセットのコミット履歴:
GET /public/core/v3/commitHistory?q=path=='ProjectName/FolderName/AssetName1' and type=='DTEMPLATE'
GET応答
最新のコミットが最初にリストされているコミットのリストを返します。エラーが発生した場合はエラーを返します。
成功した場合、commitsオブジェクトに各コミットの次の情報を返します。
フィールド | タイプ | 説明 |
---|
commits | List<Object> | commitsのすべてのリスト。 |
hash | String | コミットの一意のID。 |
summary | String | コミットハッシュに関連付けられたサマリ。 |
description | String | コミットハッシュに関連付けられた詳細な説明。 |
username | String | コミットを実行したユーザーの名前。 |
email | String | コミットを実行したユーザーの電子メールアドレス。 |
date | Date | コミットがyyyy-MM-dd'T'HH:mm:ss.SSSZ形式で送信されたときのタイムスタンプ |
committer | String | コミットをファイル作成したGitユーザー。 |
pagination | Object | ページの情報。 |
pageSize | Int | ページの要素数。 |
currentPage | Int | 現在のページ番号。 |
hasNext | Boolean | 現在のページの後に別のページがあるかどうか。 |
GET応答の例
成功した場合、次の例のような応答を受信します。
{
"commits": [
{
"hash": "b0bdc63a7fb9047db6c3bc29ad67d5ecbf7d1d47",
"summary": "Default Project v1",
"description": "Default Project v1",
"username": "testuser@gmail.com",
"email": "testuser@gmail.com",
"date": "2020-03-30T22:30:19.000Z",
"committer": "testuserinfa"
},
{
"hash": "fc6fcc318ad1b4aec17017d053bc2f0d1f605096",
"summary": "Synchronization Task1 - Copy 1 v1",
"description": "Synchronization Task1 - Copy 1 v1",
"username": "testuser@gmail.com",
"email": "testuser@gmail.com",
"date": "2020-03-30T22:22:02.000Z",
"committer": "testuserinfa"
},
{
"hash": "74d776c574dad3bc5cf7a44b22195cf423560fe9",
"summary": "Project2 Folder1 v1",
"description": null,
"username": "testuser@gmail.com",
"email": "testuser@gmail.com",
"date": "2020-03-30T22:17:48.000Z",
"committer": "testuserinfa"
},
{
"hash": "02c8b5950df4ef2110288ba7f77a220bc6f05b0a",
"summary": "v1 of project2",
"description": "v1 of project2",
"username": "testuser@gmail.com",
"email": "testuser@gmail.com",
"date": "2020-03-24T23:41:52.000Z",
"committer": "testuserinfa"
},
],
"pagination": null
}
リポジトリ接続の詳細の取得
repositoryConnectionリソースを使用して、特定のプロジェクトIDのリポジトリ接続IDやプロジェクト名などのリポジトリの詳細を取得します。1つの要求で1つ以上のプロジェクトのリポジトリの詳細を取得できます。
応答に含まれるリポジトリ接続IDを使用して、プロジェクトレベルのリポジトリ内のオブジェクトに対してpullByCommitHash要求を送信します。
GET要求
特定のプロジェクトのリポジトリ接続の詳細を取得するには、次のURLを使用します:
/public/core/v3/repositoryConnection
要求に以下のフィールドを含めることができます。
フィールド | タイプ | 必須 | 説明 |
---|
projectIds | 文字列のリスト | - | リポジトリ接続の詳細を検索するプロジェクトID。 |
projectNames | 文字列のリスト | - | リポジトリ接続の詳細を検索するプロジェクト名。 |
GET応答
成功した場合、GET要求は次の情報を返します。
フィールド | タイプ | 説明 |
---|
pullActionId | String | プル操作のID。 |
projectRepoConnections | List <Object> | 要求に含まれる各プロジェクトIDまたはプロジェクト名のリポジトリの詳細を含むオブジェクト。 |
projectId | String | projectRepoConnectionsオブジェクトで返されます。 プロジェクトのID。要求にプロジェクトIDが含まれていた場合に含まれます。 |
projectNames | String | projectRepoConnectionsオブジェクトで返されます。 プロジェクトの名前。要求にプロジェクト名が含まれていた場合に含まれます。 |
gitRepositoryURL | 文字列 | GitリポジトリのURL。 |
gitRepositoryBranch | 文字列 | Gitリポジトリのブランチ。 |
globalRepository | Boolean | プロジェクトがグローバルGitリポジトリで設定されているかどうかを示します。trueの場合、repoConnectionIdはNULLです。 |
repoConnectionId | 文字列 | プロジェクトのリポジトリ接続ID。 プロジェクトがプロジェクトレベルのGitリポジトリで設定されていない場合はNULLです。 |
GET要求の例
プロジェクトIDを使用して2つのプロジェクトのリポジトリ接続の詳細を要求する場合、要求は次の例のようになります:
https://{{pod_link}}/saas/public/core/v3/repositoryConnection?projectIds=6ub6oUKHJ8Dkr3QXbGG9Sm,5FmdSKPASroei2vyeXwFeT
GET応答の例
要求が成功した場合、GET応答は次の例のようになります。
{
"projectRepoConnections": [
{
"projectId": "6ub6oUKHJ8Dkr3QXbGG9Sm",
"projectNames": "customProject2",
"globalRepository": false,
"gitRepositoryURL": "https://priraj@dev.azure.com/priraj/infa-cloud-vcs-azure/_git/infa-cloud-vcs-azure",
"gitRepositoryBranch": "main",
"repoConnectionId": "1rMeeN2te0TetGYVtRS3GS"
},
{
"projectId": "5FmdSKPASroei2vyeXwFeT",
"projectNames": "TestProject",
"globalRepository": true,
"gitRepositoryURL": "https://priraj@dev.azure.com/priraj/infa-cloud-vcs/_git/infa-cloud-vcs",
"gitRepositoryBranch": "main",
"repoConnectionId": null
}
]
}
ソース管理操作のステータスの取得
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."
}
]
}