DokumentationExperience PlatformHandbuch zu Sandboxes

Packages-Endpunkt

Last update: Tue Oct 14 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Benutzende
  • Admin
  • Führungskraft

Mit den Sandbox-Tools können Sie verschiedene Artefakte (auch als Objekte bezeichnet) auswählen und in ein Paket exportieren. Ein Paket kann aus einem einzelnen Artefakt oder aus mehreren Artefakten (z. B. Datensätzen oder Schemata) bestehen. Alle Artefakte, die in einem Paket enthalten sind, müssen aus derselben Sandbox stammen.

Der /packages-Endpunkt in der Sandbox-Tooling-API ermöglicht Ihnen die programmgesteuerte Verwaltung von Paketen in Ihrer Organisation, einschließlich der Veröffentlichung eines Pakets und des Imports eines Pakets in eine Sandbox.

Erstellen eines Pakets create

Sie können ein Paket mit mehreren Artefakten erstellen, indem Sie eine POST-Anfrage an den /packages-Endpunkt senden und dabei Werte für den Namen und den Pakettyp Ihres Pakets angeben.

API-Format

POST /packages/

Anfrage

curl -X POST \
  https://platform.adobe.io/data/foundation/exim/packages \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d'{
      "name": "acme",
      "description": "Acme Business Group",
      "packageType": "PARTIAL",
      "sourceSandbox": {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
      },
      "expiry": "2023-05-20T20:05:10Z",
      "artifacts": [
        {
          "id": "27115daa-c92b-4f17-a077-d65ffeb0c525",
          "type": "PROFILE_SEGMENT",
          "title": "Acme Profile Segment"
        }
      ]
  }'
Eigenschaft
Beschreibung
Typ
Erforderlich
name
Der Name Ihres Pakets.
Zeichenfolge
Ja
description
Eine Beschreibung, um weitere Informationen zu Ihrem Paket bereitzustellen.
Zeichenfolge
Nein
packageType
Der Pakettyp ist PARTIAL um anzugeben, dass Sie bestimmte Artefakte in ein Paket aufnehmen.
String
JA
sourceSandbox
Die Quell-Sandbox des Pakets.
Objekt
Nein
expiry
Der Zeitstempel, der das Ablaufdatum für das Paket definiert. Der Standardwert liegt 90 Tage ab dem Erstellungsdatum. Das Feld für den Ablauf der Antwort lautet Epoche UTC-Zeit.
Zeichenfolge (UTC-Zeitstempelformat)
Nein
artifacts
Eine Liste von Artefakten, die in das Paket exportiert werden sollen. Der artifacts sollte null oder leer sein, wenn die packageType FULL ist.
Array
Nein

Antwort

Eine erfolgreiche Antwort gibt Ihr neu erstelltes Paket zurück. Die Antwort enthält die entsprechende Paket-ID sowie Informationen zum Status, zum Ablauf und zur Liste der Artefakte.

{
    "id": "209f886b00444eac9bb5836fe32e7681",
    "version": 0,
    "createdDate": 1684475012105,
    "modifiedDate": 1684475012105,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "tenantId": "c875b077162b40409c1327b16da99c1b",
    "requestId": "devxa54a6b56d04f46119d9e3cc006fcc1cb",
    "userId": "platform_exim",
    "name": "acme",
    "description": "Acme Business Group",
    "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
    "sourceSandbox": {
        "name": "cjm-mr",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    },
    "packageType": "PARTIAL",
    "expiry": 1684613110000,
    "status": "DRAFT",
    "artifactsList": [
        {
            "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29",
            "type": "JOURNEY",
            "found": false,
            "count": 0
        }
    ]
}

Aktualisieren eines Pakets update

Verwenden Sie den /packages-Endpunkt in der Sandbox-Tooling-API, um ein Paket zu aktualisieren.

Hinzufügen von Artefakten zu einem Paket add-artifacts

Um Artefakte zu einem Paket hinzuzufügen, müssen Sie einen id angeben und ADD für die action einschließen.

API-Format

PUT /packages/

Anfrage

curl -X PUT \
  https://platform.adobe.io/data/foundation/exim/packages \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d'{
      "id": "6fa50baedd344a278129a87e68cc9dc7",
      "action": "ADD",
      "expiry": "2023-05-20T20:05:10Z",
      "artifacts": [
        {
         "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29@1647559351683",
         "type": "JOURNEY"
        }
      ]
  }'
Eigenschaft
Beschreibung
Typ
Obligatorisch
id
Die ID des zu aktualisierenden Pakets.
Zeichenfolge
Ja
action
Um Artefakte in das Paket einzufügen, sollte der Aktionswert "". Diese Aktion wird nur für Pakettypen PARTIAL unterstützt.
Zeichenfolge
Ja
artifacts
Eine Liste von Artefakten, die dem Paket hinzugefügt werden sollen. Das Paket wird nicht geändert, wenn die Liste null oder leer. Artefakte werden dedupliziert, bevor sie dem Paket hinzugefügt werden. Eine vollständige Liste der unterstützten Artefakte finden Sie in der folgenden Tabelle.
Array
Nein
expiry
Der Zeitstempel, der das Ablaufdatum für das Paket definiert. Der Standardwert liegt bei 90 Tagen ab dem Zeitpunkt, zu dem die PUT-API aufgerufen wird, wenn in der Payload kein Ablauf angegeben ist. Das Feld für den Ablauf der Antwort lautet Epoche UTC-Zeit.
Zeichenfolge (UTC-Zeitstempelformat)
Nein

Die folgenden Artefakttypen werden derzeit unterstützt.

Artefakt
Plattform
Objekt
Teilstrom
Vollständige Sandbox
JOURNEY
Adobe Journey Optimizer
Journeys
Ja
Nein
ID_NAMESPACE
Customer Data Platform
Identitäten
Ja
Ja
REGISTRY_DATATYPE
Customer Data Platform
Datentyp
Ja
Ja
REGISTRY_CLASS
Customer Data Platform
Klasse
Ja
Ja
REGISTRY_MIXIN
Customer Data Platform
Feldergruppe
Ja
Ja
REGISTRY_SCHEMA
Customer Data Platform
Schemata
Ja
Ja
CATALOG_DATASET
Customer Data Platform
Datensätze
Ja
Ja
DULE_CONSENT_POLICY
Customer Data Platform
Einverständnis- und Governance-Richtlinien
Ja
Ja
PROFILE_SEGMENT
Customer Data Platform
Zielgruppen
Ja
Ja
FLOW
Customer Data Platform
Datenfluss der Quellen
Ja
Ja

Antwort

Eine erfolgreiche Antwort gibt Ihr aktualisiertes Paket zurück. Die Antwort enthält die entsprechende Paket-ID sowie Informationen zum Status, zum Ablauf und zur Liste der Artefakte.

{
    "id": "6fa50baedd344a278129a87e68cc9dc7",
    "version": 4,
    "createdDate": 1684235842000,
    "modifiedDate": 1684475861366,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "tenantId": "c875b077162b40409c1327b16da99c1b",
    "name": "acme",
    "description": "Acme Business Group",
    "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
    "sourceSandbox": {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    },
    "packageType": "PARTIAL",
    "expiry": 1692251861352,
    "status": "DRAFT",
    "artifactsList": [
        {
            "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29@1647559351683",
            "type": "JOURNEY",
            "found": false,
            "count": 0
        },
        {
            "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29",
            "type": "JOURNEY",
            "found": false,
            "count": 0
        }
    ]
}

Löschen von Artefakten aus einem Paket delete-artifacts

Um Artefakte aus einem Paket zu löschen, müssen Sie einen id angeben und DELETE für die action einschließen.

API-Format

PUT /packages/

Anfrage

curl -X PUT \
  https://platform.adobe.io/data/foundation/exim/packages \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d'{
      "id": "6fa50baedd344a278129a87e68cc9dc7",
      "action": "DELETE",
      "artifacts": [
        {
          "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29@1647559351683",
          "type": "JOURNEY"
        }
      ]
  }'
Eigenschaft
Beschreibung
Typ
Obligatorisch
id
Die ID des zu aktualisierenden Pakets.
Zeichenfolge
Ja
action
Um Artefakte aus einem Paket zu löschen, sollte der Aktionswert DELETE sein. Diese Aktion wird nur für Pakettypen PARTIAL unterstützt.
Zeichenfolge
Ja
artifacts
Eine Liste von Artefakten, die aus dem Paket gelöscht werden sollen. Das Paket wird nicht geändert, wenn die Liste null oder leer.
Array
Nein

Antwort

Eine erfolgreiche Antwort gibt Ihr aktualisiertes Paket zurück. Die Antwort enthält die entsprechende Paket-ID sowie Informationen zum Status, zum Ablauf und zur Liste der Artefakte.

{
    "id": "6fa50baedd344a278129a87e68cc9dc7",
    "version": 5,
    "createdDate": 1684235842000,
    "modifiedDate": 1684478830416,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "tenantId": "c875b077162b40409c1327b16da99c1b",
    "name": "acme",
    "description": "Acme Business Group",
    "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
    "sourceSandbox": {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    },
    "packageType": "PARTIAL",
    "expiry": 1692254830403,
    "status": "DRAFT",
    "artifactsList": [
        {
            "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29",
            "type": "JOURNEY",
            "found": false,
            "count": 0
        }
    ]
}

Aktualisieren von Metadatenfeldern in einem Paket update-metadata

NOTE
Die UPDATE-Aktion wird verwendet, um die Paketmetadatenfelder des Pakets zu aktualisieren, und kann nicht zum Hinzufügen/Löschen von Artefakten zu einem Paket verwendet werden.

Um die Metadatenfelder in einem Paket zu aktualisieren, müssen Sie einen id angeben und UPDATE für die action einschließen.

API-Format

PUT /packages/

Anfrage

curl -X PUT \
  https://platform.adobe.io/data/foundation/exim/packages \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d'{
      "id": "6fa50baedd344a278129a87e68cc9dc7",
      "action": "UPDATE",
      "name": "acme",
      "description": "Acme Business Group",
      "sourceSandbox": {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
      }
  }'
Eigenschaft
Beschreibung
Typ
Obligatorisch
id
Die ID des zu aktualisierenden Pakets.
Zeichenfolge
Ja
action
Um die Metadatenfelder in einem Paket zu aktualisieren, sollte der Aktionswert (). Diese Aktion wird nur für Pakettypen PARTIAL unterstützt.
Zeichenfolge
Ja
name
Der aktualisierte Name des Pakets. Doppelte Paketnamen sind nicht zulässig.
Array
Ja
sourceSandbox
Die Source-Sandbox muss derselben Organisation angehören, die auch im Header der Anfrage angegeben ist.
Objekt
Ja

Antwort

Eine erfolgreiche Antwort gibt Ihr aktualisiertes Paket zurück. Die Antwort enthält die entsprechende Paket-ID sowie Informationen zu Beschreibung, Status, Ablauf und Liste der Artefakte.

{
    "id": "6fa50baedd344a278129a87e68cc9dc7",
    "version": 6,
    "createdDate": 1684235842000,
    "modifiedDate": 1684479094129,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "tenantId": "c875b077162b40409c1327b16da99c1b",
    "name": "acme",
    "description": "Acme Business Group",
    "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
    "sourceSandbox": {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    },
    "packageType": "PARTIAL",
    "expiry": 1692255094127,
    "status": "DRAFT",
    "artifactsList": [
        {
            "id": "d8d8ed6d-696a-40bd-b4fe-ca053ec94e29",
            "type": "JOURNEY",
            "found": false,
            "count": 0
        }
    ]
}

Löschen eines Pakets delete

Um ein Paket zu löschen, stellen Sie eine DELETE-Anfrage an den /packages-Endpunkt und geben Sie die ID des Pakets an, das Sie löschen möchten.

API-Format

DELETE /packages/{PACKAGE_ID}
Parameter
Beschreibung
{PACKAGE_ID}
Die ID des Pakets, das Sie löschen möchten.

Anfrage

Die folgende Anfrage löscht das Paket mit der ID {PACKAGE_ID}.

curl -X DELETE \
  https://platform.adobe.io/data/foundation/exim/packages/{PACKAGE_ID} \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Antwort

Bei einer erfolgreichen Antwort wird ein Grund zurückgegeben, der die gelöschte Paket-ID anzeigt.

{
    "reason": "Package d30e0424a37b46ada6a5cf37f47a86ff deleted"
}

Veröffentlichen eines Pakets publish

Um den Import eines Pakets in eine Sandbox zu aktivieren, müssen Sie es veröffentlichen. Stellen Sie eine GET-Anfrage an den /packages-Endpunkt, während Sie die ID des Pakets angeben, das Sie veröffentlichen möchten.

API-Format

GET /packages/{PACKAGE_ID}/export
Parameter
Beschreibung
{PACKAGE_ID}
Die ID des Pakets, das Sie veröffentlichen möchten.

Anfrage

Die folgende Anfrage veröffentlicht das Paket mit der ID {PACKAGE_ID}.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/packages/{PACKAGE_ID}\export \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
Eigenschaft
Beschreibung
Typ
Obligatorisch
expiryPeriod
Dieser benutzerdefinierte Zeitraum definiert das Paketablaufdatum (in Tagen) ab dem Zeitpunkt der Veröffentlichung des Pakets. Dieser Wert sollte nicht negativ sein.
Wenn kein Wert angegeben ist, wird der Standardwert 90 (Tage) ab dem Datum der Veröffentlichung berechnet.
Ganzzahl
Nein

Antwort

Eine erfolgreiche Antwort gibt das veröffentlichte Paket zurück.

{
    "name": "acme",
    "description": "Acme Business Group",
    "visibility": "TENANT",
    "sourceSandbox":
    {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    },
    "type": "PARTIAL",
    "correlationId": "48effe5e-1bef-4250-9c71-23b93ef5d285",
    "jobId": "18abab44e25f40c284a4bd6e8f52fd29"
}

Suchen eines Pakets look-up-package

Sie können ein einzelnes Paket suchen, indem Sie eine GET-Anfrage an den /packages-Endpunkt stellen, der die entsprechende ID des Pakets im Anfragepfad enthält.

API-Format

GET /packages/{PACKAGE_ID}
Parameter
Beschreibung
{PACKAGE_ID}
Die ID des Pakets, das Sie suchen möchten.

Anfrage

Mit der folgenden Anfrage werden Informationen zu {PACKAGE_ID} abgerufen.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/packages/{PACKAGE_ID} \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Antwort

Eine erfolgreiche Antwort gibt Details zur abgefragten Paket-ID zurück. Die Antwort enthält den Namen, die Beschreibung, das Veröffentlichungs- und Ablaufdatum, die Quell-Sandbox des Pakets sowie eine Liste von Artefakten.

{
    "id": "8f585fad94d042cd82dbcba594108a41",
    "version": 2,
    "createdDate": 1685597784000,
    "modifiedDate": 1685597810000,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "tenantId": "c875b077162b40409c1327b16da99c1b",
    "name": "acme",
    "description": "Acme Business Group",
    "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
    "packageType": "PARTIAL",
    "expiry": 1693373810000,
    "publishDate": 1685597810000,
    "status": "PUBLISHED",
    "artifactsList": [
        {
            "id": "f4f57771-2bd2-469a-9c13-8d803eeb6515",
            "type": "JOURNEY",
            "found": false,
            "count": 0
        },
        {
            "id": "7f4caca7-a477-400d-a41e-c4735f8e780d",
            "type": "JOURNEY",
            "found": false,
            "count": 0
        }
    ],
    "sourceSandbox": {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    }
}

Auflisten von Paketen list-packages

Sie können alle Pakete in Ihrer Organisation auflisten, indem Sie eine GET-Anfrage an den /packages-Endpunkt stellen.

API-Format

GET /packages/?{QUERY_PARAMS}
Parameter
Beschreibung
{QUERY_PARAMS}
Optionale Abfrageparameter zum Filtern der Ergebnisse nach . Weitere Informationen finden Sie ​ Abschnitt ​ Abfrageparameter .

Anfrage

Die folgende Anfrage ruft Informationen zu den Paketen basierend auf der {QUERY_PARAMS} ab.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/packages/?property=status==DRAFT,PUBLISHED&property=createdDate>=2023-05-11T18:29:59.999Z&property=createdDate<=2023-05-16T18:29:59.999Z&start=0&orderby=-createdDate&limit=20 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Antwort

Bei einer erfolgreichen Antwort wird eine Liste von Paketen zurückgegeben, die zu Ihrer Organisation gehören, einschließlich Details wie Name, Status, Ablauf und Artefaktliste.

{
    "totalElements": 109,
    "currentPage": 0,
    "totalPages": 6,
    "hasPreviousPage": false,
    "hasNextPage": true,
    "data": [
        {
            "id": "8f585fad94d042cd82dbcba594108a41",
            "version": 2,
            "createdDate": 1685597784000,
            "modifiedDate": 1685597810000,
            "createdBy": "{CREATED_BY}",
            "modifiedBy": "{MODIFIED_BY}",
            "tenantId": "c875b077162b40409c1327b16da99c1b",
            "name": "acme",
            "description": "Acme Business Group",
            "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
            "packageType": "PARTIAL",
            "expiry": 1693373810000,
            "publishDate": 1685597810000,
            "status": "PUBLISHED",
            "artifactsList": [
                {
                    "id": "f4f57771-2bd2-469a-9c13-8d803eeb6515",
                    "type": "JOURNEY",
                    "found": false,
                    "count": 0
                },
                {
                    "id": "7f4caca7-a477-400d-a41e-c4735f8e780d",
                    "type": "JOURNEY",
                    "found": false,
                    "count": 0
                }
            ],
            "sourceSandbox": {
                "name": "acme-sandbox",
                "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
            }
        },
        {
            "id": "0d7e427ce4cb4dc1b78e30ef61b125c1",
            "version": 2,
            "createdDate": 1685555213000,
            "modifiedDate": 1685555275000,
            "createdBy": "{CREATED_BY}",
            "modifiedBy": "{MODIFIED_BY}",
            "tenantId": "7d7d8bbe3c7c4a8ea701cc5e42c57aeb",
            "name": "acme",
            "description": "Acme Business Group",
            "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
            "packageType": "PARTIAL",
            "expiry": 1693331275000,
            "publishDate": 1685555275000,
            "status": "PUBLISHED",
            "artifactsList": [
                {
                    "id": "626a9669a9f5b818db270e95",
                    "type": "CATALOG_DATASET",
                    "found": false,
                    "count": 0
                }
            ],
            "sourceSandbox": {
                "name": "acme-sandbox",
                "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
            }
        }
    ]
}

Package importieren import

Dieser Endpunkt wird verwendet, um die in Konflikt stehenden Objekte in der angegebenen Ziel-Sandbox abzurufen. Widersprüchliche Objekte stellen ähnliche Objekte dar, die bereits in der Ziel-Sandbox vorhanden sind.

API-Format

GET /packages/{PACKAGE_ID}/import?targetSandbox=targetSandboxName
Parameter
Beschreibung
{PACKAGE_ID}
Die ID des Pakets, das Sie suchen möchten.

Anfrage

Mit der folgenden Anfrage wird die {PACKAGE_ID} importiert.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/packages/{PACKAGE_ID}/import?targetSandbox=targetSandboxName \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Antwort

In der Antwort werden Konflikte zurückgegeben. Die Antwort zeigt das ursprüngliche Paket plus das alternatives Fragment als Array sortiert nach Rangfolge an.

Antwort anzeigen
code language-json 
[
    {
        "artifact": {
            "id": "https://ns.adobe.com/cjmstage/schemas/20121c2110bb2c6a585baabe5f82994577da1f7d0628234c",
            "type": "REGISTRY_SCHEMA",
            "found": false,
            "count": 0,
            "messages": [
                {
                    "status": "FOUND",
                    "attempt": 1,
                    "message": "Found object with ID: https://ns.adobe.com/cjmstage/schemas/20121c2110bb2c6a585baabe5f82994577da1f7d0628234c"
                }
            ]
        },
        "suggestionList": [
            {
                "id": "https://ns.adobe.com/cjmstage/schemas/176f33f6a8ff6542de1256f8dc01cce4be1b3a68fd5f5bc5",
                "type": "REGISTRY_SCHEMA",
                "found": false,
                "count": 0,
                "title": "Dean Dataset 1 - adhoc schema - 1618950408870_1686403052050"
            },
            {
                "id": "https://ns.adobe.com/cjmstage/schemas/1b37c3403e4e12c7aa46ea9dfe380a9f2b72d4da9db62b46",
                "type": "REGISTRY_SCHEMA",
                "found": false,
                "count": 0,
                "title": "Dean Dataset 1 - adhoc schema - 1618950408870_1686218766627"
            }
        ],
        "parentID": "745F37C35E4B776E0A49421B@AdobeOrg::prod::REGISTRY_SCHEMA::https://ns.adobe.com/cjmstage/schemas/20121c2110bb2c6a585baabe5f82994577da1f7d0628234c"
    },
    {
        "artifact": {
            "id": "https://ns.adobe.com/cjmstage/classes/24c1525f4f06fae2d203c6b78e26ae479ec4541c2c0d6b26",
            "type": "REGISTRY_CLASS",
            "found": false,
            "count": 0,
            "messages": [
                {
                    "status": "FOUND",
                    "attempt": 1,
                    "message": "Found object with ID: https://ns.adobe.com/cjmstage/classes/24c1525f4f06fae2d203c6b78e26ae479ec4541c2c0d6b26"
                }
            ]
        },
        "suggestionList": [
            {
                "id": "https://ns.adobe.com/cjmstage/classes/1dd81d61cdaa89a89382d0a424db77494475bd1db3105feb",
                "type": "REGISTRY_CLASS",
                "found": false,
                "count": 0,
                "title": "Dean Dataset 1 - Adhoc class - 1618950408870_1686564843736"
            },
            {
                "id": "https://ns.adobe.com/cjmstage/classes/2511fb5396a630b2cd3d5d9e9b69d42ce66a4289db8ac917",
                "type": "REGISTRY_CLASS",
                "found": false,
                "count": 0,
                "title": "Dean Dataset 1 - Adhoc class - 1618950408870_1686408152916"
            }
        ],
        "parentID": "745F37C35E4B776E0A49421B@AdobeOrg::prod::REGISTRY_CLASS::https://ns.adobe.com/cjmstage/classes/24c1525f4f06fae2d203c6b78e26ae479ec4541c2c0d6b26"
    },
    {
        "artifact": {
            "id": "4d4c874ec3344d64bf8b3160e60ac78b",
            "type": "MAPPING_SET",
            "found": false,
            "count": 0,
            "messages": [
                {
                    "status": "FOUND",
                    "attempt": 1,
                    "message": "Found object with ID: 4d4c874ec3344d64bf8b3160e60ac78b"
                }
            ]
        },
        "suggestionList": [
            {
                "id": "6b49c959d77c48e9904f7616fe2e7848",
                "type": "MAPPING_SET",
                "found": false,
                "count": 0,
                "title": ""
            },
            {
                "id": "7b363da9e6704afb9716f57193d5246f",
                "type": "MAPPING_SET",
                "found": false,
                "count": 0,
                "title": ""
            },
            {
                "id": "93ca0b4f437c4eaf9f1986408679e965",
                "type": "MAPPING_SET",
                "found": false,
                "count": 0,
                "title": ""
            }
        ],
        "parentID": "745F37C35E4B776E0A49421B@AdobeOrg::prod::MAPPING_SET::4d4c874ec3344d64bf8b3160e60ac78b"
    }
]

Import übermitteln submit-import

NOTE
Bei der Konfliktauflösung ist es inhärent, dass das alternative Artefakt bereits in der Ziel-Sandbox vorhanden ist.

Sie können einen Import für ein Paket senden, nachdem Sie Konflikte überprüft und Ersetzungen bereitgestellt haben, indem Sie eine POST-Anfrage an den /packages-Endpunkt senden. Das Ergebnis wird als Payload bereitgestellt, die den Importvorgang für die Ziel-Sandbox startet, wie in der Payload angegeben.

Payload akzeptiert auch den vom Benutzer angegebenen Auftragsnamen und die Beschreibung für den Importauftrag. Wenn der vom Benutzer angegebene Name und die Beschreibung nicht verfügbar sind, wird der Paketname und die Beschreibung für den Auftragsnamen und die Beschreibung verwendet.

API-Format

POST /packages/import

Anfrage

Die folgende Anfrage ruft zu importierende Pakete ab. Die Payload ist eine Zuordnung von Ersetzungen, bei der, wenn ein Eintrag vorhanden ist, der Schlüssel der vom Paket bereitgestellte artifactId ist und die Alternative der Wert ist. Wenn die Zuordnung oder Payload leer ist, werden keine Ersetzungen durchgeführt.

curl -X POST \
  https://platform.adobe.io/data/foundation/exim/packages/import/ \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d'{
       "id": "09484a599f5f4a5faa43986643964615",
       "name": "acme",
       "description": "Acme Business Group",
       "destinationSandbox": {
         "name": "cjm-mr",
         "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
     },
     "alternatives": {
       "https://ns.adobe.com/cjmstage/schemas/ac33bbd22eb4ad6656e1c7e12e9f520261fb39fd28a902a9": {
         "id": "https://ns.adobe.com/cjmstage/schemas/a3b935344685afad4e52c753161cf673ec23d4fb1b3e9ce",
         "type": "REGISTRY_SCHEMA"
       }
     }
  }'
Eigenschaft
Beschreibung
Typ
Obligatorisch
alternatives
alternatives stellen die Zuordnung von Quell-Sandbox-Artefakten zu den vorhandenen Ziel-Sandbox-Artefakten dar. Da sie bereits vorhanden sind, vermeidet der Importvorgang das Erstellen dieser Artefakte in der Ziel-Sandbox.
Zeichenfolge
Nein

Antwort

{
    "name": "acme",
    "description": "Acme Business Group",
    "visibility": "TENANT",
    "sourceSandbox":
    {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    },
    "destinationSandbox":
    {
        "name": "acme-sandbox",
        "imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg"
    },
    "type": "PARTIAL",
    "correlationId": "48effe5e-1bef-4250-9c71-23b93ef5d285",
    "jobId": "18abab44e25f40c284a4bd6e8f52fd29"
}

Auflisten aller abhängigen Objekte dependent-objects

Listen Sie alle abhängigen Objekte für die exportierten Objekte in einem Paket auf, indem Sie eine POST-Anfrage an den /packages-Endpunkt senden und dabei die ID des Pakets angeben.

API-Format

POST /packages/{PACKAGE_ID}/children
Parameter
Beschreibung
{PACKAGE_ID}
Die ID des Pakets.

Anfrage

Die folgende Anfrage listet alle abhängigen Objekte für die {PACKAGE_ID} auf.

curl -X POST \
  https://platform.adobe.io/data/foundation/exim/packages/{PACKAGE_ID}/children \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d'[
      {
        "id": "4d4c874ec3344d64bf8b3160e60ac78b",
        "type": "MAPPING_SET"
      },
      {
        "id": "https://ns.adobe.com/cjmstage/schemas/20121c2110bb2c6a585baabe5f82994577da1f7d0628234c",
        "type": "REGISTRY_SCHEMA"
      },
      {
        "id": "https://ns.adobe.com/cjmstage/classes/24c1525f4f06fae2d203c6b78e26ae479ec4541c2c0d6b26",
        "type": "REGISTRY_CLASS"
      }
  ]'

Antwort

Eine erfolgreiche Antwort gibt eine Liste von untergeordneten Elementen für die -Objekte zurück.

[
    {
        "id": "4d4c874ec3344d64bf8b3160e60ac78b",
        "title": "4d4c874ec3344d64bf8b3160e60ac78b",
        "type": "MAPPING_SET",
        "children": [
            {
                "id": "https://ns.adobe.com/cjmstage/schemas/20121c2110bb2c6a585baabe5f82994577da1f7d0628234c",
                "title": "Dean Dataset 1 - adhoc schema - 1618950408870",
                "type": "REGISTRY_SCHEMA"
            }
        ]
    },
    {
        "id": "https://ns.adobe.com/cjmstage/schemas/20121c2110bb2c6a585baabe5f82994577da1f7d0628234c",
        "title": "Dean Dataset 1 - adhoc schema - 1618950408870",
        "type": "REGISTRY_SCHEMA",
        "children": [
            {
                "id": "https://ns.adobe.com/cjmstage/classes/24c1525f4f06fae2d203c6b78e26ae479ec4541c2c0d6b26",
                "title": "Dean Dataset 1 - Adhoc class - 1618950408870",
                "type": "REGISTRY_CLASS"
            }
        ]
    },
    {
        "id": "https://ns.adobe.com/cjmstage/classes/24c1525f4f06fae2d203c6b78e26ae479ec4541c2c0d6b26",
        "title": "Dean Dataset 1 - Adhoc class - 1618950408870",
        "type": "REGISTRY_CLASS",
        "children": []
    }
]

Rollenbasierte Berechtigungen zum Importieren aller Paket-Artefakte überprüfen role-based-permissions

Sie können überprüfen, ob Sie über Berechtigungen zum Importieren von Paket-Artefakten verfügen, indem Sie eine GET-Anfrage an den /packages-Endpunkt stellen, während Sie die ID des Pakets und den Namen der Ziel-Sandbox angeben.

API-Format

GET /packages/preflight/{packageId}?targetSandbox=<sandbox_name
Parameter
Beschreibung
{PACKAGE_ID}
Die ID des Pakets, das Sie importieren möchten.

Anfrage

Mit der folgenden Anfrage werden Ihre Berechtigungen für die {PACKAGE_ID} und Sandbox überprüft.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/packages/preflight/{PACKAGE_ID}?targetSandbox=<sandbox_name> \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Antwort

Bei einer erfolgreichen Antwort werden Ressourcenberechtigungen für die Ziel-Sandbox zurückgegeben, einschließlich einer Liste der erforderlichen Berechtigungen, fehlender Berechtigungen, des Typs eines Artefakts und einer Entscheidung darüber, ob die Erstellung zulässig ist.

Antwort anzeigen
code language-json 
{
  "packageID": "b7bda68eb1214c86824f1d7204616e51",
  "targetSandboxName": "acme-sandbox",
  "permissionResponse": [
    {
      "artifactID": "4aca57b6-8b83-450b-a460-e8a07ca79a44",
      "requiredPermissions": {
        "resources": [
          {
            "palmResourceType": "Sandbox",
            "resourcePermissions": [
              "view"
            ]
          },
          {
            "palmResourceType": "Schema",
            "resourcePermissions": [
              "read"
            ]
          },
          {
            "palmResourceType": "ProfileConfig",
            "resourcePermissions": [
              "read"
            ]
          },
          {
            "palmResourceType": "Segment",
            "resourcePermissions": [
              "read",
              "write",
              "delete"
            ]
          },
          {
            "palmResourceType": "Composition",
            "resourcePermissions": [
              "read",
              "write",
              "delete"
            ]
          },
          {
            "palmResourceType": "Query",
            "resourcePermissions": [
              "write"
            ]
          },
          {
            "palmResourceType": "SegmentDashboard",
            "resourcePermissions": [
              "read"
            ]
          }
        ]
      },
      "missingPermissions": {
        "resources": []
      },
      "artifactType": "PROFILE_SEGMENT",
      "creationAllowed": true
    },
    {
      "artifactID": "36bb82bc-a00d-4d6b-a598-227d43e027c1",
      "requiredPermissions": {
        "resources": [
          {
            "palmResourceType": "Sandbox",
            "resourcePermissions": [
              "view"
            ]
          },
          {
            "palmResourceType": "ProfileConfig",
            "resourcePermissions": [
              "read",
              "write",
              "delete"
            ]
          },
          {
            "palmResourceType": "Dataset",
            "resourcePermissions": [
              "read"
            ]
          }
        ]
      },
      "missingPermissions": {
        "resources": [
          {
            "palmResourceType": "ProfileConfig",
            "resourcePermissions": [
              "write",
              "delete"
            ]
          },
          {
            "palmResourceType": "Dataset",
            "resourcePermissions": [
              "read"
            ]
          }
        ]
      },
      "artifactType": "PROFILE_MERGE",
      "creationAllowed": false
    }
  ]
}

Export-/Importvorgänge auflisten list-jobs

Sie können aktuelle Export-/Importvorgänge auflisten, indem Sie eine GET-Anfrage an den /packages-Endpunkt senden.

API-Format

GET /packages/jobs?{QUERY_PARAMS}
Parameter
Beschreibung
{QUERY_PARAMS}
Optionale Abfrageparameter zum Filtern der Ergebnisse nach . Weitere Informationen finden Sie ​ Abschnitt ​ Abfrageparameter .

Anfrage

Die folgende Anfrage listet alle erfolgreichen Importvorgänge auf.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/packages/jobs?property=requestType==IMPORT&property=jobStatus==SUCCESS&orderby=createdDate&start=0&limit=5 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Antwort

Eine erfolgreiche Antwort gibt alle erfolgreichen Importvorgänge zurück.

{
    "totalElements": 42,
    "currentPage": 0,
    "totalPages": 9,
    "hasPreviousPage": false,
    "hasNextPage": true,
    "data": [
        {
            "id": "3c1b92cf47a246d7bfbe6fd507c5d543",
            "name": "acme",
            "updated": 1685973675401,
            "created": 1685973675401,
            "jobType": "NEW",
            "packageType": "PARTIAL",
            "description": "Acme Business Group",
            "jobStatus": "SUCCESS",
            "visibility": "TENANT",
            "sourceSandBox": "acme-sandbox",
            "targetSandbox": "poc",
            "createdBy": "{CREATED_BY}"
        },
        {
            "id": "ead59d21405f4184a94dd786a1bf040d",
            "name": "acme1",
            "updated": 1685986367198,
            "created": 1685986367198,
            "jobType": "NEW",
            "packageType": "PARTIAL",
            "description": "Acme Business Group",
            "jobStatus": "SUCCESS",
            "visibility": "TENANT",
            "sourceSandBox": "acme-sandbox",
            "targetSandbox": "poc",
            "createdBy": "{CREATED_BY}"
        },
        {
            "id": "85ddaa3c2f6c475088167cde7a9d4326",
            "name": "acme2",
            "updated": 1686147692568,
            "created": 1686147692568,
            "jobType": "NEW",
            "packageType": "PARTIAL",
            "description": "Acme Business Group",
            "jobStatus": "SUCCESS",
            "visibility": "TENANT",
            "sourceSandBox": "acme-sandbox",
            "targetSandbox": "poc",
            "createdBy": "{CREATED_BY}"
        },
        {
            "id": "c49a4fcb31954cbd828ece1da096c8f5",
            "name": "acme3",
            "updated": 1686148007586,
            "created": 1686148007586,
            "jobType": "NEW",
            "packageType": "PARTIAL",
            "description": "Acme Business Group",
            "jobStatus": "SUCCESS",
            "visibility": "TENANT",
            "sourceSandBox": "acme-sandbox",
            "targetSandbox": "poc",
            "createdBy": "{CREATED_BY}"
        },
        {
            "id": "a3669315baed4cf2af49bf9ce90b8158",
            "name": "acme4",
            "updated": 1686148651910,
            "created": 1686148651910,
            "jobType": "NEW",
            "packageType": "PARTIAL",
            "description": "Acme Business Group",
            "jobStatus": "SUCCESS",
            "visibility": "TENANT",
            "sourceSandBox": "acme-sandbox",
            "targetSandbox": "poc",
            "createdBy": "{CREATED_BY}"
        }
    ]
}

Package-Freigabe über Organisationen hinweg org-linking

Der /handshake-Endpunkt in der Sandbox-Tooling-API ermöglicht es Ihnen, mit anderen Organisationen zusammenzuarbeiten, um Pakete freizugeben.

Senden einer Freigabeanfrage send-request

Senden Sie eine Anfrage an eine Zielpartner-Organisation zur Freigabe oder Genehmigung, indem Sie eine POST-Anfrage an den /handshake/bulkCreate-Endpunkt senden. Dies ist erforderlich, bevor Sie private Pakete freigeben können.

API-Format

POST /handshake/bulkCreate

Anfrage

Mit der folgenden Anfrage wird die Freigabe einer Genehmigung zwischen einer Zielpartnerorganisation und der Quellorganisation initiiert.

curl -X POST \
  https://platform.adobe.io/data/foundation/exim/handshake/bulkCreate \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/json' \
  -H 'Authorization: {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
      "targetIMSOrgIds":["acme@AdobeOrg"],
      "sourceIMSDetails":{
        "id":"acme@AdobeOrg",
        "name":"acme_org"
      }
  }'
Eigenschaft
Beschreibung
Typ
Erforderlich
targetIMSOrgIds
Eine Liste der Zielorganisationen, an die die Freigabeanfrage gesendet werden soll.
Array
Ja
sourceIMSDetails
Details zur Quellorganisation.
Objekt
Ja

Antwort

Eine erfolgreiche Antwort gibt Details zu Ihrer Freigabeanfrage zurück.

{
    "successfulRequests": {
        "acme@AdobeOrg": {
            "id": "{ID}",
            "version": 0,
            "createdDate": 1724938816798,
            "modifiedDate": 1724938816798,
            "createdBy": "{CREATED_BY}",
            "modifiedBy": "{MODIFIED_BY}",
            "sourceIMSOrgId": "{ORG_ID}",
            "targetIMSOrgId": "{TARGET_ID}",
            "sourceRegion": "va6",
            "sourceIMSOrgName": "{SOURCE_NAME}",
            "status": "APPROVAL_PENDING",
            "createdByName": "{CREATED_BY}",
            "modifiedByName": "{MODIFIED_BY}",
            "modifiedByIMSOrgId": "{ORG_ID}",
            "statusHistory": "[{\"actionTakenBy\":\"acme@98ff67fa661fdf6549420b.e\",\"actionTakenByName\":\"{NAME}\",\"actionTakenByImsOrgID\":\"{ORG_ID}\",\"action\":\"INITIATED\",\"actionTimeStamp\":1724938816885}]",
            "linkingId": "{LINKING_ID}"
        }
    },
    "failedRequests": {}
}

Validieren empfangener Freigabeanfragen approve-requests

Genehmigen Sie Freigabeanfragen von Zielpartnerorganisationen, indem Sie eine POST-Anfrage an den /handshake/action-Endpunkt senden. Nach der Genehmigung können Quellpartnerorganisationen private Pakete freigeben.

API-Format

POST /handshake/action

Anfragen

Mit der folgenden Anfrage wird eine Freigabeanfrage von einer Zielpartnerorganisation genehmigt.

curl -X POST  \
  https://platform.adobe.io/data/foundation/exim/handshake/action \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
      "linkingID":"{LINKING_ID}",
      "status":"APPROVED",
      "reason":"Done",
      "targetIMSOrgDetails":{
          "id":"acme@AdobeOrg",
          "name":"acme",
          "region":"va7"
      }
  }'
Eigenschaft
Beschreibung
Typ
Erforderlich
linkingID
Die ID der Freigabeanfrage, auf die Sie antworten.
Zeichenfolge
Ja
status
Die Aktion, die bei der Freigabeanfrage durchgeführt wird. Zulässige Werte sind APPROVED oder REJECTED.
Zeichenfolge
Ja
reason
Der Grund, warum die Aktion durchgeführt wird.
Zeichenfolge
Ja
targetIMSOrgDetails
Details zur Zielorganisation, bei der der ID-Wert die ID der Zielorganisation, der Namenswert der NAME der Zielorganisation und der Regionswert die REGION sein sollte.
Objekt
Ja

Antwort

Eine erfolgreiche Antwort gibt Details zur genehmigten Freigabeanfrage zurück.

{
    "id": "{ID}",
    "version": 1,
    "createdDate": 1726737474000,
    "modifiedDate": 1726737541731,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "sourceIMSOrgId": "{ORG_ID}",
    "targetIMSOrgId": "{TARGET_ID}",
    "sourceRegion": "va7",
    "targetRegion": "va7",
    "sourceOrgName": "{SOURCE_ORG}",
    "targetOrgName": "{TARGET_ORG}",
    "status": "APPROVED",
    "createdByName": "{CREATED_BY}",
    "modifiedByIMSOrgId": "{MODIFIED_BY}",
    "statusHistory": "[{\"actionTakenBy\":\"{ACTION_BY}\",\"actionTakenByName\":\"{NAME}\",\"actionTakenByImsOrgID\":\"acme@AdobeOrg\",\"action\":\"INITIATED\",\"actionTimeStamp\":1726737474450,\"reason\":null},{\"actionTakenBy\":null,\"actionTakenByName\":null,\"actionTakenByImsOrgID\":\"745F37C35E4B776E0A49421B@AdobeOrg\",\"action\":\"APPROVED\",\"actionTimeStamp\":1726737541818,\"reason\":\"Done\"}]",
    "linkingId": "{LINKING_ID}"
}

Auflisten ausgehender/eingehender Freigabeanfragen outgoing-and-incoming-requests

Listen Sie ausgehende und eingehende Freigabeanfragen auf, indem Sie eine GET-Anfrage an den handshake/list?property=status%3D%3DAPPROVED&requestType=INCOMING-Endpunkt senden.

API-Format

GET handshake/list?property=status%3D%3DAPPROVED&requestType=INCOMING
Parameter
Akzeptierte/Standardwerte
property
Gibt die Eigenschaft an, nach der gefiltert werden soll, z. B. Status. Zulässige Werte für den Status sind: APPROVED, REJECTED und IN_PROGRESS.
start
Der Standardwert von start ist 0.
limit
Der Standardwert für Limit ist 20.
orderBy
Sortiert Datensätze in auf- oder absteigender Reihenfolge.
requestType
Akzeptiert entweder INCOMING oder OUTGOING.

Anfrage

Die folgende Anfrage gibt eine Liste aller ausgehenden und eingehenden Freigabeanfragen zurück.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/handshake/list?property=status%3D%3DAPPROVED&requestType=INCOMING \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id:{ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \

Antwort

Eine erfolgreiche Antwort gibt eine Liste von ausgehenden und eingehenden Freigabeanfragen und deren Details zurück.

{
    "totalElements": 1,
    "currentPage": 0,
    "totalPages": 1,
    "hasPreviousPage": false,
    "hasNextPage": false,
    "data": [
        {
            "id": "{ID}",
            "version": 1,
            "createdDate": 1724929446000,
            "modifiedDate": 1724929617000,
            "modifiedBy": "{MODIFIED_BY}",
            "sourceIMSOrgId": "{ORG_ID}",
            "targetIMSOrgId": "{TARGET_ID}",
            "sourceRegion": "va7",
            "targetRegion": "va6",
             "sourceOrgName": "{SOURCE_ORG}",
            "targetOrgName": "{TARGET_ORG}",
            "status": "APPROVED",
            "createdByName": "{CREATED_BY}",
            "modifiedByName": "{MODIFIED_BY}",
            "modifiedByIMSOrgId": "{MODIFIED_BY}",
            "statusHistory": "[{\"actionTakenBy\":\"{ACTION_BY}\",\"actionTakenByName\":\"{NAME}\",\"actionTakenByImsOrgID\":\"{ORG_ID}\",\"action\":\"INITIATED\",\"actionTimeStamp\":1724929442467,\"reason\":null},{\"actionTakenBy\":null,\"actionTakenByName\":\"{NAME}\",\"actionTakenByImsOrgID\":\"{ORG_ID}\",\"action\":\"APPROVED\",\"actionTimeStamp\":1724929617531,\"reason\":\"Done\"}]",
            "linkingId": "{LINKING_ID}"
        }
    ],
    "nextPage": null,
    "pageSize": null
}

Pakete übertragen

Verwenden Sie den /transfer-Endpunkt in der Sandbox-Tooling-API, um neue Anfragen zur Paketfreigabe abzurufen und zu erstellen.

Neue Freigabeanfrage share-request

Rufen Sie das Paket einer veröffentlichten Quellorganisation ab und geben Sie es für eine Zielorganisation frei, indem Sie eine POST-Anfrage an den /transfer-Endpunkt senden und dabei die Paket-ID und die ID der Zielorganisation angeben.

API-Format

POST /transfer

Anfrage

Mit der folgenden Anfrage wird ein Quellorganisationspaket abgerufen und für eine Zielorganisation freigegeben.

curl -X POST \
  https://platform.adobe.io/data/foundation/exim/transfer/ \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
      "packageId": "{PACKAGE_ID}",
      "targets": [
          {
              "imsOrgId": "{TARGET_IMS_ORG}"
          }
      ]
  }'
Eigenschaft
Beschreibung
Typ
Erforderlich
packageId
Die ID des Pakets, das Sie freigeben möchten.
Zeichenfolge
Ja
targets
Eine Liste der Organisationen, für die das Paket freigegeben werden soll.
Array
Ja

Antwort

Eine erfolgreiche Antwort gibt Details zum angeforderten Paket und dessen Freigabestatus zurück.

[
    {
        "id": "{ID}",
        "version": 0,
        "createdDate": 1726480559313,
        "modifiedDate": 1726480559313,
        "createdBy": "{CREATED_BY}",
        "modifiedBy": "{MODIFIED_BY}",
        "sourceIMSOrgId": "{ORG_ID}",
        "targetIMSOrgId": "{TARGET_ID}",
        "packageId": "{PACKAGE_ID}",
        "status": "PENDING",
        "initiatedBy": "acme@3ec9197a65a86f34494221.e",
        "requestType": "PRIVATE"
    }
]

Abrufen einer Freigabeanfrage nach ID fetch-transfer-by-id

Rufen Sie die Details einer Freigabeanfrage ab, indem Sie eine GET-Anfrage an den /transfer/{TRANSFER_ID}-Endpunkt stellen und dabei die Übertragungs-ID angeben.

API-Format

GET /transfer/{TRANSFER_ID}
Parameter
Beschreibung
{TRANSFER_ID}
Die ID der Übertragung, die Sie abrufen möchten.

Anfrage

Mit der folgenden Anfrage wird eine Übertragung mit der ID {TRANSFER_ID} abgerufen.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/transfer/0c843180a64c445ca1beece339abc04b \
  -H 'x-api-key: {API__KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}'

Antwort

Eine erfolgreiche Antwort gibt Details zu einer Freigabeanfrage zurück.

{
    "id": "{ID}",
    "sourceIMSOrgId": "{ORG_ID}",
    "sourceOrgName": "{SOURCE_ORG}",
    "targetIMSOrgId": "{TARGET_ID}",
    "targetOrgName": "{TARGET_ORG}",
    "packageId": "{PACKAGE_ID}",
    "packageName": "{PACKAGE_NAME}",
    "status": "COMPLETED",
    "initiatedBy": "{INITIATED_BY}",
    "createdDate": 1724442856000,
    "requestType": "PRIVATE"
}

Freigabeliste abrufen transfers-list

Rufen Sie eine Liste von Übertragungsanfragen ab, indem Sie eine GET-Anfrage an den /transfer/list?{QUERY_PARAMETERS}-Endpunkt senden und die Abfrageparameter nach Bedarf ändern.

API-Format

GET `/transfer/list?{QUERY_PARAMETERS}`
Parameter
Akzeptierte/Standardwerte
property
Gibt die Eigenschaft an, nach der gefiltert werden soll, z. B. Status. Zulässige Statuswerte sind: COMPLETED, PENDING, IN_PROGRESS, FAILED.
start
Der Standardwert von start ist 0.
limit
Der Standardwert für Limit ist 20.
orderBy
Bei der Sortierung wird nur das Feld createdDate akzeptiert.

Anfrage

Mit der folgenden Anfrage wird eine Liste von Übertragungsanfragen aus den angegebenen Suchparametern abgerufen.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/transfer/list?property=status==COMPLETED&start=0&limit=2&orderBy=-createdDate \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}'

Antwort

Eine erfolgreiche Antwort gibt eine Liste aller Übertragungsanfragen aus den angegebenen Suchparametern zurück.

{
    "totalElements": 43,
    "currentPage": 0,
    "totalPages": 22,
    "hasPreviousPage": false,
    "hasNextPage": true,
    "data": [
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_ORG}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_ORG}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "{PACKAGE_NAME}",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1726129077000,
            "createdDate": 1726129062000,
            "requestType": "PRIVATE"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_ORG}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_ORG}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "{PACKAGE_NAME}",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1726066046000,
            "createdDate": 1726065936000,
            "requestType": "PRIVATE"
        }
    ],
    "nextPage": null,
    "pageSize": null
}

Paketverfügbarkeit von privat auf öffentlich aktualisieren update-availability

Ändern Sie ein Paket von privat in öffentlich, indem Sie eine GET-Anfrage an den /packages/update-Endpunkt stellen. Standardmäßig wird ein Paket mit privater Verfügbarkeit erstellt.

API-Format

PUT `/packages/update`

Anfrage

Die folgende Anfrage ändert eine Verfügbarkeit der Pakete von privat in öffentlich.

curl -X PUT \
  https://platform.adobe.io/data/foundation/exim/packages \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-type: application/json' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -d '{
      "id":"{ID}",
      "action":"UPDATE",
      "packageVisibility":"PUBLIC"
  }'
Eigenschaft
Beschreibung
Typ
Erforderlich
id
Die ID des zu aktualisierenden Pakets.
Zeichenfolge
Ja
action
Um die Sichtbarkeit für die Öffentlichkeit zu aktualisieren, sollte der Aktionswert "".
Zeichenfolge
Ja
packageVisbility
Um die Sichtbarkeit zu aktualisieren, sollte der packageVisibility-Wert "".
Zeichenfolge
Ja

Antwort

Eine erfolgreiche Antwort gibt Details zu einem Paket und seiner Sichtbarkeit zurück.

{
    "id": "{ID}",
    "version": 7,
    "createdDate": 1729624618000,
    "modifiedDate": 1729658596340,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "name": "acme",
    "imsOrgId": "{ORG_ID}",
    "packageType": "PARTIAL",
    "expiry": 1737434596325,
    "status": "PUBLISH_FAILED",
    "packageVisibility": "PUBLIC",
    "artifactsList": [
        {
            "id": "{ID}",
            "type": "PROFILE_SEGMENT",
            "found": false,
            "count": 0,
            "title": "Acme Profile Segment"
        }
    ],
    "schemaMapping": {},
    "sourceSandbox": {
        "name": "acme-sandbox",
        "imsOrgId": "{ORG_ID}",
        "empty": false
    }
}

Anfrage zum Importieren eines öffentlichen Pakets pull-public-package

Importieren Sie ein Paket aus einer Quellorganisation mit öffentlicher Verfügbarkeit, indem Sie eine POST-Anfrage an den /transfer/pullRequest-Endpunkt senden.

API-Format

POST /transfer/pullRequest

Anfrage

Mit der folgenden Anfrage wird ein Paket importiert und seine Verfügbarkeit auf „Öffentlich“ festgelegt.

curl -X POST \
  https://platform.adobe.io/data/foundation/exim/transfer/pullRequest \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
      "imsOrgId": "{ORG_ID}",
      "packageId": "{PACKAGE_ID}"
  }'
Eigenschaft
Beschreibung
Typ
Erforderlich
imsOrgId
Die ID aus der Quellorganisation des Pakets.
Zeichenfolge
Ja
packageId
Die ID aus dem zu importierenden Paket.
Zeichenfolge
Ja

Antwort

Eine erfolgreiche Antwort gibt Details zum importierten öffentlichen Paket zurück.

{
    "id": "{ID}",
    "version": 0,
    "createdDate": 1729658890425,
    "modifiedDate": 1729658890425,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "sourceIMSOrgId": "{ORG_ID}",
    "targetIMSOrgId": "{TARGET_ID}",
    "packageId": "{PACKAGE_ID}",
    "status": "PENDING",
    "initiatedBy": "{INITIATED_BY}",
    "pipelineMessageId": "{MESSAGE_ID}",
    "requestType": "PUBLIC"
}

Auflisten öffentlicher Pakete list-public-packages

Rufen Sie eine Liste von Paketen mit öffentlicher Sichtbarkeit ab, indem Sie eine GET-Anfrage an den /transfer/list?{QUERY_PARAMS}-Endpunkt stellen.

API-Format

GET /transfer/list?{QUERY_PARAMS}
Parameter
Akzeptierte/Standardwerte
property
Gibt die Eigenschaft an, nach der gefiltert werden soll, z. B. Status. Zulässige Statuswerte sind: COMPLETED und FAILED.
start
Der Standardwert von start ist 0.
limit
Der Standardwert für Limit ist 20.
orderBy
Bei der Sortierung wird nur das Feld createdDate akzeptiert.
requestType
Akzeptiert entweder PUBLIC oder PRIVATE.

Anfrage

Die folgende Anfrage ruft eine Liste von Paketen mit öffentlicher Verfügbarkeit ab.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/transfer/list?property=status%3D%3DCOMPLETED%2CFAILED&requestType=PUBLIC&orderby=-createdDate \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/json' \
  -H 'Authorization: {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \

Antwort

Eine erfolgreiche Antwort gibt eine Liste von öffentlichen Paketen und deren Details zurück.

Antwort anzeigen
code language-json 
{
    "totalElements": 14,
    "currentPage": 0,
    "totalPages": 1,
    "hasPreviousPage": false,
    "hasNextPage": false,
    "data": [
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_ORG}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Public package demo",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729359318000,
            "createdDate": 1729359316000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Public package demo",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729359284000,
            "createdDate": 1729359283000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Test Private Flow Final",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284462000,
            "createdDate": 1729275962000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOUCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Fest",
            "status": "FAILED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284104000,
            "createdDate": 1729253854000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "PublicPackageSharing",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284835000,
            "createdDate": 1729253556000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "PublicPackageSharing",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284835000,
            "createdDate": 1729253556000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "PublicPackageSharing",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284835000,
            "createdDate": 1729253556000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Public Package Audit Test",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284667000,
            "createdDate": 1729253421000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Public Package Audit Test",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284957000,
            "createdDate": 1729253143000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Public Package Audit Test",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284562000,
            "createdDate": 1729252975000,
            "requestType": "PUBLIC"
        },
        {
               "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Private Package Test 1",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284262000,
            "createdDate": 1729229755000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Demo Package 1016",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284784000,
            "createdDate": 1729208888000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Public Package test 1",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284934000,
            "createdDate": 1729153097000,
            "requestType": "PUBLIC"
        },
        {
            "id": "{ID}",
            "sourceIMSOrgId": "{ORG_ID}",
            "sourceOrgName": "{SOURCE_NAME}",
            "targetIMSOrgId": "{TARGET_ID}",
            "targetOrgName": "{TARGET_NAME}",
            "packageId": "{PACKAGE_ID}",
            "packageName": "Public Package test 1",
            "status": "COMPLETED",
            "initiatedBy": "{INITIATED_BY}",
            "completedTime": 1729284912000,
            "createdDate": 1729153043000,
            "requestType": "PUBLIC"
        }
    ],
    "nextPage": null,
    "pageSize": null
}

Payload des Pakets kopieren (#package-payload)

Sie können die Payload eines öffentlichen Pakets kopieren, indem Sie eine GET-Anfrage an den /packages/payload-Endpunkt stellen, der die entsprechende ID des Pakets im Anfragepfad enthält.

API-Format

GET /packages/payload/{PACKAGE_ID}
Parameter
Beschreibung
{PACKAGE_ID}
Die ID des Pakets, das Sie kopieren möchten.

Anfrage

Die folgende Anfrage ruft die Payload eines Pakets mit der ID {PACKAGE_ID} ab.

curl -X GET \
  https://platform.adobe.io/data/foundation/exim/packages/payload/{PACKAGE_ID} \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
Eigenschaft
Beschreibung
Typ
Erforderlich
imsOrdId
Die ID der Organisation, zu der das Paket gehört.
Zeichenfolge
Ja
packageId
Die ID des Pakets, das die angeforderte Payload ist.
Zeichenfolge
Ja

Antwort

Eine erfolgreiche Antwort gibt die Payload des Pakets zurück.

{
    "imsOrgId": "{ORG_ID}",
    "packageId": "{PACKAGE_ID}"
}

Migrieren von Aktualisierungen der Objektkonfiguration

Verwenden Sie den /packages-Endpunkt in der Sandbox-Tooling-API, um Aktualisierungen der Objektkonfiguration zu migrieren.

Aktualisierungsvorgänge (#update-operations)

Vergleichen Sie eine angegebene oder neueste Version eines Package-Snapshots mit dem aktuellen Status der Quell-Sandbox oder einer zuvor verwendeten Ziel-Sandbox, in die das Paket importiert wurde, indem Sie eine POST-Anfrage an den /packages/{packageId}/version/compare-Endpunkt senden und dabei die Paket-ID angeben.

API-Format

PATCH /packages/{packageId}/version/compare
Eigenschaft
Beschreibung
Typ
Erforderlich
packageId
Die ID des Pakets.
Zeichenfolge
Ja

Anfrage

curl -X POST \
  https://platform-stage.adobe.io/data/foundation/exim/packages/{PACKAGE_ID}/version/compare/ \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
      "triggerNew": true,
      "targetSandbox": "{SANDBOX_NAME}"
  }'
Eigenschaft
Beschreibung
Typ
Erforderlich
triggerNew
Markieren, um den neuen Vergleichsberechnungsauftrag auch dann als Trigger zu kennzeichnen, wenn bereits ein aktiver oder abgeschlossener Auftrag vorhanden ist.
Boolesch
Nein
targetSandbox
Stellt den Namen der Ziel-Sandbox dar, mit der der Unterschied berechnet werden muss. Wenn nichts angegeben ist, wird die Quell-Sandbox als Ziel-Sandbox verwendet.
Zeichenfolge
Nein

Antwort

Eine erfolgreiche Antwort für einen zuvor abgeschlossenen Auftrag gibt das Auftragsobjekt mit den zuvor berechneten Vergleichsergebnissen zurück. Ein neu abgeschlossener Auftrag gibt die Auftrags-ID zurück.

Antwort anzeigen (gesendeter Auftrag)
code language-json 
{
    "status": "OK",
    "type": "SUCCESS",
    "ajo": false,
    "message": "Job with ID: {JOB_ID}",
    "object": {
        "id": "c4b7d07ae4c646279e2070a31c50bd5c",
        "name": "Compute Job Package: {SNAPSHOT_ID}",
        "description": null,
        "visibility": "TENANT",
        "requestType": "VERSION",
        "expiry": 0,
        "snapshotId": "{SNAPSHOT_ID}",
        "packageVersion": 0,
        "createdTimestamp": 0,
        "modifiedTimestamp": 0,
        "type": "PARTIAL",
        "jobStatus": "SUCCESS",
        "jobType": "COMPUTE",
        "counter": 0,
        "imsOrgId": "{ORG_ID}",
        "sourceSandbox": {
            "name": "prod",
            "imsOrgId": "{ORG_ID}",
            "empty": false
        },
        "destinationSandbox": {
            "name": "amanda-1",
            "imsOrgId": "{ORG_ID}",
            "empty": false
        },
        "deltaPackageVersion": {
            "packageId": "{PACKAGE_ID}",
            "currentVersion": 0,
            "validated": false,
            "rootArtifacts": [
                {
                    "id": "https://ns.adobe.com/sandboxtoolingstage/schemas/355f461cbfb662fd0d12d06aeab34e206efcfa5d913604de",
                    "type": "REGISTRY_SCHEMA",
                    "found": false,
                    "count": 0
                }
            ],
            "eximGraphDelta": {
                "vertices": [],
                "pluginDeltas": [
                    {
                        "sourceArtifact": {
                            "id": "https://ns.adobe.com/sandboxtoolingstage/mixins/9fad8b185640a2db7daf9bb1295543ee8cb5965d80a21e8d",
                            "type": "REGISTRY_MIXIN",
                            "found": false,
                            "count": 0,
                            "title": "Custom FieldGroup 2"
                        },
                        "targetArtifact": {
                            "id": "https://ns.adobe.com/sandboxtoolingstage/mixins/b7fa3024777ef11b68c5121e937d8543677093f4f0e63a5f",
                            "type": "REGISTRY_MIXIN",
                            "found": false,
                            "count": 0,
                            "title": "Custom FieldGroup 2_1738766274074"
                        },
                        "changes": [
                            {
                                "op": "replace",
                                "path": "/title",
                                "oldValue": "Custom FieldGroup 2_1738766274074",
                                "newValue": "Custom FieldGroup 2"
                            },
                            {
                                "op": "replace",
                                "path": "/description",
                                "oldValue": "Description for furnished object",
                                "newValue": ""
                            }
                        ]
                    },
                    {
                        "sourceArtifact": {
                            "id": "https://ns.adobe.com/sandboxtoolingstage/mixins/304ac900943716c8bd99e6aaf6aa840aac91995729f1987f",
                            "type": "REGISTRY_MIXIN",
                            "found": false,
                            "count": 0,
                            "title": "Custom FieldGroup 4"
                        },
                        "targetArtifact": {
                            "id": "https://ns.adobe.com/sandboxtoolingstage/mixins/34c9add91cce4a40d68a0e715c9f0a16048871734f8c8b74",
                            "type": "REGISTRY_MIXIN",
                            "found": false,
                            "count": 0,
                            "title": "Custom FieldGroup 4_1738766274074"
                        },
                        "changes": [
                            {
                                "op": "replace",
                                "path": "/title",
                                "oldValue": "Custom FieldGroup 4_1738766274074",
                                "newValue": "Custom FieldGroup 4"
                            },
                            {
                                "op": "replace",
                                "path": "/description",
                                "oldValue": "Description for furnished object",
                                "newValue": ""
                            }
                        ]
                    }
                ]
            }
        },
        "importReplacementMap": {
            "https://ns.adobe.com/sandboxtoolingstage/mixins/9fad8b185640a2db7daf9bb1295543ee8cb5965d80a21e8d": "https://ns.adobe.com/sandboxtoolingstage/mixins/b7fa3024777ef11b68c5121e937d8543677093f4f0e63a5f",
            "5a45f8cd309d5ed5797be9a0af65e89152a51d57a6c74b52": "4ae041fa182d6faf2e7c56463399170d913138a7c5712909",
            "https://ns.adobe.com/sandboxtoolingstage/schemas/b2b7705e770a35341b8bc5ec5e3644d9c7387266777fe4ba": "https://ns.adobe.com/sandboxtoolingstage/schemas/838c4e21ad81543ac14238ac1756012f7f98f0e0bec6b425",
            "https://ns.adobe.com/sandboxtoolingstage/schemas/355f461cbfb662fd0d12d06aeab34e206efcfa5d913604de": "https://ns.adobe.com/sandboxtoolingstage/schemas/9a55692d527169d0239e126137a694ed9db2406c9bcbd06a",
            "8f45c79235c91e7f0c09af676a77d170a34b5ee0ad5de72c": "65d755cc3300674c3cfcec620c59876af07f046884afd359",
            "f04b8e461396ff426f8ba8dc5544f799bf287baa8e0fa5c": "b6fa821ada8cb97cac384f0b0354bbe74209ec97fb6a83a3",
            "https://ns.adobe.com/sandboxtoolingstage/mixins/304ac900943716c8bd99e6aaf6aa840aac91995729f1987f": "https://ns.adobe.com/sandboxtoolingstage/mixins/34c9add91cce4a40d68a0e715c9f0a16048871734f8c8b74",
            "c8304f3cb7986e8c9b613cd8d832125bd867fb4a5aedf67a": "4d21e9bf89ce0042b52d7d41ff177a7697d695e2617d1fc1"
        },
        "schemaFieldMappings": null
    }
}
Antwort anzeigen (neu gesendeter Auftrag)
code language-json 
{
    "status": "OK",
    "type": "SUCCESS",
    "ajo": false,
    "message": "Job with ID: {JOB_ID}",
    "object": {
        "id": "aa5cfacf35a8478c8cf44a675fab1c30 ",
        "name": "Compute Job Package: {SNAPSHOT_ID}",
        "description": null,
        "visibility": "TENANT",
        "requestType": "VERSION",
        "expiry": 0,
        "snapshotId": "{SNAPSHOT_ID}",
        "packageVersion": 0,
        "createdTimestamp": 0,
        "modifiedTimestamp": 0,
        "type": "PARTIAL",
        "jobStatus": "IN_PROGRESS",
        "jobType": "COMPUTE",
        "counter": 0,
        "imsOrgId": "{ORG_ID}",
        "sourceSandbox": {
            "name": "prod",
            "imsOrgId": "{ORG_ID}",
            "empty": false
        },
        "destinationSandbox": {
            "name": "amanda-1",
            "imsOrgId": "{ORG_ID}",
            "empty": false
        },
        "schemaFieldMappings": null
    }
}

Paketversion aktualisieren (#package-versioning)

Aktualisieren Sie für jedes Objekt das Paket auf eine neue Version, indem Sie die GET-Anfrage an den /packages/{packageId}/version/save-Endpunkt senden und dabei die Paket-ID angeben. Verwenden Sie dazu den neuesten Snapshot aus der Quell-Sandbox.

API-Format

PATCH /packages/{packageId}/version/save
Eigenschaft
Beschreibung
Typ
Erforderlich
packageId
Die ID des Pakets.
Zeichenfolge
Ja

Anfrage

curl -X POST \
  https://platform-stage.adobe.io/data/foundation/exim/packages/{PACKAGE_ID}/version/save/ \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \

Antwort

Eine erfolgreiche Antwort gibt den Auftragsstatus für das Versions-Upgrade zurück.

{
    "id": "3cec9bae662e43d9b9106fcbf7744a75",
    "name": "Version Job Package: {JOB_ID}",
    "description": null,
    "visibility": "TENANT",
    "requestType": "VERSION",
    "expiry": 0,
    "snapshotId": "{SNAPSHOT_ID}",
    "packageVersion": 2,
    "createdTimestamp": 0,
    "modifiedTimestamp": 0,
    "type": "PARTIAL",
    "jobStatus": "PENDING",
    "jobType": "UPGRADE",
    "counter": 0,
    "imsOrgId": "{ORG_ID}",
    "sourceSandbox": {
        "name": "prod",
        "imsOrgId": "{ORG_ID}",
        "empty": false
    },
    "destinationSandbox": {
        "name": "prod",
        "imsOrgId": "{ORG_ID}",
        "empty": false
    },
    "schemaFieldMappings": null
}

Abrufen des Paketversionsverlaufs (#package-version-history)

Rufen Sie den Versionsverlauf des Pakets ab, einschließlich Zeitstempel und Modifikator, indem Sie eine GET-Anfrage an den /packages/{packageId}/history-Endpunkt stellen und die Paket-ID angeben.

API-Format

PATCH /packages/{packageId}/history
Eigenschaft
Beschreibung
Typ
Erforderlich
packageId
Die ID des Pakets.
Zeichenfolge
Ja

Anfrage

curl -X POST \
  https://platform-stage.adobe.io/data/foundation/exim/packages/{PACKAGE_ID}/history/ \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \

Antwort

Eine erfolgreiche Antwort gibt den Versionsverlauf eines Pakets zurück.

[
    {
        "id": "cb68591a1ed941e191e7f52e33637a26",
        "version": 0,
        "createdDate": 1739516784000,
        "modifiedDate": 1739516784000,
        "createdBy": "{CREATED_BY}",
        "modifiedBy": "{MODIFIED_BY}",
        "imsOrgId": "{ORG_ID}",
        "packageVersion": 3
    },
    {
        "id": "e26189e6e4df476bb66c3fc3e66a1499",
        "version": 0,
        "createdDate": 1739343268000,
        "modifiedDate": 1739343268000,
        "createdBy": "{CREATED_BY}",
        "modifiedBy": "{MODIFIED_BY}",
        "imsOrgId": "{ORG_ID}",
        "packageVersion": 2
    },
    {
        "id": "11af34c0eee449ac84ef28c66d9383e3",
        "version": 0,
        "createdDate": 1739343073000,
        "modifiedDate": 1739343073000,
        "createdBy": "{CREATED_BY}",
        "modifiedBy": "{MODIFIED_BY}",
        "imsOrgId": "{ORG_ID}",
        "packageVersion": 1
    }
]

Senden eines Aktualisierungsauftrags (#submit-update)

Pushen Sie neue Aktualisierungen in die Ziel-Sandbox-Objekte, indem Sie eine PATCH-Anfrage an den /packages/{packageId}/import-Endpunkt senden und dabei die Paket-ID angeben.

API-Format

PATCH /packages/{packageId}/import
Eigenschaft
Beschreibung
Typ
Erforderlich
packageId
Die ID des Pakets.
Zeichenfolge
Ja

Anfrage

curl -X POST \
  https://platform-stage.adobe.io/data/foundation/exim/packages/{PACKAGE_ID}/import/ \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
      "id": "50fd94f8072b4f248737a2b57b41058f",
      "name": "Test Update",
      "destinationSandbox": {
        "name": "test-sandbox-sbt",
        "imsOrgId": "{ORG_ID}"
      },
      "overwriteMappings": {
        "https://ns.adobe.com/sandboxtoolingstage/schemas/327a48c83a5359f8160420a00d5a07f0ba8631a1fd466f9e" : {
            "id" : "https://ns.adobe.com/sandboxtoolingstage/schemas/e346bb2cd7b26576cb51920d214aebbd42940a9bf94a75cd",
            "type" : "REGISTRY_SCHEMA"
        }
      }
  }'

Antwort

Eine erfolgreiche Antwort gibt die Auftrags-ID für die Aktualisierung zurück.

{
    "id": "3cec9bae662e43d9b9106fcbf7744a75",
    "name": "Update Job Name",
    "description": "Update Job Description",
    "visibility": "TENANT",
    "requestType": "IMPORT",
    "expiry": 0,
    "snapshotId": "{SNAPSHOT_ID}",
    "packageVersion": 2,
    "createdTimestamp": 0,
    "modifiedTimestamp": 0,
    "type": "PARTIAL",
    "jobStatus": "PENDING",
    "jobType": "UPDATE",
    "counter": 0,
    "imsOrgId": "{ORG_ID}",
    "sourceSandbox": {
        "name": "prod",
        "imsOrgId": "{ORG_ID}",
        "empty": false
    },
    "destinationSandbox": {
        "name": "amanda-1",
        "imsOrgId": "{ORG_ID}",
        "empty": false
    },
    "schemaFieldMappings": null
}

Aktualisierung und Überschreibung für ein Paket deaktivieren (#disable-update)

Deaktivieren Sie die Aktualisierung und Überschreibung für Pakete, die sie nicht unterstützen, indem Sie eine GET-Anfrage an den /packages/{packageId}/?{QUERY_PARAMS}-Endpunkt stellen und dabei die Paket-ID angeben.

API-Format

PATCH /packages/{packageId}?{QUERY_PARAMS}
Eigenschaft
Beschreibung
Typ
Erforderlich
packageId
Die ID des Pakets.
Zeichenfolge
Ja
Der Abfrageparameter „getCapabilities“. Dieser sollte auf true oder false gesetzt werden
Boolesch
Ja

Anfrage

curl -X POST \
  https://platform-stage.adobe.io/data/foundation/exim/packages/{PACKAGE_ID}?getCapabilities=true'/ \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \

Antwort

Eine erfolgreiche Antwort gibt eine Liste der Funktionen des Pakets zurück.

{
    "id": "80230dde96574a828191144709bb9b51",
    "version": 3,
    "createdDate": 1749808582000,
    "modifiedDate": 1749808648000,
    "createdBy": "{CREATED_BY}",
    "modifiedBy": "{MODIFIED_BY}",
    "name": "Ankit_Primary_Descriptor_Test",
    "description": "RestPackage",
    "imsOrgId": "{ORG_ID}",
    "clientId": "usecasebuilder",
    "packageType": "PARTIAL",
    "expiry": 1757584598000,
    "publishDate": 1749808648000,
    "status": "PUBLISHED",
    "packageVisibility": "PRIVATE",
    "latestPackageVersion": 0,
    "packageAccessType": "TENANT",
    "artifactsList": [
        {
            "id": "https://ns.adobe.com/sandboxtoolingstage/schemas/1c767056056de64d8030380d1b9f570d26bc15501a1e0e95",
            "altId": null,
            "type": "REGISTRY_SCHEMA",
            "found": false,
            "count": 0
        }
    ],
    "schemaMapping": {},
    "sourceSandbox": {
        "name": "atul-sandbox",
        "imsOrgId": "{ORG_ID}",
        "empty": false
    },
    "packageCapabilities": {
        "capabilities": [
            "VERSIONABLE"
        ]
    }
}
recommendation-more-help
e243ad8f-a318-46b3-9930-159a80f82b42