REST APIリファレンス

前へ次へ

オブジェクトのバージョンの比較

リソースの比較を使用して、オブジェクトの2つのバージョンを比較し、バージョン間での変更の内容を確認します。

オブジェクトのバージョンを比較するには、プル特権が必要です。

POST要求

オブジェクトの2つのバージョンを比較するには、次のURIを使用します。

/public/core/v3/compare/<asset ID>

応答をJSON形式で受け取るか、Git diff形式を使用してテキストとして受け取るかを指定できます。

要求に次のフィールドを含めます。

フィールド	タイプ	必須	説明
source	String	○	比較するアセットの基本バージョン。次のいずれかの値を使用します。比較するアセットのバージョンがリポジトリにチェックインされている場合は、値にコミットハッシュを使用します。比較するアセットのバージョンがチェックインされていない場合は、次の値を使用します: CURRENT-VERSION
destination	String	○	基本バージョンと比較するアセットのバージョン。アセットのバージョンがリポジトリにチェックインされている場合は、値にコミットハッシュを使用します。アセットのバージョンがチェックインされていない場合は、次の値を使用します: CURRENT-VERSION
outputFormat	String	○	応答の形式。次のいずれかの値を使用します。 JSON TEXT

POST応答

応答本文がTXTで、応答が成功した場合、アセット情報と変更がGit diff応答形式で記録されます。

応答本文がJSONで、応答が成功した場合、POST要求は次の情報を返します。

フィールド	タイプ	説明
source	オブジェクト	更新されたバージョンと比較するアセットの基本バージョン。
name	String	アセットの名前。
path	String	アセットへのフルパス。
updatedOn	String	コミットが yyyy-MM-dd'T'HH:mm:ss.SSSZ 形式で送信されたときのタイムスタンプ
updatedBy	文字列	スケジュールを更新したユーザー。
commitHash	文字列	コミットから取得されたファイルのコミットハッシュ。次のいずれかの値を使用します。コミットハッシュ番号。アセットのバージョンがリポジトリにコミットされている場合に含まれます。 CURRENT-VERSION。アセットの現在のバージョン。バージョンがリポジトリにコミットされていない場合に含まれます。
destination	オブジェクト	ソースバージョンと比較するアセットのバージョン。
name	文字列	アセットの名前。
path	String	アセットへのフルパス。
updatedOn	String	コミットが yyyy-MM-dd'T'HH:mm:ss.SSSZ 形式で送信されたときのタイムスタンプ
updatedBy	文字列	スケジュールを更新したユーザー。
commitHash	文字列	コミットから取得されたファイルのコミットハッシュ。次のいずれかの値を指定できます。コミットハッシュ番号。アセットのバージョンがリポジトリにコミットされている場合に含まれます。 CURRENT-VERSION。アセットの現在のバージョン。バージョンがリポジトリにコミットされていない場合に含まれます。
action	文字列	アセットに対して実行されたアクション。次のいずれかの値を指定できます。 CREATE DELETE UPDATE MOVE MOVE_UPDATE RENAME NO_ACTION
objectId	文字列	オブジェクトのグローバル一意識別子。
lineGroup	配列<オブジェクト>	ソースバージョンと送信先バージョンに対して実行された変更を記述するオブジェクト。
oldChange		変更が削除された行を一覧表示するオブジェクト。
startPosition	Int	削除された変更の最初の行番号。
noOfLinesAffected	Int	影響を受ける行の合計数。
newChange		変更が追加された行を一覧表示するオブジェクト。
startPosition	Int	追加された変更の最初の行番号。
noOfLinesAffected	Int	影響を受ける行の合計数。
unmodifiedLinesBefore	List <String>	影響を受ける行の前の、変更されていない行。最大は3です。
unmodifiedLinesAfter	List <String>	影響を受ける行の後の、変更されていない行。最大は3です。
oldChanges	List <String>	アセットファイルから削除された行。単語のインライン削除は<remove-txt>の間に表示されます。
newChanges	List <String>	アセットファイルに追加された新しい行。単語のインライン追加は<add-txt>の間に表示されます。

POST要求の例

チェックアウトしたアセットと古いバージョンのアセットの比較を要求し、その比較をJSON形式で受け取るには、次の例のような要求を送信します。

POST <baseApiUrl>/public/core/v3/compare/jn94HPOUK4zlEoO07eGfEq
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
  "source": "CURRENT-VERSION",
  "destination": "aca30f6c44de9bef23db59ed16967653481c5e23",
  "outputFormat": "JSON"
}

リポジトリにチェックインされている2つのバージョンの比較を要求し、比較結果をテキスト形式で受け取るには、次の例のような要求を送信します。

POST <baseApiUrl>/public/core/v3/compare/2tDSXSjd2Fkg1AFPSWops3
Content-Type: application/json
Accept: application/text
INFA-SESSION-ID: <sessionId>
{
  "source": "b0bdc63a7fb9047db6c3bc29ad67d5ecbf7d1d47",
  "destination": "fc6fcc318ad1b4aec17017d053bc2f0d1f605096",
  "outputFormat": "TEXT"
}

POST応答の例

チェックアウトしたアセットと古いバージョンのアセットの比較を要求し、JSON形式で応答を受け取った場合、次の例のような応答が返されることがあります。

{
 "source": {
    "name": "TestMapping",
    "path": "Test",
    "updatedOn": null,
    "updatedBy": null,
    "commitHash": "CURRENT-VERSION" 
 },
 "destination": {
    "name": "TestMapping",
    "path": "Test",
    "updatedOn": "2025-05-08T02:15:17.842Z",
    "updatedBy": null,
    "commitHash": "95983a4fe44ee21df1933c5c4b4a5c565c68b832"
 },
 "id": "2tDSXSjd2Fkg1AFPSWops3",
 "action": "UPDATE",
 "lineGroup": [
   {
    "oldChange": {
       "startPosition": 85,
       "noOfLinesAffected": 1
    },
    "newChange": {
       "startPosition": 85,
       "noOfLinesAffected": 1
    },
    "unmodifiedLinesBefore": [
       "      }",
       "    ]",
       "  },"
    ],
    "unmodifiedLinesAfter": [
       "}"
    ],
     "oldChanges": [
       "  \"vcsExportTime\" : \"2025-05-<remove-text>08<remove-text> <remove-text>09:46:09<remove-text> PDT\""
    ],
    "newChanges": [
       "  \"vcsExportTime\" : \"2025-05-<add-text>07<add-text> <add-text>19:15:17<add-text> PDT\""
    ]
  }
 ]
}

リポジトリにチェックインされているアセットの2つのバージョンの比較を要求し、テキスト形式で応答を受け取る場合、次の例のような応答が返されることがあります。

id: 2tDSXSjd2Fkg1AFPSWops3
action: UPDATE
source: {name='TestMapping', path='Test', updatedOn=Thu May 08 02: 14: 35 UTC 2025, updatedBy='null', version='ed08ed8f845fe1602006130a734d4416b7b72436'
}
destination: {name='TestMapping', path='Test', updatedOn=Thu May 08 02: 15: 17 UTC 2025, updatedBy='null', version='95983a4fe44ee21df1933c5c4b4a5c565c68b832'
}
changes:
@@ -2,
0 +2,
0 @@
{
    "content": {
+    "description": "This mapping is used for testing",
        "allowMaxFieldLength": "false",
        "bigIntConvertType": "ONLY_BIGINT",
        "documentType": "MAPPING",
 
@@ -84,
        1 +85,
        1 @@
    }
]
},
-  "vcsExportTime": "2025-05-07 <remove-text>19:14:35<remove-text> PDT"
+  "vcsExportTime": "2025-05-07 <add-text>19:15:17<add-text> PDT"
}

ソース管理

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal