Workflow Steps

The WorkflowStep table in the Workflow package is a crucial component for tracking the progress of tasks within a workflow. This table contains detailed information about the steps involved in completing a specific task, including the step name, order within the workflow, expected duration, and the responsible individual or team. Additionally, the WorkflowStep table also stores data on task completion, including timestamps, comments, and any associated documentation. This table serves as a centralized location for managing workflow steps and allows for efficient tracking of progress, identifying bottlenecks, and streamlining processes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
int32

The WorkflowStepId is a unique identity field within the WorkflowStep table, designed to store a specific step in a workflow process. It is of the data type int, meaning it can hold positive or negative integer values. This field is crucial in identifying and organizing the various stages within a workflow, providing a clear and orderly sequence for the overall process. With its designated purpose and data type, the WorkflowStepId ensures accurate and efficient tracking and management of workflow steps in the designated table.

int32

WorkflowId is a field in the WorkflowStep table that stores a sequential or numerical identifier assigned to a particular workflow. This data type is set to integer (int) which can accommodate whole numbers without decimal points, allowing for easy and efficient storage and retrieval of data. The WorkflowId serves as a unique reference for each workflow and is crucial in distinguishing between different steps within the same or different workflows. This field provides a structured method of organizing and tracking workflows, allowing for better management and monitoring of the overall process.

string
required
length between 1 and 32

The Name field in the WorkflowStep table is a data type of nvarchar with a maximum length of 32 characters. This field is used to store the name of each step in a workflow process. It is designed to contain text data, allowing for alphanumeric characters and special symbols. The maximum length of 32 ensures that the name is concise and does not exceed the designated space. The nvarchar data type also allows for multiple languages to be stored, making it suitable for a diverse range of workflow names. This field is an essential component of the WorkflowStep table, providing a clear and easily identifiable label for each step in a workflow.

string | null

The Description field in the WorkflowStep table is of data type nvarchar, meaning it can hold string data. It has a maximum length of 128 characters, allowing for concise descriptions to be entered. This field is designed to provide a brief explanation of the purpose or function of each workflow step within a larger process. This information can be used for organization, reference, and communication purposes within the table. It is ideal for providing a clear and succinct overview of the workflow step's role and relevance within the overall process.

int32

The ActionId field in the WorkflowStep table is a data type of int, representing a unique identifier for each individual step in a workflow. It serves as a reference for the specific action or task that needs to be performed at that step in the overall process. This field allows for easy tracking and organization of the workflow, ensuring that all steps are completed in the correct order. Additionally, it can be used for data analysis and reporting purposes, providing insight into efficiency and potential areas for improvement in the workflow.

int32

The Sequence field in the WorkflowStep table is of the data type int and represents the order in which certain steps must be completed in a designated workflow. This field ensures that the workflow progresses in a specific and logical manner, allowing for efficient and organized completion of tasks. By assigning a unique sequential number to each step, the Sequence field helps to create a clear and consistent flow within the workflow process. This information is crucial for tracking progress and identifying any potential issues or delays.

string | null

Miscellaneous notes and information for the entry or record.

Headers
string
enum
Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response
200

OK

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!