Get provisioning workflow execution

This endpoint enables you to query a specific provisioning workflow execution summary.

Prerequisites

Querying the developer APIs involves sending an access_token as part of the Authorization header. For instructions on how to generate an access token, see Authorization.

Endpoint

GET https://public-api.productiv.com/pull/v1/provisioning-workflows/application-instances/:applicationInstanceId/executions/:executionId
Required Scope https://api.productiv.com/elm.results.read

Request headers

Parameter Value
Content-Type application/json
Authorization Bearer access_token

Path Params

Parameter Description
applicationInstanceId Unique identifier for the application instance. Application Instance IDs are returned in the List Provisioning Workflows endpoint response.
executionId Identifier for the execution for which the summary is being requested. Currently "latest" is the only value supported, to fetch the most recent execution for this instance.

Response

If the request is successful, a JSON object containing the following attributes is returned:

Parameter Datatype Description
Summary object See ProvisioningWorkflowExecutionSummary object defined below
ResponseTimeMs number Time taken by the server to process the request in milliseconds

Example Response

{
  "Summary": {
    "WorkflowId": "POL_2983ehidn239e8j923ndowdwsccs",
    "ExecutionId": "polId=POL_2983ehidn239e8j923ndowdwsccs|runId=2022-01-01_260910",
    "RuleSummaries": [
      {
        "Description": "Remove SSO access - Any License Tier; Inactive (90-day engagement)",
        "RuleExecutionStatus": "completed",
        "StartTime": 1670228833000,
        "EndTime": 1670836480000,
        "RuleId": "2983ehdiujsancowhr8923ndowldc",
        "Results": {
          "NumMatchedUsers": 1000,
          "OutcomeSplit": {
            "NumActionedUsers": 800,
            "NumWaitingUsers": 0,
            "NumErroredUsers": 100,
            "NumIgnoredUsers": 100
          }
        },
        "Owner": "System - Automatic License Reclaim"
      }
    ]
  },
  "ResponseTimeMs": 2000
}

Objects

This section lists the objects that can be returned in a successful query, and describes their properties.

ProvisioningWorkflowExecutionSummary

Parameter Datatype Description
ExecutionId string Unique identifier for the specific workflow execution
WorkflowId string Unique identifier for the workflow definition used for this execution
RuleSummaries array List of RuleExecutionSummary objects (defined below)

RuleExecutionSummary

Parameter Datatype Description
RuleId string Unique identifier for the rule
Description string Description for the rule
StartTime number Unix timestamp in milliseconds when the rule began executing
FinishTime number Unix timestamp in milliseconds when the rule finished executing
Owner string Identifies the user who triggered the execution
RuleExecutionStatus string Status of the rule execution. See RuleExecutionStatus enum below
Result object Describes how many users were acted on and how, see RuleExecutionResultStats object below

RuleExecutionResultStats

Parameter Datatype Description
NumMatchedUsers number Number of users who matched the specified criteria and were selected for actioning
OutcomeSplit object See OutcomeSplit object below

OutcomeSplit

Parameter Datatype Description
NumActionedUsers number Number of users who were actually actioned on. Note that for "Suggest" workflows, users still contribute to this count even though they are not actually actioned on
NumWaitingUsers number Number of users waiting to be actioned on
NumErroredUsers number Number of users who errored out
NumIgnoredUsers number Number of users who were ignored

Enums

RuleExecutionStatus

Value Description
in_progress The rule is currently executing
waiting Users have been notified and the rule is waiting to action on them
completed The rule has finished executing
cancelled The rule execution was cancelled
error Atleast one user for this rule errored out