Pular para o conteúdo principal
Versão: 2.2.0

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 parametersTipoRequeridoDescrição
cdprodNumericSimCódigo do produto
Valor Constante: 73
classnameStringSimNome da classe utilizada no WADL
Valor Constante: dc_edit_document_interface
classpathStringSimCaminho para a classe utilizada no WADL
Valor Constante: dc_import

Exemplo de solicitação:

Atributos suportados:

Request Body ParameterTipoRequeridoDescrição
idcategoryStringSimIdentificador da categoria
iddocumentStringSimIdentificador do documento
iduserStringNãoA partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco
idrevisionStringNãoIdentificador da revisão
titleStringNãoTítulo do documento
summaryStringNãoResumo do documento
dtvalidityStringNãoData de vencimento do documento
qtvalidityStringNãoPeríodo de validade do documento
fgtypevalidStringSim¹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
}
]
}