--- title: "Get Workflow Log" method: POST path: "/workflow-log/{id}/get-item" tags: ["Workflow Log"] --- # Get Workflow Log `POST /workflow-log/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/workflow-log/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Workflow Log by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` WorkflowLogSelectSchema: Select schema for WorkflowLog. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `workflowId` boolean - `logs` boolean - `workflowStatus` boolean - `startedAt` boolean - `completedAt` boolean - `resumeAt` boolean - `stepTrace` boolean - `isTestRun` boolean - `canRunAgain` boolean - `startedByUserId` boolean ## Response `200` Successful response - object - `data` WorkflowLog - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Workflow Log], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [Project Owner, Project Admin, Edit Workflow Log] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Workflow Log], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [Project Owner, Project Admin, Edit Workflow Log] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Workflow Log], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [Project Owner, Project Admin, Edit Workflow Log] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Workflow Log], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [Project Owner, Project Admin, Edit Workflow Log] - `version` number: Object version - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `workflowId` string, uuid, required: ID of Workflow this logs belong to. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `logs` string: Logs. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `workflowStatus` 'Scheduled' | 'Running' | 'Waiting' | 'Success' | 'Error' | 'Timeout' | 'Workflow Count Exceeded', required: Status of this workflow. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `startedAt` object: When did this workflow start. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `completedAt` object: When did this workflow complete. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `resumeAt` object: When this workflow run is scheduled to resume after a Sleep step (only set while the run is Waiting). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `stepTrace` object: Structured per-step record of this run: arguments, return values, the port taken and timing. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `isTestRun` boolean: True for a run a person started by hand from the Builder while the workflow was turned off. Its steps ran for real; the workflow's trigger stayed paused. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `canRunAgain` boolean: True when OneUptime kept what this run started with, so a person can run the workflow again with the same values. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] - `startedByUserId` string, uuid: ID of the person who started this run by hand from the Builder. Empty for a run its trigger or another workflow started. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Workflow Admin, Workflow Member, Workflow Viewer, Read Workflow Log], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)