Navigation:  Integration via REST web services > Published web services > Document >

DC_EDIT_DOCUMENT_INTERFACE

Previous  Top  Next

This method allows editing information from a document through a REST Web Service. The document edit control is available on the Document arrowrgray File arrowrgray Document screen.

 

Method

POST

 

Input parameters

ID #

Constant value

Parameter

Type

Description

cdprod

73

QUERY

NUMERIC

Product code

classname

dc_edit_document_interface

QUERY

STRING

Class name used in WADL

classpath

dc_import

QUERY

STRING

Path to the class used in WADL

 

Request body

{

   "idcategory": "string",

   "iddocument": "string",

   "idrevision": "string",

   "nmtitle": "string",

   "dssummary": "string",

   "dtvalidity": "string",

   "qtvalidity": "string",

   "fgtypevalid": "string",

"iduserresp": "string"

}

 

Output parameter

{

   "success": true,

   "total": 1,

   "results": [

       {

           "Result": true,

           "Code": 1

       }

   ]

}

 

To enter each of these request items it is necessary to follow the pattern documented below.

Request

ID #

Required

Description

IDCATEGORY

X

Category ID #

IDDOCUMENT

X

Document ID #

IDUSER

 

Starting with version 2.0, this parameter became obsolete. During the import, leave it blank.

IDREVISION

 

Revision ID #

TITLE

 

Document title

SUMMARY

 

Document summary

DTVALIDITY

 

Document validity date

QTVALIDITY

 

Document validity period

FGTYPEVALID

X1

Validity period type:

1 - Days;

2 - Months;

3 - Years.

 

X¹ - 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.