Step execution

Monitor and control individual step execution within workflows including resuming executions and retrieving mapped data

Get Step Execution by ID

GET /v1/step-executions/{id}

Get details of a specific step execution.

Path Parameters:

  • id (string, required): Step execution UUID

Response (200 OK):

{
    "id": "a8c9d4e5-f6g7-h8i9-j0k1-l2m3n4o5p6q7",
    "stepId": "9a15edfb-1cec-4f41-9c89-96204f1a2cb1",
    "executionId": "7b24fdc8-3ded-5g52-8d90-85305e2b3db2",
    "resourceId": "form-123456",
    "status": "RUNNING",
    "step": {
        "id": "9a15edfb-1cec-4f41-9c89-96204f1a2cb1",
        "type": "forms",
        "description": "Patient Registration Form"
    }
}

Resume Step Execution

POST /v1/step-executions/{id}

Resume a paused step execution with additional data and metadata.

Path Parameters:

  • id (string, required): Step execution UUID

Request Body:

Required fields:

  • data

Optional fields:

  • metadata
{
    "data": {
        "patient_name": "John Smith",
        "patient_email": "[email protected]",
        "date_of_birth": "1985-03-15",
        "emergency_contact": "Jane Smith",
        "contact_phone": "+1-555-0123"
    },
    "metadata": {
        "submission_source": "web_form",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
        "ip_address": "192.168.1.100",
        "completion_time": 487
    }
}

Response (200 OK):

{
    "status": "COMPLETED",
    "data": {
        "patient_name": "John Smith",
        "patient_email": "[email protected]",
        "date_of_birth": "1985-03-15",
        "emergency_contact": "Jane Smith",
        "contact_phone": "+1-555-0123"
    },
    "metadata": {
        "submission_source": "web_form",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
        "ip_address": "192.168.1.100",
        "completion_time": 487,
        "processed_at": "2024-01-20T16:45:00.000Z"
    }
}

Get Mapped Step Data

GET /v1/step-executions/{id}/mapped-data

Get the mapped data values for a step execution, showing how data was transformed according to field mappings.

Path Parameters:

  • id (string, required): Step execution UUID

Response (200 OK):

[
    {
        "id": "mapping-123",
        "value": "John Smith",
        "primitiveType": "string",
        "complexType": "text",
        "fieldMappingMetadata": [
            "displayLabel",
            "required"
        ]
    },
    {
        "id": "mapping-456",
        "value": "[email protected]",
        "primitiveType": "string",
        "complexType": "email",
        "fieldMappingMetadata": [
            "validation",
            "displayLabel"
        ]
    },
    {
        "id": "mapping-789",
        "value": "1985-03-15T00:00:00.000Z",
        "primitiveType": "date",
        "complexType": "date",
        "fieldMappingMetadata": [
            "format",
            "displayLabel"
        ]
    },
    {
        "id": "mapping-101",
        "value": "+1-555-0123",
        "primitiveType": "string",
        "complexType": "phone",
        "fieldMappingMetadata": [
            "validation",
            "format"
        ]
    },
    {
        "id": "mapping-102",
        "value": "Emergency",
        "primitiveType": "string",
        "complexType": "text",
        "fieldMappingMetadata": [
            "staticValue"
        ]
    }
]