sam|nord Developers
samnord.com
Work Steps

GET /work-steps/{id}

View a specific work step. Requires work-steps.read permission.

Path parameters

Name Type Required Description
id string yes The unique identifier of the record

Query parameters

Name Type Required Description
fields[] string[] no Select which fields to include in the response. When omitted, all fields are returned. When provided, only the specified fields are included. (e.g., ?fields[]=id&fields[]=name) One of: active, canonicalId, createdAt, description, estimatedDurationMinutes, id, isCurrent, name, order, requiresApproval, riskLevel, status, updatedAt, version.
with[] string[] no Include related resources in the response. Pass multiple values as separate query parameters (e.g., ?with[]=createdBy&with[]=updatedBy). One of: createdBy, updatedBy, safetyRequirements, workTask.

Responses

Status Description
200 A json object describing the work step
403 The requesting user lacks appropriate permissions
404 The work step was not found

Response 200 body

  • data object · required
  • meta object · required
{
    "data": {
        "id": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
        "active": true,
        "canonicalId": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
        "createdAt": "2024-06-30T19:00:00Z",
        "createdBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "description": "Perform comprehensive safety inspection",
        "estimatedDurationMinutes": 90,
        "isCurrent": true,
        "name": "Safety Check",
        "order": 1,
        "requiresApproval": false,
        "riskLevel": "medium",
        "safetyRequirements": [
            {
                "id": "string",
                "name": "string",
                "onSite": false
            }
        ],
        "status": "draft",
        "updatedAt": "2024-06-30T19:00:00Z",
        "updatedBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "version": 1,
        "workTask": {
            "id": "string",
            "name": "string",
            "active": false
        }
    },
    "meta": {
        "requestId": "019a3a60-6328-7075-8a41-76ff545ca5d3",
        "userId": "019a3a60-929c-7820-9b35-bf79a8bf83a6",
        "organizationId": "019a3a60-8175-7a68-88da-ecb4a7040b86"
    }
}