Skip to main content

Endpoint used to launch a Workflow.

POST 
/LaunchedWorkflows

Endpoint to launch or execute a Workflow. A payload for the request is required and this can include inputs specific to the Workflow being launched.

Request​

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.

Body

required

    schemas undefined[]

    Schemas related to Launched Workflows.

    workflowName string

    Name of the Workflow to launch.

    input

    undefined[]

    A list of input attributes of the Launched Workflow.

  • Array [

    • key string

    The attribute key.

    value string

    The attribute value.

    type string

    The attribute type.

  • ]

Responses​

Executes a workflow and returns the resulting LaunchedWorkflow. LaunchedWorkflow responses include attributes from the TaskResult related to the Workflow execution.

Schema

    targetName string

    Target name of the TaskResult.

    verified date-time

    The verified date of the TaskResult.

    partitioned boolean

    Flag to indicate if the TaskResult is partitioned.

    completed date-time

    The completed date of the TaskResult.

    type string

    Type of the TaskResult.

    launched string

    The launched date of the TaskResult.

    pendingSignOffs integer

    Number of pending signoffs of this TaskResult.

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

    object

    LaunchedWorkflow properties.

    output

    undefined[]

  • Array [

    • type string

    The output attribute type.

    value string

    The output attribute value.

    key string

    The output attribute key.

  • ]

    • retries integer

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

    input

    undefined[]

  • Array [

    • key string

    The input attribute key.

    value string

    The input attribute value.

    type string

    The input attribute type.

  • ]

    • workflowSummary string

    XML representation of the workflow summary.

    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).

    targetClass string

    Target class of the Task Result.

    meta

    undefined[]

    Metadata for the LaunchedWorkflow TaskResult.

  • Array [

    • created date-time

    Datetime when the TaskResult for the LaunchedWorkflow was created.

    location string

    URL to the TaskResult.

    lastModified date-time

    Datetime of LaunchedWorkflow TaskResult last modification

    version string

    Version of the LaunchedWorkflow TaskResult.

    resourceType string

    Resource type of the metadata subject

  • ]

    • schemas undefined[]

    Schemas related to LaunchedWorkflow.

    name string

    Name of the TaskResult for the Workflow launch.

    messages undefined[]

    List of messages of the TaskResult.

    Attributes

    object

    A list of attributes of the TaskResult.

    key string

    The attribute key.

    value string

    The attribute value.

    id string

    Id of the task result for the Workflow launch.

    completionStatus string

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

    Completion Status of the TaskResult.

    taskDefinition string

    Name of the TaskDefinition of the TaskResult.

    terminated boolean

    Flag to indicate this TaskResult is terminated.

    launcher string

    Launcher of the TaskResult.

Loading...