Heartwork API

Pipelines

Endpointhttps://api.heart.work

Download schema

Fetches a single Pipeline, by id.

GET

https://api.heart.work

/core-api/pipelines/{id}

Fetches a single Pipeline, by id. › path Parameters

id

string · required

Unique id of the Pipeline to fetch.

Fetches a single Pipeline, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

object[] · required

externalReference

string

description

string

GET/core-api/pipelines/{id}

curl --request GET \
  --url https://api.heart.work/core-api/pipelines/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}

plain

Updates an existing Pipeline, replacing it entirely.

PUT

https://api.heart.work

/core-api/pipelines/{id}

On success, returns the updated entity in the response.

Updates an existing Pipeline, replacing it entirely. › path Parameters

id

string · required

Updates an existing Pipeline, replacing it entirely. › Request Body

title

string · required

id

string · required

externalReference

string

description

string

object[]

Updates an existing Pipeline, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

object[] · required

externalReference

string

description

string

PUT/core-api/pipelines/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/pipelines/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ],
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ],
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}

plain

Deletes an existing Pipeline, by id.

DELETE

https://api.heart.work

/core-api/pipelines/{id}

Deletes an existing Pipeline, by id. › path Parameters

id

string · required

Unique id of the Pipeline to delete.

Deletes an existing Pipeline, by id. › Responses

No data returned

DELETE/core-api/pipelines/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/pipelines/:id

shell

Example Responses

No example specified for this content type

Searches Pipelines based on specific property values.

GET

https://api.heart.work

/core-api/pipelines

Searches Pipelines based on specific property values. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Title

Query

string

ids

string[]

external_references

string[]

Searches Pipelines based on specific property values. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/pipelines

curl --request GET \
  --url https://api.heart.work/core-api/pipelines

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "title": "title",
      "description": "description",
      "options": [
        {
          "id": "id",
          "label": "label"
        }
      ],
      "summaries": [
        {
          "optionId": "optionId",
          "isWeightedValue": true
        }
      ],
      "statuses": [
        {
          "id": "id",
          "name": "name",
          "displayOrder": 0
        }
      ]
    }
  ],
  "total": 0
}

plain

Creates and stores a new Pipeline.

POST

https://api.heart.work

/core-api/pipelines

On success, returns the newly created entity in the response.

Creates and stores a new Pipeline. › Request Body

title

string · required

externalReference

string

description

string

object[]

Creates and stores a new Pipeline. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

object[] · required

externalReference

string

description

string

POST/core-api/pipelines

curl --request POST \
  --url https://api.heart.work/core-api/pipelines \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}

plain

GET

https://api.heart.work

/core-api/pipelines/{id}/statistics

path Parameters

id

string · required

Responses

object[] · required

GET/core-api/pipelines/{id}/statistics

curl --request GET \
  --url https://api.heart.work/core-api/pipelines/:id/statistics

shell

Example Responses

{
  "statistics": [
    {
      "statusId": "statusId",
      "pipelineId": "pipelineId",
      "summaryStatistics": [
        {
          "id": "id",
          "name": "name",
          "total": 0
        }
      ]
    }
  ]
}

plain

Locations ProductAttributes

Heartwork API

Pipelines

Endpointhttps://api.heart.work

Download schema

Fetches a single Pipeline, by id.

GET

https://api.heart.work

/core-api/pipelines/{id}

Fetches a single Pipeline, by id. › path Parameters

id

string · required

Unique id of the Pipeline to fetch.

Fetches a single Pipeline, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

object[] · required

externalReference

string

description

string

GET/core-api/pipelines/{id}

curl --request GET \
  --url https://api.heart.work/core-api/pipelines/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}

plain

Updates an existing Pipeline, replacing it entirely.

PUT

https://api.heart.work

/core-api/pipelines/{id}

On success, returns the updated entity in the response.

Updates an existing Pipeline, replacing it entirely. › path Parameters

id

string · required

Updates an existing Pipeline, replacing it entirely. › Request Body

title

string · required

id

string · required

externalReference

string

description

string

object[]

Updates an existing Pipeline, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

object[] · required

externalReference

string

description

string

PUT/core-api/pipelines/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/pipelines/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ],
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ],
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}

plain

Deletes an existing Pipeline, by id.

DELETE

https://api.heart.work

/core-api/pipelines/{id}

Deletes an existing Pipeline, by id. › path Parameters

id

string · required

Unique id of the Pipeline to delete.

Deletes an existing Pipeline, by id. › Responses

No data returned

DELETE/core-api/pipelines/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/pipelines/:id

shell

Example Responses

No example specified for this content type

Searches Pipelines based on specific property values.

GET

https://api.heart.work

/core-api/pipelines

Searches Pipelines based on specific property values. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Title

Query

string

ids

string[]

external_references

string[]

Searches Pipelines based on specific property values. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/pipelines

curl --request GET \
  --url https://api.heart.work/core-api/pipelines

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "title": "title",
      "description": "description",
      "options": [
        {
          "id": "id",
          "label": "label"
        }
      ],
      "summaries": [
        {
          "optionId": "optionId",
          "isWeightedValue": true
        }
      ],
      "statuses": [
        {
          "id": "id",
          "name": "name",
          "displayOrder": 0
        }
      ]
    }
  ],
  "total": 0
}

plain

Creates and stores a new Pipeline.

POST

https://api.heart.work

/core-api/pipelines

On success, returns the newly created entity in the response.

Creates and stores a new Pipeline. › Request Body

title

string · required

externalReference

string

description

string

object[]

Creates and stores a new Pipeline. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

object[] · required

externalReference

string

description

string

POST/core-api/pipelines

curl --request POST \
  --url https://api.heart.work/core-api/pipelines \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "description": "description",
  "options": [
    {
      "id": "id",
      "label": "label"
    }
  ],
  "summaries": [
    {
      "optionId": "optionId",
      "isWeightedValue": true
    }
  ],
  "statuses": [
    {
      "id": "id",
      "name": "name",
      "displayOrder": 0
    }
  ]
}

plain

GET

https://api.heart.work

/core-api/pipelines/{id}/statistics

path Parameters

id

string · required

Responses

object[] · required

GET/core-api/pipelines/{id}/statistics

curl --request GET \
  --url https://api.heart.work/core-api/pipelines/:id/statistics

shell

Example Responses

{
  "statistics": [
    {
      "statusId": "statusId",
      "pipelineId": "pipelineId",
      "summaryStatistics": [
        {
          "id": "id",
          "name": "name",
          "total": 0
        }
      ]
    }
  ]
}

plain

Locations ProductAttributes