Web Service Overview

All Web Services which are provided by the FireStart Server can be found under https://<server>:<port>/api/swagger/ui/index.

Execution ID

The execution ID one of the System Fields among the Workflow Variables. But these System Fields are only shown when Show system fields are checked.

Task Element ID

To find the Task Element ID, right-click the Task Element and choose Edit event, and switch to the Menu External event. Now the Task Element ID is displayed in the textbox with the label Your event elementID is.

Example: Complete Task via PowerShell

In this example, you will learn how to complete a Task via a PowerShell script. Keep in mind, that the authentication of the Web Service will be done with NTLM. The authenticated user for FireStart is the same user who completes the Task. In the following example, the Windows user was authorized sufficiently, which means that "-UseDefaultCredential" could be used in this case.

Call

# Name and port of the FireStart server.
$server = "<server>:<port>"

# Element id of the task to be completed.
$taskElementId = "<taskElementId>" 

# Execution id of the workflow.
$executionId = "<executionId>"

$id = Get-TaskIdFromExecution -server $server -executionId $executionId -elementId $taskElementId 
Finish-ConfirmationTask -server $server -executionId $executionId -id $id 
Read Task ID

# Get the task id for a specific task in an execution.
function Get-TaskIdFromExecution()
{
    param
    (
        [string]$server,
        [string]$executionId,
        [string]$elementId
    )
    $url = 'https://' + $server + '/api/processinstance/' + $executionId
    $result = Invoke-RestMethod -Uri $url -UseDefaultCredential
    return $result.ExecutionInstances | Where-Object {$_.TrackingId -eq $elementId} | Select -Expand Id
}

Read Task ID

# Get the task id for a specific task in an execution.

function Get-TaskIdFromExecution()

{

    param

    (

        [string]$server,

        [string]$executionId,

        [string]$elementId

    )

    $url = 'https://' + $server + '/api/processinstance/' + $executionId

    $result = Invoke-RestMethod -Uri $url -UseDefaultCredential

  

    return $result.ExecutionInstances | Where-Object {$_.TrackingId -eq $elementId} | Select -Expand Id

}

Complete Task

# Finish a read only task. No values will be written to business entities.
function Finish-ConfirmationTask()
{
    param
    (
        [string]$server,
        [string]$executionId,
        [string]$id
    )

    # Get some values needed to complete the task
    $confirmation = Invoke-RestMethod -Uri ('https://' + $server + '/api/task/' + $id)
                                      -UseDefaultCredentials
    $buildNumber = Invoke-RestMethod -Uri ('https://' + $server + '/api/clientupdate/build')
                                      -UseDefaultCredentials

    FinishTask -server $server -executionId $executionId -id $id -taskId $confirmation.TaskId
        -returnData "<FormData xmlns=`"http://www.prologics.at/form`" Build=`"$buildNumber`"></FormData>"
}

function FinishTask()
{
    param
    (
        [string]$server,
        [string]$executionId,
        [string]$id,
        [string]$taskId,
        [string]$returnData
    )
    $url = 'https://' + $server + '/api/task/' + $taskId

    $body = 
    @{
        Id = $id
        TaskId = $taskId
        ExecutionId = $executionId
        State = "Complete"
        Priority = "High"
        Progress = 100
        ReturnData = $returnData
        WorkDuration = 0
        EndDate = [DateTime]::UtcNow.ToString('o')
    }

    Invoke-RestMethod -Uri $url -Method Put -ContentType "application/json" -Body ($body | ConvertToJson)
        -UseDefaultCredential
}