Introduction

Getting Started with the API

Contacts

Contacts
Contact Notes

Customer

Customer
Customer Note
Customer Contact
Customer Contact Notes
Customer Contact Roles
Customer Journeys
Customer Activity

Lifecycle

Lifecycle Definitions
Lifecycle Step Dictionary
Lifecycle Versions
Lifecycle Operations
Journeys
Entity Type
- Get Entity Type Identifier listget
External Entity Type
Lifecycle Process Event Definitions
Lifecycle Process Event Subscriptions
Lifecycle Managed Event Definition Groups
Lifecycle Managed Event Definitions
Managed Event Subscriptions
- Get a list of managed event subscription detailsget
Lifecycle Metrics
Event Definitions
- List all Event Definitionsget
Event Subscriptions
Lifecycle Utilization
Lifecycle Exceptions

Introduction

Getting Started with the API

Contacts

Contacts
Contact Notes

Customer

Customer
Customer Note
Customer Contact
Customer Contact Notes
Customer Contact Roles
Customer Journeys
Customer Activity

Lifecycle

Lifecycle Definitions
Lifecycle Step Dictionary
Lifecycle Versions
Lifecycle Operations
Journeys
Entity Type
- Get Entity Type Identifier listget
External Entity Type
Lifecycle Process Event Definitions
Lifecycle Process Event Subscriptions
Lifecycle Managed Event Definition Groups
Lifecycle Managed Event Definitions
Managed Event Subscriptions
- Get a list of managed event subscription detailsget
Lifecycle Metrics
Event Definitions
- List all Event Definitionsget
Event Subscriptions
Lifecycle Utilization
Lifecycle Exceptions

Get versions of a lifecycle

get https://<<tenantUriId>>.api.chassi.com/<<applicationSpaceUriId>>/lifecycle/<<serviceUriVersion>>/lifecycles/{lifecycleId}/versions

Gets all versions associated with a specific lifecycle in the Definitional Application Space.

Definitional Application Space

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

lifecycleId

string

required

Response

Response body

array of objects

object

versionNo

integer

required

lifecycleVersionId

string

versionName

string

startingStepId

string

required

Unique (per Lifecycle) name for a step.

steps

array of objects

required

Unordered list of steps as a subset dictionary referencing lifecycle dictionary.

steps*

object

stepId

string

Unique (per Lifecycle) name for a step.

stepName

string

Updates Step Name in Dictionary (last published step name in wins)

stepType

string

Designates the nature of a step in a process and realized in a particular lifecycle version.

Not_Started In_Progress Done

nextSteps

array of strings

The next steps (as stepIds not stepNames) define the prescribed immediate pathways that an entity may navigate to other steps within a version of a lifecycle.

Does NOT update to the lifecycle step definition.

nextSteps

displayXPos

integer

required

Does NOT update to the lifecycle step definition.

displayYPos

integer

required

Does NOT update to the lifecycle step definition.

dateCreated

date-time

lastUpdated

date-time

metadata

array of objects

metadata

object

metadataTag

string

Way to group similar data

key

string

required

Attribute name of metadata

displayLabel

string

Used to display the field label for the value

value

string

Data of metadata

valueFormat

string

Controlled enumerated types that realize value

String Text Number Date Time Datetime Boolean

published

boolean

Flag to indicate publication

publicationDate

date-time

First publication date which made the version read-only (can only publish to additional app spaces and change names).

publishedAppSpacesList

array of objects

Array of LifecycleVersionPublications containing the App Space and the date of publication

publishedAppSpacesList

object

appSpaceId

string

App Space identifier

appSpaceName

string

publicationDate

date-time

inflightEntityLifecycleCount

integer

Number of entity lifecycles not in a 'Done' step

totalEntityLifecycleCount

integer

Total number of entity lifecycles (inflight or done)

hasDependencies

boolean

1 or more entity lifecycles in at least one app space are attached or have history

Updated almost 6 years ago

Lifecycle Versions

Create a lifecycle version

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https:///%3C%3CtenantUriId%3E%3E.api.chassi.com/%3C%3CapplicationSpaceUriId%3E%3E/lifecycle/%3C%3CserviceUriVersion%3E%3E/lifecycles/lifecycleId/versions \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated almost 6 years ago

Lifecycle Versions

Create a lifecycle version

Introduction
Getting Started with the API

Contacts
Contacts
Delete a contactdelete
Update contactput
Get a contactget
Create a new contactpost
Get all contactsget
Contact Notes
Delete a note for the specified contactdelete
Update a note for the specified contactput
Get a note for the specified contactget
Create a new contact notepost
Get all contact notesget

Customer
Customer
Delete a customerdelete
Update a customerput
Get a customerget
Create a new customerpost
Returns a list of all customersget
Customer Note
Delete a customer notedelete
Update a customer noteput
Get a customer noteget
Create a customer notepost
Get all notes for a customerget
Customer Contact
Returns a list of customers associated with the specified contact idget
Attach a list of existing contacts to the specified customerpost
Delete a customer contactdelete
Update a customer contactput
Get a customer contactget
Create or attach a customer contactpost
Get all contacts for customerget
Customer Contact Notes
Delete a customer contact notedelete
Update a customer contact noteput
Get a customer contact noteget
Create a customer contact notepost
Get all notes for a customer contactget
Customer Contact Roles
Deletes a customer contact roledelete
Updates a customer contact roleput
Returns a customer contact roleget
Create a customer contact rolepost
Returns a list of customer contact rolesget
Customer Journeys
[deprecated] Delete a customer journey (unlink)delete
[deprecated] Get a customer journeyget
[deprecated] Customer's most recent journeyget
[deprecated] Create a Customer Journeypost
[deprecated] Get all journeys for customerget
Customer Activity
Delete a customer activitydelete
Update a customer activityput
Get a customer activityget
Log a customer activitypost
Get all customer activityget

Lifecycle
Lifecycle Definitions
Deletes a lifecycledelete
Update a lifecycleput
Get a lifecycleget
Create a new lifecyclepost
Returns a list of all lifecyclesget
Lifecycle Step Dictionary
Delete a specific step definitiondelete
Update a step definitionput
Get a specific step definitionget
Update all steps in dictionaryput
Create a step definitionpost
Get step dictionary for lifecycleget
Lifecycle Versions
Migrate journeys of a published version to anotherpost
Publish version to one or more Operational Application Spacespost
Duplicate a versionpost
Update just a versions nameput
Get latest version of lifecycleget
Deletes a version of a lifecycledelete
Update a version of a lifecycleput
Get a version of a lifecycleget
Create a lifecycle versionpost
Get versions of a lifecycleget
Lifecycle Operations
[deprecated] Get a list of metadata found in entityLifecycles for the appSpaceget
[deprecated] Migrate an entity lifecycle to a different published lifecycle versionpost
[deprecated] Change entity lifecycle's current stepput
[deprecated] Get possible next steps for entityget
[deprecated] Delete a history record for the entity lifecycledelete
[deprecated] Update a history record for the entity lifecycleput
[deprecated] Get a history record for the entity lifecycleget
[deprecated] Create or log a history record for the entity lifecyclepost
[deprecated] History of the entity lifecycleget
[deprecated] Stop tracking an entity and delete historydelete
[deprecated] Update an entity's situation and metadataput
[deprecated] Get an entity's current situation and metadataget
[deprecated] Get a list of entityLifecycle journeysget
[deprecated] Start tracking an entitypost
[deprecated] Get all the entities being trackedget
Journeys
Get a list of metdata based off of journeysget
Get a summary of all journeysget
Delete a journey historydelete
Update a journey historyput
Get a journey historyget
Log history of a journeypost
Get a list of journey historiesget
Migrate journey to another version of lifecyclepost
Change Stepput
Next possible steps to which a journey can moveget
Delete a journeydelete
Update a journeyput
Get a journeyget
Start tracking a journeypost
Get all journeysget
Entity Type
Get Entity Type Identifier listget
External Entity Type
Deletes an externalEntityTypeIdentifierdelete
Update an externalEntityTypeIdentifierput
Get an externalEntityTypeIdentifierget
Create an external-entity-type-identifierpost
Get externalEntityTypeIdentifier listget
Lifecycle Process Event Definitions
Delete a lifecycle event definitiondelete
Update a lifecycle event definitionput
Get a lifecycle event definitionget
Create a lifecycle event definitionpost
Get lifecycle event definitions listget
Publish a lifecycle event definition grouppost
Delete a lifecycle event definitiondelete
Update a lifecycle event definitionput
Get a lifecycle event definitionget
Create a lifecycle event definitionpost
Get lifecycle event definitions listget
Lifecycle Process Event Subscriptions
Delete event subscription (unsubscribe)delete
Update lifecycle event subscriptionput
Get a lifecycle event subscriptionget
Get lifecycle event subscription detail listget
Create lifecycle event subscriptionpost
Get all lifecycle event subscriptionsget
Lifecycle Managed Event Definition Groups
Delete a managed event definition groupdelete
Get a managed event definition groupget
Get lifecycle managed event definition groups listget
Lifecycle Managed Event Definitions
Delete managed event subscription (unsubscribe)delete
Update managed event subscriptionput
Get a managed event subscriptionget
Create a managed event subscriptionpost
Get all managedevent subscriptionsget
Delete a managed event definitiondelete
Update a managed event definitionput
Get a managed event definitionget
Create a managed event definitionpost
Get managed event definitions (filterable)get
Managed Event Subscriptions
Get a list of managed event subscription detailsget
Lifecycle Metrics
Get Lifecycle Cumulative Flowget
Get Lifecycle Trend Metricsget
Get lifecycle metric top pathwaysget
Get lifecyle metric cycle timesget
Event Definitions
List all Event Definitionsget
Event Subscriptions
Unsubscribe to an eventdelete
Update event subscriptionput
Get an event subscriptionget
Subscribe to eventpost
Get all subscriptions to eventsget
Lifecycle Utilization
Utilization this year (YTD)get
Utilization previous 3 monthsget
Utilization previous monthget
Utilization this monthget
Utilization last 7 daysget
Get a Lifecycle Resource Utilization summary using a search filterget
Log a utilization event (or list of events) and return a Resource Utilization Aggregation.post
Lifecycle Exceptions
Get an exceptionget
Search / filter exceptionsget
Available log streamsget
Log an Exceptionpost

Tag
Tag Namespaces
Get namespace full pathget
Get namespace with all tag detailget
Delete a tag namespacedelete
Update a tag namespaceput
Get a tag namespaceget
Create a tag namespacepost
Get all tag namespacesget
Tag Namespace Changes
Delete a tag namespace changedelete
Update a tag namespace changeput
Get a tag namespace changeget
Post a tag namespace changepost
Get all tag namespace changesget
Tags
Loads global tag data into the given appSpacepost
Delete a Tagdelete
Update a tagput
Get a tagget
Create a Tagpost
Returns a list of all tags (with optional search)get
Tag Field
Get all tags (with namespace) for tag fieldget
Delete a tag fielddelete
Update a tag fieldput
Get a field where tags are usedget
Create a tag field where tags is usedpost
Get all fields where tags are usedget
Tag Field Namespaces
Delete a tag field namespacedelete
Update a tag field namespaceput
Get a tag field namespaceget
Create a tag field namespace where tags are usedpost
Get all namespaces where for a tag fieldget

Introduction
Getting Started with the API

Contacts
Contacts
Delete a contactdelete
Update contactput
Get a contactget
Create a new contactpost
Get all contactsget
Contact Notes
Delete a note for the specified contactdelete
Update a note for the specified contactput
Get a note for the specified contactget
Create a new contact notepost
Get all contact notesget

Customer
Customer
Delete a customerdelete
Update a customerput
Get a customerget
Create a new customerpost
Returns a list of all customersget
Customer Note
Delete a customer notedelete
Update a customer noteput
Get a customer noteget
Create a customer notepost
Get all notes for a customerget
Customer Contact
Returns a list of customers associated with the specified contact idget
Attach a list of existing contacts to the specified customerpost
Delete a customer contactdelete
Update a customer contactput
Get a customer contactget
Create or attach a customer contactpost
Get all contacts for customerget
Customer Contact Notes
Delete a customer contact notedelete
Update a customer contact noteput
Get a customer contact noteget
Create a customer contact notepost
Get all notes for a customer contactget
Customer Contact Roles
Deletes a customer contact roledelete
Updates a customer contact roleput
Returns a customer contact roleget
Create a customer contact rolepost
Returns a list of customer contact rolesget
Customer Journeys
[deprecated] Delete a customer journey (unlink)delete
[deprecated] Get a customer journeyget
[deprecated] Customer's most recent journeyget
[deprecated] Create a Customer Journeypost
[deprecated] Get all journeys for customerget
Customer Activity
Delete a customer activitydelete
Update a customer activityput
Get a customer activityget
Log a customer activitypost
Get all customer activityget

Lifecycle
Lifecycle Definitions
Deletes a lifecycledelete
Update a lifecycleput
Get a lifecycleget
Create a new lifecyclepost
Returns a list of all lifecyclesget
Lifecycle Step Dictionary
Delete a specific step definitiondelete
Update a step definitionput
Get a specific step definitionget
Update all steps in dictionaryput
Create a step definitionpost
Get step dictionary for lifecycleget
Lifecycle Versions
Migrate journeys of a published version to anotherpost
Publish version to one or more Operational Application Spacespost
Duplicate a versionpost
Update just a versions nameput
Get latest version of lifecycleget
Deletes a version of a lifecycledelete
Update a version of a lifecycleput
Get a version of a lifecycleget
Create a lifecycle versionpost
Get versions of a lifecycleget
Lifecycle Operations
[deprecated] Get a list of metadata found in entityLifecycles for the appSpaceget
[deprecated] Migrate an entity lifecycle to a different published lifecycle versionpost
[deprecated] Change entity lifecycle's current stepput
[deprecated] Get possible next steps for entityget
[deprecated] Delete a history record for the entity lifecycledelete
[deprecated] Update a history record for the entity lifecycleput
[deprecated] Get a history record for the entity lifecycleget
[deprecated] Create or log a history record for the entity lifecyclepost
[deprecated] History of the entity lifecycleget
[deprecated] Stop tracking an entity and delete historydelete
[deprecated] Update an entity's situation and metadataput
[deprecated] Get an entity's current situation and metadataget
[deprecated] Get a list of entityLifecycle journeysget
[deprecated] Start tracking an entitypost
[deprecated] Get all the entities being trackedget
Journeys
Get a list of metdata based off of journeysget
Get a summary of all journeysget
Delete a journey historydelete
Update a journey historyput
Get a journey historyget
Log history of a journeypost
Get a list of journey historiesget
Migrate journey to another version of lifecyclepost
Change Stepput
Next possible steps to which a journey can moveget
Delete a journeydelete
Update a journeyput
Get a journeyget
Start tracking a journeypost
Get all journeysget
Entity Type
Get Entity Type Identifier listget
External Entity Type
Deletes an externalEntityTypeIdentifierdelete
Update an externalEntityTypeIdentifierput
Get an externalEntityTypeIdentifierget
Create an external-entity-type-identifierpost
Get externalEntityTypeIdentifier listget
Lifecycle Process Event Definitions
Delete a lifecycle event definitiondelete
Update a lifecycle event definitionput
Get a lifecycle event definitionget
Create a lifecycle event definitionpost
Get lifecycle event definitions listget
Publish a lifecycle event definition grouppost
Delete a lifecycle event definitiondelete
Update a lifecycle event definitionput
Get a lifecycle event definitionget
Create a lifecycle event definitionpost
Get lifecycle event definitions listget
Lifecycle Process Event Subscriptions
Delete event subscription (unsubscribe)delete
Update lifecycle event subscriptionput
Get a lifecycle event subscriptionget
Get lifecycle event subscription detail listget
Create lifecycle event subscriptionpost
Get all lifecycle event subscriptionsget
Lifecycle Managed Event Definition Groups
Delete a managed event definition groupdelete
Get a managed event definition groupget
Get lifecycle managed event definition groups listget
Lifecycle Managed Event Definitions
Delete managed event subscription (unsubscribe)delete
Update managed event subscriptionput
Get a managed event subscriptionget
Create a managed event subscriptionpost
Get all managedevent subscriptionsget
Delete a managed event definitiondelete
Update a managed event definitionput
Get a managed event definitionget
Create a managed event definitionpost
Get managed event definitions (filterable)get
Managed Event Subscriptions
Get a list of managed event subscription detailsget
Lifecycle Metrics
Get Lifecycle Cumulative Flowget
Get Lifecycle Trend Metricsget
Get lifecycle metric top pathwaysget
Get lifecyle metric cycle timesget
Event Definitions
List all Event Definitionsget
Event Subscriptions
Unsubscribe to an eventdelete
Update event subscriptionput
Get an event subscriptionget
Subscribe to eventpost
Get all subscriptions to eventsget
Lifecycle Utilization
Utilization this year (YTD)get
Utilization previous 3 monthsget
Utilization previous monthget
Utilization this monthget
Utilization last 7 daysget
Get a Lifecycle Resource Utilization summary using a search filterget
Log a utilization event (or list of events) and return a Resource Utilization Aggregation.post
Lifecycle Exceptions
Get an exceptionget
Search / filter exceptionsget
Available log streamsget
Log an Exceptionpost

Tag
Tag Namespaces
Get namespace full pathget
Get namespace with all tag detailget
Delete a tag namespacedelete
Update a tag namespaceput
Get a tag namespaceget
Create a tag namespacepost
Get all tag namespacesget
Tag Namespace Changes
Delete a tag namespace changedelete
Update a tag namespace changeput
Get a tag namespace changeget
Post a tag namespace changepost
Get all tag namespace changesget
Tags
Loads global tag data into the given appSpacepost
Delete a Tagdelete
Update a tagput
Get a tagget
Create a Tagpost
Returns a list of all tags (with optional search)get
Tag Field
Get all tags (with namespace) for tag fieldget
Delete a tag fielddelete
Update a tag fieldput
Get a field where tags are usedget
Create a tag field where tags is usedpost
Get all fields where tags are usedget
Tag Field Namespaces
Delete a tag field namespacedelete
Update a tag field namespaceput
Get a tag field namespaceget
Create a tag field namespace where tags are usedpost
Get all namespaces where for a tag fieldget

200Status 200