Pular para o conteúdo principal
GET
Obter um pipeline com suas etapas e atributos

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

pipelineId
string
obrigatório

Identificador único do pipeline, conforme GET /pipelines.

Required string length: 1 - 255
Exemplo:

"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10"

Resposta

Resposta bem-sucedida

Um pipeline do workspace com as etapas e os atributos da sua versão atual.

id
string
obrigatório

Identificador único do pipeline.

Exemplo:

"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10"

label
string
obrigatório

Nome do pipeline como exibido no Bridge.

Exemplo:

"Sales"

isDefault
boolean
obrigatório

Indica se um registro criado sem pipelineId vai para este pipeline.

Exemplo:

true

currentVersion
integer
obrigatório

Versão do pipeline que os novos registros seguem.

Exemplo:

3

acceptsApiRecords
boolean
obrigatório

Indica se é possível criar registros neste pipeline pela API.

Exemplo:

true

initialStageId
string
obrigatório

Etapa em que um registro criado sem stageId começa.

Exemplo:

"stage-new"

stages
PipelineStageResponse · object[]
obrigatório

Etapas da versão atual, em ordem.

attributes
PipelineAttributeResponse · object[]

Atributos da versão atual.

closeReasons
PipelineCloseReasonResponse · object[]

Motivos com os quais um registro pode ser fechado; os motivos desativados são omitidos.