Start tracking a journey

post

https://<<tenantUriId>>.api.chassi.com/<<applicationSpaceUriId>>/lifecycle/<<serviceUriVersion>>/journeys

This, quite simply, will start to track a journey in the designated Operational Application Space. Be careful to make sure the journey is tracking the appropriate entity, otherwise you will end up with journeys which have no site access. This may be intended in some cases, but usually a customer, either internal or external or both should be connected to the journey.

Operational Application Space

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

journeyId

string

Unique identifier (per Lifecycle) for an journey being tracked.

dateCreated

date-time

lastUpdated

date-time

lifecycleId

string

required

lifecycleName

string

Name of Lifecycle

versionNo

integer

required

Version of Lifecycle (LifecycleVersion)

journeyCreateDate

date-time

cycleStartDatetime

date-time

previousStepId

string

previousStepName

string

previousStepType

string

enum

Allowed:

currentStepId

string

Current step that the entity is on. If not provided, EntityLifecycle will be created on start step of lifecycle version.

currentStepName

string

Logical / display name (copied from LifecycleStep)

currentStepType

string

enum

Allowed:

currentCycleNo

integer

Current cycle that the entity is on. The number is incremented each time the entity transitions from a ‘Done’ stepType to a non-‘Done’ stepType. This is interpreted as a restart or at least a new cycle. See also cycleStartCycleDatetime.

stepStartDatetime

date-time

Start datetime of the step. Calculate difference from now to determine the age/duration.

currentPath

string

JSON string containing current entityLifecycle path.

currentStepElapsedSeconds

integer

Current time, in seconds, of entity in current step.

currentCycleElapsedSeconds

integer

Current time, in seconds, of entity in current cycle.

elapsedJourneyTime

integer

Current time, in seconds, of entity life.

entityArray

array of objects

entityArray

externalEntityArray

array of objects

externalEntityArray

journeyTags

array of objects

Array of tags

journeyTags

metadata

array of objects

Most recent set of metadata for a journey

metadata

Response

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200Status 200