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 parameters | Type | Required | Description |
---|---|---|---|
cdprod | Numeric | Yes | Product codeConstant value: 73 |
classname | String | Yes | Class name used in WADLConstant value: dc_edit_document_interface |
classpath | String | Yes | Path to the class used in WADLConstant value: dc_import |
Example request:
Supported attributes:
Request body parameter | Type | Required | Description |
---|---|---|---|
idcategory | String | Yes | Category ID # |
iddocument | String | Yes | Document ID # |
iduser | String | No | Starting with version 2.0, this parameter became obsolete. During the import, leave it blank. |
idrevision | String | No | Revision ID # |
title | String | No | Document title |
summary | String | No | Document summary |
dtvalidity | String | No | Document validity date |
qtvalidity | String | No | Document validity period |
fgtypevalid | String | Yes¹ | 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
}
]
}