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
BasisDocuments	form	List<SimpleDocumentRelation>	No
AttachedDocuments	form	List<SimpleDocumentRelation>	No
ReferenceDocuments	form	List<SimpleDocumentRelation>	No
MainAssignees	form	List<WorkFlowProfile>	No
AttachFiles	form	List<UploadedFileAttach>	No

**WorkflowStep** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
WorkflowId	form	int	No
StepOrder	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
Description	form	string	Yes
CreatedBy	form	int	No
DepartmentIds	form	List<int>	No
StepBasisDocumentIds	form	List<int>	No
StepAttachedIds	form	List<int>	No
MainAssigneeIds	form	List<int>	No

**Category** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Level	form	int	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

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

**WorkFlowProfile** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	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

**UploadedFileAttach** Parameters:
Name	Parameter	Data Type	Required
FileType	form	string	Yes
SubDocumentId	form	int?	No
StepId	form	int?	No

**UploadedFileModel** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
AccessType	form	AccessType	No
CreatedBy	form	int	No
CreatedDate	form	DateTime	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

**AccessType** Enum:
Public
Restricted

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,
					sortOrder: 0,
					lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
					children: 
					[
						{
							id: 0,
							level: 0,
							sortOrder: 0,
							lastUpdate: "0001-01-01T00:00:00.0000000+07:06",
							children: 
							[
								{
									id: 0,
									level: 0,
									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"
				}
			],
			attachedDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06"
				}
			],
			referenceDocuments: 
			[
				{
					id: 0,
					title: String,
					documentCode: String,
					publicationDate: "0001-01-01T00:00:00.0000000+07:06"
				}
			],
			mainAssignees: 
			[
				{
					id: 0,
					fullName: String,
					email: String,
					departmentId: 0,
					avatar: String,
					telephone: String,
					birthday: "0001-01-01T00:00:00.0000000+07:06",
					confirmStatus: 0
				}
			],
			attachFiles: 
			[
				{
					fileType: String,
					subDocumentId: 0,
					stepId: 0,
					id: 0,
					accessType: Public,
					createdBy: 0,
					fileName: String,
					filekey: String,
					fileUrl: String,
					checksum: String,
					eTag: String,
					fileSize: 0
				}
			],
			id: 0,
			workflowId: 0,
			stepOrder: 0,
			stepName: String,
			isRequired: False,
			slaLegalValue: 0,
			slaLegalIsByDay: False,
			slaInternalValue: 0,
			slaInternalIsByDay: False,
			requireAttachment: False,
			description: String,
			createdBy: 0,
			departmentIds: 
			[
				0
			],
			stepBasisDocumentIds: 
			[
				0
			],
			stepAttachedIds: 
			[
				0
			],
			mainAssigneeIds: 
			[
				0
			]
		}
	]
}