Get lifecycle event subscription detail list

get https://<<tenantUriId>>.api.chassi.com/<<applicationSpaceUriId>>/lifecycle/<<serviceUriVersion>>/lifecycles/{lifecycleId}/event-subscriptions-definition-details

Get lifecycle event subscription list with Event Definition details (convenience method)

Path Params

lifecycleId

string

required

Query Params

eventTypes[]

array of strings

Types of events to filter. Either Process Map Events (Step) , WIP Definition Events (Process)

eventTypes[]

eventSubTypes[]

array of strings

Types of eventSubTypes to filter.

eventSubTypes[]

appSpaceIds[]

string

stepIds[]

array of strings

stepIds[]

subscriptionIds[]

array of strings

subscriptionIds[]

pageOffset

integer

Number of pages away from the first one. The first one is zero (0).

pageSize

integer

Number of items per page

fromDatetime

date-time

Optional parameter to limit search results for records created after the specified date-time

toDatetime

date-time

Optional parameter to limit search results for records created before the specified date-time

sortBy

string

Defaults to asc

Optional parameter to sort by ascending or descending order

searchText

string

Optional parameter to limit search results containing specified text

Response

Response body

array of objects

object

lifecycleEventSubscriptionId

string

dateCreated

date-time

lastUpdated

date-time

subscriptionLabel

string

Name given to title the event subscription

publishAppSpaceId

string

required

Target App Space for the subscription

publishAppSpaceName

string

App Space

lifecycleEventDefintionList

array of objects

LifecycleEventDefinition list / array

lifecycleEventDefintionList

object

lifecycleEventDefinitionGroupId

string

required

lifecycleEventDefinitionId

string

required

dateCreated

date-time

lastUpdated

date-time

eventSubType

string

Depending on the Event Type, the eventSubType further defines the Event Definition

PreStep PostStep StepWIPLimit StepCycleTime ProcessWIPLimit ProcessCycleTime ProcessWIPLimitAlert ProcessCycleTimeAlert

hasSubscribers

boolean

Boolean flag

hasQueueSubscribers

boolean

Boolean flag

hasWebhookSubscribers

boolean

Boolean flag

wipLimit

integer

Depending on the Event Subtype, the number of units of Work-In-Progress

cycleTimeThreshold

integer

Depending on the Event Subtype, the number of time units (combine with a time unit)

cycleTimeUnit

string

Depending on the Event Subtype, the unit of time (combine with the cycle time threshold)

Years Months Weeks Days Hours Minutes

alertPercent

integer

Integer representation for alert percentage (depending on the Event Sub Type)

stepId

string

Copied from Lifecycle Event Definition Group.

stepName

string

Copied from Lifecycle Event Definition Group.

stepDescription

string

Copied from Lifecycle Event Definition Group.

toStepId

string

Copied from Lifecycle Event Definition Group. Relevant only for process events.

toStepName

string

Copied from Lifecycle Event Definition Group. Relevant only for process events.

toStepDescription

string

Copied from Lifecycle Event Definition Group. Relevant only for process events.

webhookEnabled

boolean

Webhook active flag

webhookURL

string

URL for webhook

webhookCredentialId

string

Identifier of webhook credential record

messagingEnabled

boolean

Messaging topic / queue active flag (disabling will not queue)

messagingChannelAddress

string

As provide by the server, the address for message channel

Language

Credentials

OAuth2


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/event-subscriptions-definition-details?sortBy=asc' \
3
     --header 'accept: application/json'

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

application/json

200Status 200