Workflows

post

https://app.financekey.com/OData/Workflows

Workflows define sequence of steps (actions) that need to be carried out as part of a process. As well as the steps to be taken, the responsible people and the actions can also be defined.

Body Params

workflowId

int32

The WorkflowId is an identity field that uniquely identifies each workflow within the Workflow table. It is of data type int and is automatically generated for every new entry. This field serves as the primary key for the Workflow table and is crucial for efficient data retrieval and management. The sequential and non-repeating nature of the WorkflowId ensures that each workflow is easily distinguishable from the others. It is used as a reference point for cross-referencing with other tables and plays a vital role in maintaining data integrity. The WorkflowId is an important aspect of the Workflow table and is essential for the smooth functioning of any workflow management system.

name

string

required

length between 1 and 32

The 'Name' field in the 'Workflow' table is a data type of nvarchar with a maximum length of 32 characters. This field is used to store the name or title of a specific workflow. It allows for the entry of both alphanumeric and special characters, and is useful for organizing and identifying different workflows within the table. The maximum length of 32 characters ensures that the name is concise and easily distinguishable. This field is essential for managing and tracking workflows within the database.

description

string | null

The field 'Description' in the table 'Workflow' is a data type of nvarchar with a maximum length of 128 characters. This field is where a brief description or summary of the workflow can be entered. It can be used to provide additional information about the workflow, including its purpose, steps, or any relevant details. This field can be helpful in organizing and understanding the different workflows in the database, making it easier to search and filter for specific workflows. As an nvarchar data type, the description field can store both alphanumeric and multi-lingual characters, allowing for flexibility in describing the workflow. With a maximum length of 128 characters, this field encourages concise yet comprehensive descriptions for efficient data management.

comment

string | null

Miscellaneous notes and information for the entry or record.

entityId

string | null

The EntityId field in the Workflow table is of the nvarchar data type and has a maximum length of 450 characters. This field is used to uniquely identify a specific entity within the workflow process. This entity can be a person, organization, or any other relevant entity involved in the workflow. The EntityId can be used to link different stages of the workflow to the corresponding entity, allowing for efficient tracking and management of the workflow. The 450 character limit ensures that even longer EntityIds can be accurately stored and retrieved in the Workflow table.

Response

200

Language

URL

Response

Click Try It! to start a request and see the response here!