Saltar al contenido principal
GET
Obtener un pipeline con sus etapas y atributos

Autorizaciones

x-api-key
string
header
requerido

Copy the API key as provided by the Bridge Console.

Parámetros de ruta

workspaceId
string<uuid>
requerido

Identificador único del workspace (UUID v4).

Ejemplo:

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

pipelineId
string
requerido

Identificador único del pipeline, según GET /pipelines.

Required string length: 1 - 255
Ejemplo:

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

Respuesta

Respuesta satisfactoria

Un pipeline del workspace con las etapas y los atributos de su versión actual.

id
string
requerido

Identificador único del pipeline.

Ejemplo:

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

label
string
requerido

Nombre del pipeline tal como se muestra en Bridge.

Ejemplo:

"Sales"

isDefault
boolean
requerido

Indica si un registro creado sin pipelineId va a este pipeline.

Ejemplo:

true

currentVersion
integer
requerido

Versión del pipeline que siguen los registros nuevos.

Ejemplo:

3

acceptsApiRecords
boolean
requerido

Indica si se pueden crear registros en este pipeline mediante la API.

Ejemplo:

true

initialStageId
string
requerido

Etapa en la que empieza un registro creado sin stageId.

Ejemplo:

"stage-new"

stages
PipelineStageResponse · object[]
requerido

Etapas de la versión actual, en orden.

attributes
PipelineAttributeResponse · object[]

Atributos de la versión actual.

closeReasons
PipelineCloseReasonResponse · object[]

Motivos con los que se puede cerrar un registro; los motivos retirados se omiten.