tvpl.api

GetWorkflowStepRequest

The following routes are available for this service:
GET	/WorkflowStep/by-workflow

**GetWorkflowStepRequest** Parameters:
Name	Parameter	Data Type	Required	Description
WorkflowId	query	int	No

**GetWorkflowStepResponse** Parameters:
Name	Parameter	Data Type	Required
Code	form	int	No
Message	form	string	Yes
Data	form	List<WorkflowStepDetail>	No

**WorkflowStepDetail** Parameters:
Name	Parameter	Data Type	Required
Departments	form	List<Category>	No
CoDepartments	form	List<Category>	No
BasisDocuments	form	List<SimpleDocumentRelation>	No
ReferenceDocuments	form	List<SimpleDocumentRelation>	No
MainAssignees	form	List<WorkFlowProfile>	No
SupportingAssignees	form	List<WorkFlowProfile>	No
StatusKey	form	string	No
StatusText	form	string	No
CanRead	form	bool?	No
CanWrite	form	bool?	No
CanUpload	form	bool?	No
ReasonReturn	form	string	No
ReturnDate	form	DateTime?	No

**WorkflowStep** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
WorkflowId	form	int	No
StepOrder	form	int?	No
StatusId	form	int?	No
StepName	form	string	Yes
IsRequired	form	bool	Yes
SLALegalValue	form	int?	No
SLALegalIsByDay	form	bool?	No
SLAInternalValue	form	int?	No
SLAInternalIsByDay	form	bool?	No
RequireAttachment	form	bool	No
IsUsingForm	form	bool?	No
Description	form	string	Yes
CreatedBy	form	int	No
DepartmentIds	form	List<int>	No
MainAssigneeIds	form	List<int>	No
CoDepartmentIds	form	List<int>	No
SupportingAssigneeIds	form	List<int>	No
StepBasisDocumentIds	form	List<int>	No
AttachedDocuments	form	List<StepAttached>	No

**StepAttached** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
DocumentCode	form	string	No
Title	form	string	No
IsSequentialSigning	form	bool?	No
PendingSignFile	form	UploadedFiles	No
OriginalFile	form	UploadedFiles	No
SignerConfigs	form	List<SignerConfigDetail>	No

**UploadedFiles** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
UploadedFile	form	string	Yes
SubDocumentId	form	int?	No
StepId	form	int?	No
Code	form	int	No

**BasicUploadedFile** Parameters:
Name	Parameter	Data Type	Required
FileName	form	string	Yes
Filekey	form	string	Yes
FileUrl	form	string	Yes
Checksum	form	string	Yes
ETag	form	string	Yes
FileSize	form	long	No

**SignerConfigDetail** Parameters:
Name	Parameter	Data Type	Required	Description
Profile	form	WorkFlowProfile	No
Role	form	Roles	No

**SignerConfig** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
DocumentId	form	int	No
StepId	form	int?	No

**BasicSignerConfig** Parameters:
Name	Parameter	Data Type	Required
SubDocumentId	form	int?	No
DepartmentId	form	int?	No
SignerType	form	byte	No
SignerRefId	form	int	No
SignerRefText	form	string	No
ActionType	form	byte	No
OrderIndex	form	int	No

**WorkFlowProfile** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
FullName	form	string	No
Email	form	string	No
DepartmentId	form	int?	No
Avatar	form	string	No
Telephone	form	string	No
Birthday	form	DateTime?	No
ConfirmStatus	form	int?	No
ConfirmStatusText	form	string	No
SignAt	form	DateTime?	No
SignedFileId	form	long?	No
OriginalFileId	form	int?	No
SignedFileName	form	string	No
IsSigned	form	bool	No
SignStatusText	form	string	No

**Roles** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
CreatedAt	form	DateTime?	No
DeletedAt	form	DateTime?	No
UpdatedAt	form	DateTime?	No
UpdatedBy	form	int?	No
DeletedBy	form	int?	No
CreatedBy	form	int?	No
Permission	form	List<string>	No

**Category** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Level	form	int	No
Key	form	string	No
SortOrder	form	int	No
LastUpdate	form	DateTime?	No
Children	form	List<Category>	Yes

**CreateCategoryModel** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
Description	form	string	Yes
Type	form	CategoryTypes	No
IsParty	form	bool	No
ChildList	form	List<int>	No

**CategoryTypes** Enum:
Department
PartyGroup
DocGroup
DocType
IssuingAgency
Status
Subjects
Workflow
WorkStatus
StepStatus
SignStatus

**SimpleDocumentRelation** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Title	form	string	Yes
DocumentCode	form	string	Yes
PublicationDate	form	DateTime?	No
IsSequentialSigning	form	bool?	No
StatusText	form	string	No
DocumentTypeId	form	int?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /WorkflowStep/by-workflow HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			departments: 
			[
				{
					id: 0,
					level: 0,
					key: String,
					sortOrder: 0,
					lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
					children: 
					[
						{
							id: 0,
							level: 0,
							key: String,
							sortOrder: 0,
							lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
							children: 
							[
								{
									id: 0,
									level: 0,
									key: String,
									sortOrder: 0,
									lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
									name: String,
									description: String,
									type: Department,
									isParty: False,
									childList: 
									[
										0
									]
								}
							],
							name: String,
							description: String,
							type: Department,
							isParty: False,
							childList: 
							[
								0
							]
						}
					],
					name: String,
					description: String,
					type: Department,
					isParty: False,
					childList: 
					[
						0
					]
				}
			],
			coDepartments: 
			[
				{
					id: 0,
					level: 0,
					key: String,
					sortOrder: 0,
					lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
					children: 
					[
						{
							id: 0,
							level: 0,
							key: String,
							sortOrder: 0,
							lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
							children: 
							[
								{
									id: 0,
									level: 0,
									key: String,
									sortOrder: 0,
									lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
									name: String,
									description: String,
									type: Department,
									isParty: False,
									childList: 
									[
										0
									]
								}
							],
							name: String,
							description: String,
							type: Department,
							isParty: False,
							childList: 
							[
								0
							]
						}
					],
					name: String,
					description: String,
					type: Department,
					isParty: False,
					childList: 
					[
						0
					]
				}
			],
			basisDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06",
					isSequentialSigning: False,
					statusText: String,
					documentTypeId: 0
				}
			],
			referenceDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06",
					isSequentialSigning: False,
					statusText: String,
					documentTypeId: 0
				}
			],
			mainAssignees: 
			[
				{
					id: 0,
					name: String,
					fullName: String,
					email: String,
					departmentId: 0,
					avatar: String,
					telephone: String,
					birthday: "0001-01-01T00:00:00.0000000+07:06",
					confirmStatus: 0,
					confirmStatusText: String,
					signAt: "0001-01-01T00:00:00.0000000+07:06",
					signedFileId: 0,
					originalFileId: 0,
					signedFileName: String,
					isSigned: False,
					signStatusText: String
				}
			],
			supportingAssignees: 
			[
				{
					id: 0,
					name: String,
					fullName: String,
					email: String,
					departmentId: 0,
					avatar: String,
					telephone: String,
					birthday: "0001-01-01T00:00:00.0000000+07:06",
					confirmStatus: 0,
					confirmStatusText: String,
					signAt: "0001-01-01T00:00:00.0000000+07:06",
					signedFileId: 0,
					originalFileId: 0,
					signedFileName: String,
					isSigned: False,
					signStatusText: String
				}
			],
			statusKey: String,
			statusText: String,
			canRead: False,
			canWrite: False,
			canUpload: False,
			reasonReturn: String,
			returnDate: "0001-01-01T00:00:00.0000000+07:06",
			id: 0,
			workflowId: 0,
			stepOrder: 0,
			statusId: 0,
			stepName: String,
			isRequired: False,
			slaLegalValue: 0,
			slaLegalIsByDay: False,
			slaInternalValue: 0,
			slaInternalIsByDay: False,
			requireAttachment: False,
			isUsingForm: False,
			description: String,
			createdBy: 0,
			departmentIds: 
			[
				0
			],
			mainAssigneeIds: 
			[
				0
			],
			coDepartmentIds: 
			[
				0
			],
			supportingAssigneeIds: 
			[
				0
			],
			stepBasisDocumentIds: 
			[
				0
			],
			attachedDocuments: 
			[
				{
					id: 0,
					documentCode: String,
					title: String,
					isSequentialSigning: False,
					pendingSignFile: 
					{
						id: 0,
						uploadedFile: String,
						subDocumentId: 0,
						stepId: 0,
						code: 0,
						fileName: String,
						filekey: String,
						fileUrl: String,
						checksum: String,
						eTag: String,
						fileSize: 0
					},
					originalFile: 
					{
						id: 0,
						uploadedFile: String,
						subDocumentId: 0,
						stepId: 0,
						code: 0,
						fileName: String,
						filekey: String,
						fileUrl: String,
						checksum: String,
						eTag: String,
						fileSize: 0
					},
					signerConfigs: 
					[
						{
							profile: 
							{
								id: 0,
								name: String,
								fullName: String,
								email: String,
								departmentId: 0,
								avatar: String,
								telephone: String,
								birthday: "0001-01-01T00:00:00.0000000+07:06",
								confirmStatus: 0,
								confirmStatusText: String,
								signAt: "0001-01-01T00:00:00.0000000+07:06",
								signedFileId: 0,
								originalFileId: 0,
								signedFileName: String,
								isSigned: False,
								signStatusText: String
							},
							role: 
							{
								id: 0,
								name: String,
								createdAt: "0001-01-01T00:00:00.0000000+07:06",
								deletedAt: "0001-01-01T00:00:00.0000000+07:06",
								updatedAt: "0001-01-01T00:00:00.0000000+07:06",
								updatedBy: 0,
								deletedBy: 0,
								createdBy: 0,
								permission: 
								[
									String
								]
							},
							id: 0,
							documentId: 0,
							stepId: 0,
							subDocumentId: 0,
							departmentId: 0,
							signerType: 0,
							signerRefId: 0,
							signerRefText: String,
							actionType: 0,
							orderIndex: 0
						}
					]
				}
			]
		}
	]
}