DC_EDIT_DOCUMENT_INTERFACE
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 -> Cadastro -> Documento.
POST /apigateway/se/generic/gn_webservice/gn_webservice_execute.php
Parâmetros de consulta:
Query parameters | Tipo | Requerido | Descrição |
---|---|---|---|
cdprod | Numeric | Sim | Código do produtoValor Constante: 73 |
classname | String | Sim | Nome da classe utilizada no WADLValor Constante: dc_edit_document_interface |
classpath | String | Sim | Caminho para a classe utilizada no WADLValor Constante: dc_import |
Exemplo de solicitação:
Atributos suportados:
Request Body Parameter | Tipo | Requerido | Descrição |
---|---|---|---|
idcategory | String | Sim | Identificador da categoria |
iddocument | String | Sim | Identificador do documento |
iduser | String | Não | A partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco |
idrevision | String | Não | Identificador da revisão |
title | String | Não | Título do documento |
summary | String | Não | Resumo do documento |
dtvalidity | String | Não | Data de vencimento do documento |
qtvalidity | String | Não | Período de validade do documento |
fgtypevalid | String | Sim¹ | Tipo de período da validade: 1 - Dias; 2 - Meses; 3 - Anos. |
info
Sim¹ - 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.
{
"idcategory": "string",
"iddocument": "string",
"idrevision": "string",
"nmtitle": "string",
"dssummary": "string",
"dtvalidity": "string",
"qtvalidity": "string",
"fgtypevalid": "string",
"iduserresp": "string"
}
Exemplo de resposta:
200 OK
{
"success": true,
"total": 1,
"results": [
{
"Result": true,
"Code": 1
}
]
}