tvpl.api

<back to all web services

UpdateDocumentRequest

Requires Authentication
The following routes are available for this service:
POST/document/update
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.

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

{
	partUploadedFile: 
	{
		id: 0,
		uploadedFile: String,
		subDocumentId: 0,
		stepId: 0,
		code: 0,
		fileName: String,
		filekey: String,
		fileUrl: String,
		checksum: String,
		eTag: String,
		fileSize: 0
	},
	compactUploadedFile: 
	{
		id: 0,
		uploadedFile: String,
		subDocumentId: 0,
		stepId: 0,
		code: 0,
		fileName: String,
		filekey: String,
		fileUrl: String,
		checksum: String,
		eTag: String,
		fileSize: 0
	},
	analysisUploadedFile: 
	{
		id: 0,
		uploadedFile: String,
		subDocumentId: 0,
		stepId: 0,
		code: 0,
		fileName: String,
		filekey: String,
		fileUrl: String,
		checksum: String,
		eTag: String,
		fileSize: 0
	},
	fullUploadedFile: 
	{
		id: 0,
		uploadedFile: String,
		subDocumentId: 0,
		stepId: 0,
		code: 0,
		fileName: String,
		filekey: String,
		fileUrl: String,
		checksum: String,
		eTag: String,
		fileSize: 0
	},
	attachFiles: 
	[
		{
			id: 0,
			uploadedFile: String,
			subDocumentId: 0,
			stepId: 0,
			code: 0,
			fileName: String,
			filekey: String,
			fileUrl: String,
			checksum: String,
			eTag: String,
			fileSize: 0
		}
	],
	basisDocumentId: 
	[
		0
	],
	referenceDocumentId: 
	[
		0
	],
	replacedDocumentId: 
	[
		0
	],
	expiredDocumentId: 
	[
		0
	],
	id: 0,
	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,
	documentTypeId: 0,
	documentGroupId: 0,
	subjectId: 0,
	signBy: String,
	signDate: "0001-01-01T00:00:00.0000000+07:06",
	statusId: 0,
	isInternal: False,
	documentNumber: String,
	documentCode: String,
	isUrgent: False,
	scopeType: 0,
	isActive: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	data: 
	{
		partUploadedFile: 
		{
			fileType: String,
			subDocumentId: 0,
			stepId: 0,
			id: 0,
			accessType: Public,
			createdBy: 0,
			fileName: String,
			filekey: String,
			fileUrl: String,
			checksum: String,
			eTag: String,
			fileSize: 0
		},
		compactUploadedFile: 
		{
			fileType: String,
			subDocumentId: 0,
			stepId: 0,
			id: 0,
			accessType: Public,
			createdBy: 0,
			fileName: String,
			filekey: String,
			fileUrl: String,
			checksum: String,
			eTag: String,
			fileSize: 0
		},
		analysisUploadedFile: 
		{
			fileType: String,
			subDocumentId: 0,
			stepId: 0,
			id: 0,
			accessType: Public,
			createdBy: 0,
			fileName: String,
			filekey: String,
			fileUrl: String,
			checksum: String,
			eTag: String,
			fileSize: 0
		},
		fullUploadedFile: 
		{
			fileType: String,
			subDocumentId: 0,
			stepId: 0,
			id: 0,
			accessType: Public,
			createdBy: 0,
			fileName: String,
			filekey: String,
			fileUrl: String,
			checksum: String,
			eTag: String,
			fileSize: 0
		},
		nextApprover: 
		{
			userProfiles: 
			[
				{
					id: 0,
					fullName: String,
					email: String,
					departmentId: 0,
					partyGroupId: 0,
					avatar: String,
					telephone: String,
					birthday: "0001-01-01T00:00:00.0000000+07:06",
					createdAt: "0001-01-01T00:00:00.0000000+07:06",
					updatedAt: "0001-01-01T00:00:00.0000000+07:06",
					failedLoginCount: 0,
					roles: 
					[
						0
					],
					lastLoginDate: "0001-01-01T00:00:00.0000000+07:06",
					name: String
				}
			],
			processStatusId: 0,
			processTitle: String,
			actionButtonLabel: String,
			processDescription: String,
			isApprovalRequired: False,
			isFinalStep: False,
			stepOrder: 0
		},
		currentApprover: 
		{
			approverId: 0,
			status: String,
			processStatusId: 0,
			processTitle: String,
			actionButtonLabel: String,
			processDescription: String,
			isApprovalRequired: False,
			isFinalStep: False,
			stepOrder: 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
			}
		],
		hasReadPermission: False,
		canGrantReadPermission: False,
		basisDocument: 
		[
			{
				id: 0,
				title: String,
				documentCode: String,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06"
			}
		],
		basisForDocument: 
		[
			{
				id: 0,
				title: String,
				documentCode: String,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06"
			}
		],
		mainDocument: 
		{
			id: 0,
			title: String,
			documentCode: String,
			publicationDate: "0001-01-01T00:00:00.0000000+07:06"
		},
		referenceDocument: 
		[
			{
				id: 0,
				title: String,
				documentCode: String,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06"
			}
		],
		referencedByDocument: 
		[
			{
				id: 0,
				title: String,
				documentCode: String,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06"
			}
		],
		replacedDocument: 
		[
			{
				id: 0,
				title: String,
				documentCode: String,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06"
			}
		],
		replacedByDocument: 
		[
			{
				id: 0,
				title: String,
				documentCode: String,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06"
			}
		],
		expiredDocument: 
		[
			{
				id: 0,
				title: String,
				documentCode: String,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06"
			}
		],
		expiredByDocument: 
		[
			{
				id: 0,
				title: String,
				documentCode: String,
				publicationDate: "0001-01-01T00:00:00.0000000+07:06"
			}
		],
		updateForDocument: 
		{
			id: 0,
			title: String,
			documentCode: String,
			publicationDate: "0001-01-01T00:00:00.0000000+07:06"
		},
		scopeType: 0,
		stepOrder: 0,
		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,
		subjectId: 0,
		signBy: String,
		signDate: "0001-01-01T00:00:00.0000000+07:06",
		updatedAt: "0001-01-01T00:00:00.0000000+07:06",
		statusId: 0,
		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,
		subjectText: String,
		comment: String,
		submitComment: String,
		fullFile: String,
		parthFile: String,
		isActive: False,
		stepOrder: 0,
		stepCount: 0
	},
	code: 0,
	message: String
}