tvpl.api

<back to all web services

SearchWorkflowRequest

Requires Authentication
The following routes are available for this service:
GET/workflow/search
SearchWorkflowRequest Parameters:
NameParameterData TypeRequiredDescription
KeywordquerystringNo
IsInstancequerybool?No
IsActivequerybool?No
DocumentTypeIdqueryint?No
MainIdqueryint?No
AccountIdqueryint?No
DepartmentIdqueryint?No
PagingRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
LimitformintNo
PageResponse<AuditLog> Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
DataformList<AuditLog>Yes
PaginationformPaginationYes
AuditLog Parameters:
NameParameterData TypeRequiredDescription
UserNameformstringNo
UserIdformint?No
DocumentIdformintNo
ActionformstringYes
DescriptionformstringYes
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo
IpAddressformstringNo
UserAgentformstringNo
MongoObject Parameters:
NameParameterData TypeRequiredDescription
IdformObjectIdNo
Pagination Parameters:
NameParameterData TypeRequiredDescription
TotalformlongNo
PagesformintNo
OffsetformlongNo
LimitformintNo
CurrentPageformintNo

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 /workflow/search HTTP/1.1 
Host: qlcn-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	data: 
	[
		{
			id: 0,
			title: String,
			description: String,
			documentCode: String,
			documentTypeId: 0,
			isInstance: False,
			mainId: 0,
			isActive: False,
			statusId: 0,
			accountId: 0,
			departmentId: 0,
			scopeType: 2,
			createdBy: String,
			updatedBy: String,
			updatedAt: "0001-01-01T00:00:00.0000000+07:06"
		}
	]
}