tvpl.api

<back to all web services

GetWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
GET/WorkflowStep/by-workflow
System.NotSupportedException: Unknown language 'mjs', Supported languages: csharp, typescript, dart, java, kotlin, python, swift, vbnet, fsharp
   at ServiceStack.NativeTypes.LangGeneratorExtensions.GenerateSourceCode(MetadataTypes metadataTypes, MetadataTypesConfig typesConfig, String lang, IRequest req, Action`1 configure) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/NativeTypes/ILangGenerator.cs:line 53
   at ServiceStack.Metadata.BaseMetadataHandler.ProcessOperationsAsync(Stream writer, IRequest httpReq, IResponse httpRes) in /home/runner/work/ServiceStack/ServiceStack/ServiceStack/src/ServiceStack/Metadata/BaseMetadataHandler.cs:line 207

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
						}
					]
				}
			]
		}
	]
}