Saltar al contenido

Endpoint para implementaciones en Jitterbit App Builder

Introducción

Con App Builder 4.52 y versiones posteriores, se pueden usar endpoints REST para recuperar los detalles de las versiones o para comenzar a construirlas:

Requisitos previos

  • Debe generar una clave API en el servidor y ser miembro del rol Deployment.

release endpoint

Con este endpoint, se pueden realizar las siguientes acciones:

  • GET: Recuperar información de la versión para una solución o versión especificada.

  • POST: Construir una versión.

Las respuestas pueden contener los siguientes campos:

  • releaseId: Identificador de la versión.

  • solutionId: Identificador de la solución.

  • name: Nombre de la versión (corresponde al nombre de la solución).

  • version: Número de versión proporcionado por el desarrollador.

  • releaseNotes: Notas de la versión proporcionadas por el desarrollador.

  • releaseDate: Fecha de lanzamiento proporcionada por el desarrollador.

  • status: Estado de construcción de solo lectura. Los valores incluyen los siguientes:

    • En cola
    • Construyendo
    • Construido
    • Fallido

  • fileName: Nombre del archivo del paquete (LP).

  • file: Archivo del paquete codificado en Base64.

  • snapshot: Indicador para indicar si se debe tomar una instantánea antes de que se construya la versión.

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

Recuperar las versiones de solución especificadas.

  • solutionId: Identificador de la solución.
Ejemplo 
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 }}

Recuperar la información de una versión específica, incluyendo el archivo del paquete codificado en Base64.

  • releaseId: Identificador de la versión.
Ejemplo 
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

Construir una versión.

Importante

Esta es una operación sincrónica (bloqueante): el servidor no responde hasta que la construcción se complete, con éxito o de otra manera.

Ejemplo 
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

Envía una solicitud de construcción a la cola.

Las respuestas pueden contener los siguientes campos:

  • releaseId: Identificador de la versión.

  • solutionId: Identificador de la solución.

  • name: Nombre de la versión (corresponde al nombre de la solución).

  • version: Versión proporcionada por el desarrollador.

  • releaseNotes: Notas de la versión proporcionadas por el desarrollador.

  • releaseDate: Fecha de la versión proporcionada por el desarrollador.

  • status: Estado de la construcción. Solo lectura. Los valores incluyen en cola, construyendo, construido y fallido.

  • snapshot: Indicador para indicar si se debe tomar una instantánea antes de que se construya la versión.

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

Coloca una construcción de versión en la cola.

Importante

Esta es una operación asíncrona y no bloqueante. El servidor devuelve inmediatamente; la construcción se realiza en segundo plano. Los desarrolladores deben consultar el estado actual para determinar cuándo se ha completado la construcción.

Ejemplo 
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 }}

Recupera el estado actual de una versión en cola.

  • releaseId: Identificador de la versión.

  • solutionId: Identificador de la solución.

Ejemplo 
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
}