PipelineDto
Response DTO for sales pipeline information
Properties
| Name | Type | Description |
|---|---|---|
| code | string | Stable identifier. For library-shipped items this is the library code; for tenant-imported |
Stable identifier. For library-shipped items this is the library code; for tenant-imported | ||
| name | string | Display name shown to users in lists, dialogs, and the import browser. |
Display name shown to users in lists, dialogs, and the import browser. | ||
| description | string | Optional human-readable summary of what this entity is for. |
Optional human-readable summary of what this entity is for. | ||
| libraryCode | string | The Code of the library template this entity was imported from, or null if the entity |
The Code of the library template this entity was imported from, or null if the entity | ||
| libraryStatus | enum | Describes a library-imported entity's relationship to its source library template. |
Describes a library-imported entity's relationship to its source library template. | ||
| isImported | boolean | True if the tenant has already imported this library item. |
True if the tenant has already imported this library item. | ||
| deprecated | boolean | True if this library item has been retired. Deprecated items are hidden from the import |
True if this library item has been retired. Deprecated items are hidden from the import | ||
| isArchived | boolean | Indicates whether this pipeline is archived (inactive) |
Indicates whether this pipeline is archived (inactive) | ||
| defaultManagedByUser | CodeAndNameDto | |
| showKanbanBoard | boolean | Whether this pipeline should appear on the Boards kanban view |
Whether this pipeline should appear on the Boards kanban view | ||
| stages | array of PipelineStageDto | User-defined stages for this pipeline |
User-defined stages for this pipeline | ||
| stageCount | integer | The number of stages defined on this pipeline |
The number of stages defined on this pipeline | ||
| recurringTaskCount | integer | The number of recurring tasks associated with this pipeline |
The number of recurring tasks associated with this pipeline | ||
| createdDate | string | When the pipeline was created |
When the pipeline was created | ||
| updatedDate | string | When the pipeline was last updated |
When the pipeline was last updated | ||
JSON Example
{
"code": "string",
"name": "string",
"description": "string",
"libraryCode": "string",
"libraryStatus": "NotFromLibrary"
}
Used By Operations
-
POST
Create Pipeline
/tenants/{tenant}/pipelines
-
GET
Get Pipeline
/tenants/{tenant}/pipelines/{code}
-
PUT
Update Pipeline
/tenants/{tenant}/pipelines/{code}
-
GET
Get Library Pipeline
/tenants/{tenant}/pipelines/library/{code}
-
PUT
Revert Pipeline to Library
/tenants/{tenant}/pipelines/{code}/library-version