tvpl.api

<back to all web services

CreateWorkflowStepRequest

Requires Authentication
The following routes are available for this service:
POST/WorkflowStep/update
CreateWorkflowStepRequest Parameters:
NameParameterData TypeRequiredDescription
StepAttachFilesbodyList<UploadedFiles>No
WorkflowStep Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
WorkflowIdformintNo
StepOrderformint?No
StepNameformstringYes
IsRequiredformboolYes
SLALegalValueformint?No
SLALegalIsByDayformbool?No
SLAInternalValueformint?No
SLAInternalIsByDayformbool?No
RequireAttachmentformboolNo
DescriptionformstringYes
CreatedByformintNo
DepartmentIdsformList<int>No
StepBasisDocumentIdsformList<int>No
StepAttachedIdsformList<int>No
MainAssigneeIdsformList<int>No
UploadedFiles Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
UploadedFileformstringYes
SubDocumentIdformint?No
StepIdformint?No
CodeformintNo
BasicUploadedFile Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringYes
FilekeyformstringYes
FileUrlformstringYes
ChecksumformstringYes
ETagformstringYes
FileSizeformlongNo
WorkflowStepResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
MessageformstringYes
InsertedIdformintNo

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.

POST /WorkflowStep/update HTTP/1.1 
Host: etc-api.vsmlab.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	stepAttachFiles: 
	[
		{
			id: 0,
			uploadedFile: String,
			subDocumentId: 0,
			stepId: 0,
			code: 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
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	code: 0,
	message: String,
	insertedId: 0
}