Step Metadata

Get Step Metadata

GET /v1/steps/{stepId}/metadata

Get all metadata associated with a workflow step.

Path Parameters:

stepId (string, required): Step UUID

Response (200 OK):

[
    {
        "id": "6c06edfb-1cec-4f41-9c89-96204f1a2cb0",
        "key": "displayName",
        "value": "Patient Intake Form",
        "createdAt": "2024-01-20T10:00:00.000Z",
        "updatedAt": "2024-01-20T10:00:00.000Z"
    },
    {
        "id": "7d17fec0-2ded-5f52-ad90-a7315f3c3dc1",
        "key": "description",
        "value": "Collect basic patient information and medical history",
        "createdAt": "2024-01-20T10:00:00.000Z",
        "updatedAt": "2024-01-20T10:00:00.000Z"
    },
    {
        "id": "8e28gfd1-3eee-6g63-be01-b8426g4d4ed2",
        "key": "category",
        "value": "intake",
        "createdAt": "2024-01-20T10:00:00.000Z",
        "updatedAt": "2024-01-20T10:00:00.000Z"
    },
    {
        "id": "9f39hge2-4fff-7h74-cf12-c9537h5e5fe3",
        "key": "priority",
        "value": "high",
        "createdAt": "2024-01-20T10:00:00.000Z",
        "updatedAt": "2024-01-20T10:00:00.000Z"
    }
]

Update Multiple Step Metadata Fields

PATCH /v1/steps/{stepId}/metadata

Update multiple metadata fields for a workflow step in a single request.

Path Parameters:

stepId (string, required): Step UUID

Request Body:

Required fields:

fields

{
    "fields": {
        "displayName": {
            "value": "Enhanced Patient Intake Form"
        },
        "priority": {
            "value": "critical"
        },
        "estimatedDuration": {
            "value": "15 minutes"
        }
    }
}

Response (200 OK):

[
    {
        "id": "6c06edfb-1cec-4f41-9c89-96204f1a2cb0",
        "key": "displayName",
        "value": "Enhanced Patient Intake Form",
        "createdAt": "2024-01-20T10:00:00.000Z",
        "updatedAt": "2024-01-20T14:30:00.000Z"
    },
    {
        "id": "7d17fec0-2ded-5f52-ad90-a7315f3c3dc1",
        "key": "description",
        "value": "Collect basic patient information and medical history",
        "createdAt": "2024-01-20T10:00:00.000Z",
        "updatedAt": "2024-01-20T10:00:00.000Z"
    },
    {
        "id": "8e28gfd1-3eee-6g63-be01-b8426g4d4ed2",
        "key": "category",
        "value": "intake",
        "createdAt": "2024-01-20T10:00:00.000Z",
        "updatedAt": "2024-01-20T10:00:00.000Z"
    },
    {
        "id": "9f39hge2-4fff-7h74-cf12-c9537h5e5fe3",
        "key": "priority",
        "value": "critical",
        "createdAt": "2024-01-20T10:00:00.000Z",
        "updatedAt": "2024-01-20T14:30:00.000Z"
    },
    {
        "id": "bg4bijg3-5ggg-8i85-dg23-da648i6f6gf4",
        "key": "estimatedDuration",
        "value": "15 minutes",
        "createdAt": "2024-01-20T14:30:00.000Z",
        "updatedAt": "2024-01-20T14:30:00.000Z"
    }
]

Delete Step Metadata

DELETE /v1/steps/{stepId}/metadata/{fieldId}

Delete a specific metadata field from a workflow step.

Path Parameters:

stepId (string, required): Step UUID
fieldId (string, required): Metadata field UUID

Response (200 OK):

No response body.