Zum Inhalt springen

Verwenden Sie Endpunkte für Bereitstellungen im Jitterbit App Builder

Einführung

Sie können REST-Endpunkte verwenden, um die Details von Releases abzurufen, um mit deren Erstellung zu beginnen oder um Informationen über die Zielumgebung zu erhalten:

Voraussetzungen

  • Sie müssen einen API-Schlüssel auf dem Server generieren und Mitglied der Rolle Deployment sein.

release-Endpunkt

Hinweis

Dieser Endpunkt ist für App Builder 4.52 und höher verfügbar.

Mit diesem Endpunkt können Sie Folgendes tun:

  • GET: Informationen zu einem bestimmten Release oder einer bestimmten Lösung abrufen.

  • POST: Ein Release erstellen.

Antworten können die folgenden Felder enthalten:

  • releaseId: Release-Identifikator.

  • solutionId: Lösungs-Identifikator.

  • name: Release-Name (entspricht dem Lösungsnamen).

  • version: Vom Entwickler bereitgestellte Versionsnummer.

  • releaseNotes: Vom Entwickler bereitgestellte Release-Notizen.

  • releaseDate: Vom Entwickler bereitgestelltes Veröffentlichungsdatum.

  • status: Nur-Lese-Bau-Status. Werte umfassen Folgendes:

    • Warteschlange
    • Wird gebaut
    • Gebaut
    • Fehlgeschlagen

  • fileName: Paket (LP) Dateiname.

  • file: Base64-kodierte Paketdatei.

  • snapshot: Flag, um anzuzeigen, ob vor dem Erstellen des Releases ein Snapshot erstellt werden soll.

GET /rest/v1/vinyl-deploy/release?solutionId={{ solutionId }}

Rufen Sie die angegebenen Lösungs-Releases ab.

  • solutionId: Lösungs-Identifikator.
Beispiel 
GET https://example.com/rest/v1/vinyl-deploy/release?solutionId=4df8b502-56d0-498a-98de-511b4134ee3c
Accept: application/json
X-Api-Key: abcdef.1234567890


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "count": null,
  "items": [
    {
      "releaseId": "1e3690ef-afff-4a4a-919e-01e100b259d7",
      "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
      "name": "Customers",
      "version": "1.0",
      "releaseNotes": "Added company name.",
      "releaseDate": "2025-11-06T00:00:00"
    },
    {
      "releaseId": "ad16337f-d677-4527-84f1-651bd928238a",
      "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
      "name": "Customers",
      "version": "1.0",
      "releaseNotes": null,
      "releaseDate": "2025-10-27T00:00:00"
    }
  ],
  "message": null,
  "validations": [],
  "status": 200
}

GET /rest/v1/vinyl-deploy/release/{{ releaseId }}

Rufen Sie die Informationen für ein bestimmtes Release ab, einschließlich der base64-kodierten Paketdatei.

  • releaseId: Release-Identifikator.
Beispiel 
GET https://example.com/rest/v1/vinyl-deploy/release/1e3690ef-afff-4a4a-919e-01e100b259d7?solutionId=4df8b502-56d0-498a-98de-511b4134ee3c
Accept: application/json
X-Api-Key:  abcdef.1234567890


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "item": {
    "releaseId": "9b5211e1-402a-4f04-b87d-33f28a55987a",
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "name": "Customers",
    "version": "1.0",
    "releaseNotes": "These are my release notes.",
    "releaseDate": "2025-11-06T00:00:00",
    "status": "built",
    "fileName": "Customers-1.0.LP",
    "file": "...Base64-encoded file...",
    "snapshot": false
  },
  "message": null,
  "validations": [],
  "status": 200
}

POST /rest/v1/vinyl-deploy/release

Erstellen Sie eine Veröffentlichung.

Wichtig

Dies ist eine synchrone (blockierende) Operation: Der Server antwortet nicht, bis der Build abgeschlossen ist, unabhängig davon, ob er erfolgreich war oder nicht.

Beispiel 
POST https://example.com/rest/v1/vinyl-deploy/release
Content-Type: application/json
X-Api-Key:  abcdef.1234567890

{
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "releaseNotes": "Added company name.",
    "snapshot": false
}


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "item": {
    "releaseId": "9b5211e1-402a-4f04-b87d-33f28a55987a",
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "name": "Customers",
    "version": "1.0",
    "releaseNotes": "These are my release notes.",
    "releaseDate": "2025-11-06T00:00:00",
    "status": "built",
    "fileName": "Customers-1.0.LP",
    "file": "...Base64-encoded file...",
    "snapshot": false
  },
  "message": null,
  "validations": [],
  "status": 200
}

release-queue endpoint

Hinweis

Dieser Endpunkt ist verfügbar für App Builder 4.52 und höher.

Reichen Sie eine Build-Anfrage in die Warteschlange ein.

Antworten können die folgenden Felder enthalten:

  • releaseId: Veröffentlichungsidentifikator.

  • solutionId: Lösungsidentifikator.

  • name: Veröffentlichungsname (entspricht dem Lösungsnamen).

  • version: Vom Entwickler bereitgestellte Version.

  • releaseNotes: Vom Entwickler bereitgestellte Veröffentlichungsnotizen.

  • releaseDate: Vom Entwickler bereitgestelltes Veröffentlichungsdatum.

  • status: Build-Status. Nur lesbar. Werte sind: queued, building, built und failed.

  • snapshot: Flag, das angibt, ob ein Snapshot vor dem Build der Veröffentlichung erstellt werden soll.

POST /rest/v1/vinyl-deploy/release-queue

Warten Sie auf einen Veröffentlichungsbuild.

Wichtig

Dies ist eine asynchrone, nicht blockierende Operation. Der Server gibt sofort zurück; der Build erfolgt im Hintergrund. Entwickler müssen den aktuellen Status abfragen, um zu bestimmen, wann der Build abgeschlossen ist.

Beispiel 
POST https://example.com/rest/v1/vinyl-deploy/release-queue
Content-Type: application/json
X-Api-Key:  abcdef.1234567890

{
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "releaseNotes": "Added company name.",
    "snapshot": false
}


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "item": {
    "releaseId": "9b5211e1-402a-4f04-b87d-33f28a55987a",
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "name": "Customers",
    "version": "1.0",
    "releaseNotes": "Added company name.",
    "releaseDate": "2025-11-06T00:00:00",
    "status": "queued",
    "snapshot": false
  },
  "message": null,
  "validations": [],
  "status": 200
}

GET /rest/v1/vinyl-deploy/release-queue/{{ releaseId }}?solutionId={{ solutionId }}

Rufen Sie den aktuellen Status einer wartenden Veröffentlichung ab.

  • releaseId: Veröffentlichungsidentifikator.

  • solutionId: Lösungsidentifikator.

Beispiel 
GET https://example.com/rest/v1/vinyl-deploy/release-queue/9b5211e1-402a-4f04-b87d-33f28a55987a
Content-Type: application/json
X-Api-Key:  abcdef.1234567890


HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "item": {
    "releaseId": "9b5211e1-402a-4f04-b87d-33f28a55987a",
    "solutionId": "4df8b502-56d0-498a-98de-511b4134ee3c",
    "name": "Customers",
    "version": "1.0",
    "releaseNotes": "Added company name.",
    "releaseDate": "2025-11-06T00:00:00",
    "status": "built",
    "snapshot": false
  },
  "message": null,
  "validations": [],
  "status": 200
}

metadata endpoint

Hinweis

Dieser Endpunkt ist verfügbar für App Builder 4.54 und höher.

Mit diesem Endpunkt können Sie Folgendes tun:

  • GET: Rufen Sie die Umgebungs-Konfiguration ab.

Antworten können die folgenden Felder enthalten:

  • environmentId: Umgebungsidentifikator.

  • name: Umweltname, z.B. QA oder Production.

  • url: Kanonische Umgebungsstamm-URL.

  • supportsDeployment: Gibt an, ob die Umgebung Bereitstellungen unterstützt.

  • supportsInstallOnDeploy: Gibt an, ob die Umgebung die Installation von Paketen während des Bereitstellungsprozesses erlaubt.

  • authenticationType: Bezeichnet den erforderlichen Authentifizierungstyp:

    • api_key

    • http_basic_auth

    • auth_server

GET /rest/v1/vinyl-deploy/metadata

Ruft die Umgebungs-Konfiguration ab.