Sistema Protocolo Integrado - Serviços

• Listar Anexos do Protocolo (Efetua a consulta da lista de Anexos do Protocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Query Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
download	string	-	Não	Obtém URL para download do arquivo (anexo). Opções: true ou false.
nome	string	50	Não	Parte do nome do arquivo (anexo). Exemplo: relatorio_financeiro.pdf

Exemplo de Código

Exemplo de Retorno (application/json)

• Consultar Anexo do Protocolo (Efetua a consulta de Anexo do Protocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).
codigo	string	-	Sim	Código do anexo. Exemplo: 1234. Obs.: Código do anexo pode ser obtido pelo serviço Listar Anexos do Protocolo.

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Query Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
download	string	-	Não	Obtém URL para download do arquivo (anexo). Opções: true ou false.

Exemplo de Código

Exemplo de Retorno (application/json)

• Incluir Anexo no Protocolo (Efetua a inclusão de Anexo do Protocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Body Parameters (multipart/form-data)

Campo	Formato	Tamanho	Obrigatório	Descrição
nomeArquivo	string	255 (máx)	Sim	Nome do arquivo (anexo). Exemplo: relatorio_financeiro.pdf
md5Arquivo	string	32	Sim	Hash MD5 do arquivo (anexo). Exemplo: fa58b407de3639c721a73d51fce4270d
binarioArquivo	array (file)	100MB	Sim	Binário do arquivo (anexo).

Exemplo de Código

Exemplo de Retorno (application/json)

• Excluir Anexo do Protocolo (Efetua a exclusão de Anexo do Protocolo)

Voltar

Requisição

Escopo

Path Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
protocolo	string	9 ou 12	Sim	Número do protocolo. Exemplo: 123456789 (sem máscara) ou 12.345.678-9 (com máscara).
codigo	string	-	Sim	Código do anexo. Exemplo: 1234. Obs.: Código do anexo pode ser obtido pelo serviço Listar Anexos do Protocolo.

Header Parameters

Campo	Formato	Tamanho	Obrigatório	Descrição
Authorization	string	4000	Sim	Token Central de Segurança (formato JWT) para validação do sistema de acesso. Opções: Token do tipo client_credentials ou do tipo authorization_code.
consumerId	string	200	Sim	Consumidor API Gateway para identificação do sistema de acesso. Exemplo: SPIWEB. Como obter as credenciais para consumir os serviços?

Body Parameters (application/json)

Campo	Formato	Tamanho	Obrigatório	Descrição
justificativa	string	300 (máx)	Sim	Justificativa/motivo pelo qual a exclusão está sendo realizada. Exemplo: Anexo excluído por duplicidade.

Exemplo de Código

Exemplo de Retorno (text/plain)

Voltar