tvpl.api

<back to all web services

WorkflowInstanceStatisticsRequest

Requires Authentication
Required permission:view_workflow_statistics
The following routes are available for this service:
GET/workflow/statistics-instances
WorkflowInstanceStatisticsRequest Parameters:
NameParameterData TypeRequiredDescription
TitlequerystringNo
TypeIdqueryint?No
StatusIdqueryint?No
FilterAccountIdqueryint?No
FilterDepartmentIdqueryint?No
PagingRequest Parameters:
NameParameterData TypeRequiredDescription
PageformintNo
LimitformintNo
SearchResponse Parameters:
NameParameterData TypeRequiredDescription
TotalCountformlongNo
CodeformintNo
DataformList<DocumentSearchResultItem>Yes
MessageformstringYes
DocumentSearchResultItem Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
DescriptionformstringYes
OwnerformstringNo
DocumentPolicyIdformint?No
UpdateDocumentIdformint?No
EffectBeginDateformDateTime?No
EffectEndDateformDateTime?No
IssuingAgencyIdformint?No
SignByformstringNo
SignDateformDateTime?No
UpdatedAtformDateTime?No
StatusIdformint?No
StatusKeyformstringNo
IsInternalformboolNo
DocumentNumberformstringNo
DocumentCodeformstringNo
IsUrgentformbool?No
IdformintNo
ReasonReturnformstringNo
AccountIdformint?No
ApproverIdformint?No
UpdatedByformstringNo
CreatedByformstringNo
IsPartyformbool?No
IsRevisionRequestedformbool?No
IsPrivateformbool?No
DepartmentIdformint?No
PublicationDateformDateTime?No
ProcessStatusIdformintNo
DocumentTypeIdformint?No
DocumentGroupIdformint?No
AccountNameformstringNo
AcceptAccountNameformstringNo
DocumentGroupTextformstringNo
ProcessStatusTextformstringNo
DocumentTypeTextformstringNo
DepartmentTextformstringNo
StatusTextformstringNo
IssuingAgencyTextformstringNo
CommentformstringNo
SubmitCommentformstringNo
FullFileformstringNo
ParthFileformstringNo
IsActiveformbool?No
StepOrderformint?No
StepCountformint?No
CompletedStepCountformint?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 /workflow/statistics-instances HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	totalCount: 0,
	code: 0,
	data: 
	[
		{
			title: String,
			description: String,
			owner: String,
			documentPolicyId: 0,
			updateDocumentId: 0,
			effectBeginDate: "0001-01-01T00:00:00.0000000+07:06",
			effectEndDate: "0001-01-01T00:00:00.0000000+07:06",
			issuingAgencyId: 0,
			signBy: String,
			signDate: "0001-01-01T00:00:00.0000000+07:06",
			updatedAt: "0001-01-01T00:00:00.0000000+07:06",
			statusId: 0,
			statusKey: String,
			isInternal: False,
			documentNumber: String,
			documentCode: String,
			isUrgent: False,
			id: 0,
			reasonReturn: String,
			accountId: 0,
			approverId: 0,
			updatedBy: String,
			createdBy: String,
			isParty: False,
			isRevisionRequested: False,
			isPrivate: False,
			departmentId: 0,
			publicationDate: "0001-01-01T00:00:00.0000000+07:06",
			processStatusId: 0,
			documentTypeId: 0,
			documentGroupId: 0,
			accountName: String,
			acceptAccountName: String,
			documentGroupText: String,
			processStatusText: String,
			documentTypeText: String,
			departmentText: String,
			statusText: String,
			issuingAgencyText: String,
			comment: String,
			submitComment: String,
			fullFile: String,
			parthFile: String,
			isActive: False,
			stepOrder: 0,
			stepCount: 0,
			completedStepCount: 0
		}
	],
	message: String
}