Skip to main content

Returns a LaunchedWorkflow resource based on id.

GET 
/LaunchedWorkflow/:launchedWorkflowId

The LaunchedWorkflow resource with matching id is returned.

Attributes to include in the response can be specified with the attributes query parameter.

Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

The schema related to LaunchedWorkflow is:

  • urn:ietf:params:scim:schemas:sailpoint:1.0:LaunchedWorkflow

Request​

Path Parameters

    launchedWorkflowId stringrequired

    id of LaunchedWorkflow resource.

Query Parameters

    attributes string

    A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

    excludedAttributes string

    A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses​

Returns a single LaunchedWorkflow resource based on the id.
LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.

Schema
    partitioned boolean

    Flag to indicate this TaskResult is partitioned. (From the TaskResult used to launch the Workflow).

    completed date-time

    The completed DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).

    type string

    Type of the TaskResult. (From the TaskResult used to launch the Workflow).

    launched date-time

    The launched DateTime of the TaskResult. (From the TaskResult used to launch the Workflow).

    pendingSignOffs integer

    The number of pending signoffs of this TaskResult. (From the TaskResult used to launch the Workflow).

    workflowName string

    Name of the Workflow to launch.

    identityRequestId string

    Id representing the identity request.

    workflowCaseId string

    Id representing the workflow case (a running instance of a workflow).

    workflowProcessId string

    Id representing the workflow monitoring process log.

    retries integer

    The number of retries performed during the execution of provisioning activities.

    approvalSet string

    XML representation of approvals.

    workflowSummary string

    XML representation of the workflow summary.

    input object

    A list of input attributes of the Launched Workflow.

    key string

    The attribute key.

    value string

    The attribute value.

    type string

    The attribute type.

    output object

    A list of output attributes of the Launched Workflow.

    key string

    The attribute key.

    value string

    The attribute value.

    type string

    The attribute type.

    targetClass string

    Target Class of the TaskResult. (From the TaskResult used to launch the Workflow).

    name string

    Name of the TaskResult. (From the TaskResult used to launch the Workflow).

    messages undefined[]

    List of messages of the TaskResult. (From the TaskResult used to launch the Workflow).

    attributes undefined[]

    A list of attributes of the TaskResult. (From the TaskResult used to launch the Workflow).

  • Array [
    • key string

    The attribute key.

    value string

    The attribute value.

  • ]
    • id string

    Unique identifier of the TaskResult. (From the TaskResult used to launch the Workflow).

    completionStatus string

    Possible values: [Success, Warning, Error, Terminated, TempError]

    Completion Status of the TaskResult. (From the TaskResult used to launch the Workflow).

    taskDefinition string

    Name of the TaskDefinition of the TaskResult. (From the TaskResult used to launch the Workflow).

    terminated boolean

    Flag to indicate this TaskResult is terminated. (From the TaskResult used to launch the Workflow).

    launcher string

    Launcher of the TaskResult. (From the TaskResult used to launch the Workflow).

    meta object
    created date-time

    DateTime when the TaskResult was created. (From the TaskResult used to launch the Workflow).

    location string

    URL to the TaskResult. (From the TaskResult used to launch the Workflow).

    lastModified date-time

    DateTime of TaskResult last modification. (From the TaskResult used to launch the Workflow).

    version string

    TaskResult version. (From the TaskResult used to launch the Workflow).

    resourceType string

    Resource type of the metadata subject. (From the TaskResult used to launch the Workflow).

Loading...