Navigation:  Integração via web services REST > Web services publicados > Documento >

DC_EDIT_DOCUMENT_INTERFACE

Previous  Top  Next

Este método possibilita alterar algumas informações de um documento por meio de um Web Service REST. O controle de edição de documentos é disponibilizado na tela Documento arrowrgray Cadastro arrowrgray Documento.

 

Método

POST

 

Parâmetros de entrada

Identificador

Valor constante

Parâmetro

Tipo

Descrição

cdprod

73

QUERY

NUMERIC

Código do produto

classname

dc_edit_document_interface

QUERY

STRING

Nome da classe utilizada no WADL

classpath

dc_import

QUERY

STRING

Caminho para a classe utilizada no WADL

 

Corpo da requisição

{

   "idcategory": "string",

   "iddocument": "string",

   "idrevision": "string",

   "nmtitle": "string",

   "dssummary": "string",

   "dtvalidity": "string",

   "qtvalidity": "string",

   "fgtypevalid": "string",

"iduserresp": "string"

}

 

Parâmetros de saída

{

   "success": true,

   "total": 1,

   "results": [

       {

           "Result": true,

           "Code": 1

       }

   ]

}

 

Para a inserção de cada um destes itens da requisição é necessário seguir o padrão abaixo documentado.

Requisição

Identificador

Requerido

Descrição

IDCATEGORY

X

Identificador da categoria

IDDOCUMENT

X

Identificador do documento

IDUSER

 

A partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco

IDREVISION

 

Identificador da revisão

TITLE

 

Título do documento

SUMMARY

 

Resumo do documento

DTVALIDITY

 

Data de vencimento do documento

QTVALIDITY

 

Período de validade do documento

FGTYPEVALID

X1

Tipo de período da validade:

1 - Dias;

2 - Meses;

3 - Anos.

 

X¹ - O campo FGTYPEVALID é obrigatório ao utilizar o campo QTVALIDITY.

* Os campos DTVALIDITY e QTVALIDITY não podem ser utilizados em conjunto. Em caso de ambos os campos terem sido preenchidos, o campo DTVALIDITY será desconsiderado.