Ir para o conteúdo

Use endpoints for deployments on Jitterbit App Builder

Introdução

Você pode usar endpoints REST para recuperar os detalhes das versões, iniciar a construção delas ou obter informações sobre o ambiente de destino:

Pré-requisitos

  • Você deve gerar uma chave de API no servidor e ser membro do papel Deployment.

release endpoint

Nota

Este endpoint está disponível para o App Builder 4.52 e versões posteriores.

Com este endpoint, você pode fazer o seguinte:

  • GET: Recuperar informações da versão para uma solução ou versão especificada.

  • POST: Construir uma versão.

As respostas podem conter os seguintes campos:

  • releaseId: Identificador da versão.

  • solutionId: Identificador da solução.

  • name: Nome da versão (corresponde ao nome da solução).

  • version: Número da versão fornecido pelo desenvolvedor.

  • releaseNotes: Notas de versão fornecidas pelo desenvolvedor.

  • releaseDate: Data de lançamento fornecida pelo desenvolvedor.

  • status: Status de construção somente leitura. Os valores incluem os seguintes:

    • Enfileirado
    • Construindo
    • Construído
    • Falhou

  • fileName: Nome do arquivo do pacote (LP).

  • file: Arquivo do pacote codificado em Base64.

  • snapshot: Flag para indicar se um snapshot deve ser tirado antes que a versão seja construída.

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

Recuperar as versões da solução especificada.

  • solutionId: Identificador da solução.
Exemplo 
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 as informações de uma versão específica, incluindo o arquivo do pacote codificado em Base64.

  • releaseId: Identificador da versão.
Exemplo 
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

Crie uma versão.

Importante

Esta é uma operação síncrona (bloqueante): o servidor não responde até que a construção seja concluída, com sucesso ou não.

Exemplo 
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

Nota

Este endpoint está disponível para App Builder 4.52 e versões posteriores.

Envie uma solicitação de construção para a fila.

As respostas podem conter os seguintes campos:

  • releaseId: Identificador da versão.

  • solutionId: Identificador da solução.

  • name: Nome da versão (corresponde ao nome da solução).

  • version: Versão fornecida pelo desenvolvedor.

  • releaseNotes: Notas de versão fornecidas pelo desenvolvedor.

  • releaseDate: Data de lançamento fornecida pelo desenvolvedor.

  • status: Status da construção. Somente leitura. Os valores incluem enfileirado, construindo, construído e falhou.

  • snapshot: Flag para indicar se um snapshot deve ser tirado antes que a versão seja construída.

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

Enfileire uma construção de versão.

Importante

Esta é uma operação assíncrona, não bloqueante. O servidor retorna imediatamente; a construção ocorre em segundo plano. Os desenvolvedores devem consultar o status atual para determinar quando a construção foi concluída.

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

Recupere o status atual de uma versão enfileirada.

  • releaseId: Identificador da versão.

  • solutionId: Identificador da solução.

Exemplo 
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

Nota

Este endpoint está disponível para App Builder 4.54 e versões posteriores.

Com este endpoint, você pode fazer o seguinte:

  • GET: Recuperar a configuração do ambiente.

As respostas podem conter os seguintes campos:

  • environmentId: Identificador do ambiente.

  • name: Nome do ambiente, por exemplo, QA ou Produção.

  • url: URL raiz canônica do ambiente.

  • supportsDeployment: Indica se o ambiente suporta implantações.

  • supportsInstallOnDeploy: Indica se o ambiente permite que pacotes sejam instalados durante o processo de implantação.

  • authenticationType: Denota o tipo de autenticação necessária:

    • api_key

    • http_basic_auth

    • auth_server

GET /rest/v1/vinyl-deploy/metadata

Recupera a configuração do ambiente.