Skip to main content

List Latest Invocation Statuses

GET 

/trigger-invocations/status

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations.

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    triggerId: eq

    subscriptionId: eq

    Example: triggerId eq "idn:access-request-dynamic-approver"
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: triggerId, subscriptionName, created, completed

    Example: created

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

List of latest invocation statuses.

Schema

  • Array [

  • id stringrequired

    Invocation ID

    triggerId stringrequired

    Trigger ID

    subscriptionName stringrequired

    Subscription name

    subscriptionId stringrequired

    Subscription ID

    type InvocationStatusType (string)required

    Possible values: [TEST, REAL_TIME]

    Defines the Invocation type.

    TEST The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API.

    REAL_TIME The trigger subscription is live and was invocated by a real event in IdentityNow.

    created date-timerequired

    Invocation created timestamp. ISO-8601 in UTC.

    completed date-time

    Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC.

    startInvocationInput

    object

    required

    Data related to start of trigger invocation.

    triggerId string

    Trigger ID

    input object

    Trigger input payload. Its schema is defined in the trigger definition.

    contentJson object

    JSON map of invocation metadata

    completeInvocationInput

    object

    Data related to end of trigger invocation.

    localizedError

    object

    nullable

    Localized error message to indicate a failed invocation or error if any.

    locale stringrequired

    Message locale

    message stringrequired

    Message text

    output objectnullable

    Trigger output that completed the invocation. Its schema is defined in the trigger definition.

  • ]

Loading...