Skip to main content
Version: 2.2.0

DC_EDIT_DOCUMENT_INTERFACE

This method allows editing information from a document through a REST web service. The document edit control is available on the Document -> File -> Document screen.

POST /apigateway/se/generic/gn_webservice/gn_webservice_execute.php

Query parameters:

Query parametersTypeRequiredDescription
cdprodNumericYesProduct code
Constant value: 73
classnameStringYesClass name used in WADL
Constant value: dc_edit_document_interface
classpathStringYesPath to the class used in WADL
Constant value: dc_import

Example request:

Supported attributes:

Request body parameterTypeRequiredDescription
idcategoryStringYesCategory ID #
iddocumentStringYesDocument ID #
iduserStringNoStarting with version 2.0, this parameter became obsolete. During the import, leave it blank.
idrevisionStringNoRevision ID #
titleStringNoDocument title
summaryStringNoDocument summary
dtvalidityStringNoDocument validity date
qtvalidityStringNoDocument validity period
fgtypevalidStringYes¹Validity period type:
1 - Days;
2 - Months;
3 - Years.
info

Yes¹ - The FGTYPEVALID field is mandatory when using the QTVALIDITY field. The DTVALIDITY and QTVALIDITY fields cannot be used together. If both fields have been filled out, the DTVALIDITY field will not count.

{
"idcategory": "string",
"iddocument": "string",
"idrevision": "string",
"nmtitle": "string",
"dssummary": "string",
"dtvalidity": "string",
"qtvalidity": "string",
"fgtypevalid": "string",
"iduserresp": "string"
}

Example response:

200 OK

{
"success": true,
"total": 1,
"results": [
{
"Result": true,
"Code": 1
}
]
}