website logo
InglêsEspanhol
⚫Docs - CITSmart PT
⚫Desenvolvimento CITSmart - PT
🟡Docs - CITSmart 8 - PT
⚫Suporte - CITSmart PT
⚫Workflow - PT
⚫Neuro - PT
⚫Keycloak - PT
⚫CITBot - PT
⚫CITDocs PT
⚫Anuva - PT
⚫CITSmart GRP - Gestão de Contratos
Navigate through spaces
⌘K
Visão Geral
Registrar operação web service
Carregar operações
Configurando acesso no CITSmart Webservices
Toolkit
Alterar SLA via script Rhino
Webservice
Exemplos de utilização de webservices
Webservices no CITSmart
Criação de documentação usando Swagger
Webservices - CITSmart Neuro
Webservices CITSmart Docs
Webservices para uso na plataforma CITSmart
Webservice – Exportação de Dados
APIs
API´s ESP -Enterprise Service Platform
Docs powered by
Archbee
Webservice

Webservices CITSmart Docs

24min

Esta seção destina-se a descrever a estrutura de comunicação REST, estabelecida entre aplicativos e o servidor back-end.

Atenção CITSMART_URL: prefixo de URL inalterável, para que você possa acessar os serviços disponibilizados para os aplicativos de mobile TODO API QUE NECESSITA DE “sessionID” PRECISARÁ ESTAR NA SEÇÃO FORNECIDA PELO “Login” DA API.



LOGIN

Serviço de autentificação do usuário

Method
URL
Request
Response
Fields
|
	Solicitação:
	   username: alfanumérico não vazio nem nulo;
	   password: alfanumérico não vazio nem nulo;
	Resposta:
	   id: numérico não vazio nem nulo;
	   dateEdition: timestamp não vazio nem nulo;
	   dateCreation: timestamp não vazio nem nulo;
	   username: alfanumérico não vazio nem nulo;
	   token: alfanumérico não vazio nem nulo;
	   name: alfanumérico não vazio nem nulo;
	   version: numérico não vazio nem nulo;


LISTA DEPARTMENTO

Lista de serviços dos departamentos a serem usados.

Method
HTML
Request
Response
Fields
|
	Solicitação:
	   name: alfanumérico não vazio nem nulo
	   token: alfanumérico não vazio nem nulo
	Resposta:
	   units: Lista vazia e não nula;
	   id: numérico não vazio nem nulo
	   name: alfanumérico não vazio nem nulo
	   code: alfanumérico não vazio nem nulo


LISTA TIPO DE PROCESSO

Serviço de listagem do tipo de processo de um processo, a ser usado

Method
HTML
Request
Response
Fields
|
	{
	"typeProcess":[
	{
	"id":6967,
	"name":"Pattern process",
	"description":"Pattern process detailing"
	}
	]
	}


LISTA NÍVEL DE ACESSO DO TIPO DE PROCESSO

O serviço de listagem de assunto de um processo e / ou documento, a ser usado.

Method
HTML
Request
Response
Fields
|
	Solicitação:
 	   idTypeProcess: numérico não vazio nem nulo
	   token: alfanumérico não vazio nem nulo
	Resposta:
	  levelAccessTypeProcess: lista não vazia nem nula;
	  idLevelAccess: numérico não vazio nem nulo
	  idLevelAccessTypeProcess: numérico não vazio nem nulo
 	  name: alfanumérico não vazio nem nulo


LISTA NÍVEL DE ACESSO DO TIPO DE DOCUMENTO

O serviço de listagem de assunto de um processo e / ou documento, a ser usado.

Method
HTML
Request
Response
Fields
|
	Solicitação:
	  idTypeDocument: numérico não vazio nem nulo
	  token: alfanumérico não vazio nem nulo
	Resposta:
	  levelAccesTypeDocument: lista não vazia nem nula;
	  idLevelAccess: numérico não vazio nem nulo
	  idLevelAccessTypeDocument: numérico não vazio nem nulo
  	  name: alfanumérico não vazio nem nulo


LISTA DE ASSUNTO

O serviço de listagem de assunto de um processo e / ou documento, a ser usado.

Method
HTML
Request
Response
Fields
|
	{
	"subjects":[
	{
	"id":6982,
	"code":"010.3",
	"name":"HEARING.MEETINGS",
	"subject":"010.3 – ADMINISTRATION.GENERAL "
	}
	]
	}


LISTA DE HIPÓTESES LEGAIS

Lista de hipóteses legais de um processo ou documento a ser utilizado.

Method
HTML
Request
Response
Fields
|
	{
	"hypoteseLegal":[
	{
	"id":7340,
	"description":"Law description",
	"name":"Information name"
	}
	]
	}


LISTA DE PESSOAS

Lista de pessoas interessadas em um processo ou documento a ser utilizado.

Method
HTML
Request
Response
Fields
|
	Solicitação:
	  name: alfanumérico não vazio nem nulo
	  token: alfanumérico não vazio nem nulo
	Resposta:
	  people: Lista vazia e não nula;
	  id: numérico não vazio nem nulo
  	  name: alfanumérico não vazio nem nulo


LISTA DA FORMA DE CONFERÊNCIA

Lista dos formulários de conferência de um processo e/ou documento, a ser usado

Method
HTML
Request
Response
Fields
|
	Solicitação:
	  name: alfanumérico não vazio nem nulo
	  token: alfanumérico não vazio nem nulo
	Resposta:
	  formaConference: Lista vazia e não nula;
	  id: numérico não vazio nem nulo
	  name: alfanumérico não vazio nem nulo


LISTA DE TIPOS DE MÍDIA

Lista de tipos de mídia para um documento a ser utilizado.

Method
HTML
Request
Response
Fields
|
	Solicitação:
	  name: alfanumérico não vazio nem nulo
	  token: alfanumérico não vazio nem nulo
	Resposta:
	  typeSupport: Lista vazia e não nula;
	  id: numérico não vazio nem nulo
	  name: alfanumérico não vazio nem nulo 


LISTA TIPOS DE DOCUMENTO

Serviço de listagem de tipos de documentos de um documento a ser utilizado

Method
HTML
Request
Response
Fields
|
	Solicitação:
	  name: alfanumérico não vazio nem nulo 
	  token: alfanumérico não vazio nem nulo 
	Resposta:
	  typeDocument: Lista vazia e não nula;
	  id: numérico não vazio nem nulo
	  name: alfanumérico não vazio nem nulo 	  


CRIAR PROCESSO

Serviço de criação de um processo

Method
HTML
Request
Response
Fields
|
	Solicitação:
 	  subjectComplementary: alfanumérico não vazio nem nulo
	  observationGeneral: alfanumérico não vazio nem nulo
	  unit: não vazio nem nulo;
	  id: não vazio nem nulo;
	  typeProcess: não vazio nem nulo;
	     id: não vazio nem nulo;
	  levelAccess: não vazio nem nulo;
	     idLevelAccessTypeProcess: não vazio nem nulo;
	  hypoteseLegal: não vazio nem nulo se o nível de acesso difere de Público.
	     id: númerico não vazio nem nulo
	  subject: não vazio nem nulo;
  	     id: não vazio nem nulo;
	  interested: pode ser vazio e nulo;
	    pessoal
	  token: alfanumérico não vazio nem nulo
	Resposta:
	  id: numérico não vazio nem nulo
	  nup: alfanumérico não vazio nem nulo 


CRIAR DOCUMENTO

Serviço de ciração de documento

Method
HTML
Request
Response
Fields
|
	Solicitação:
	  numero: alfanumérico não vazio nem nulo;
	  assuntoComplementar: alfanumérico não vazio nem nulo;
	  localização: alfanumérico não vazio nem nulo;
	  conteudo: não vazio nem nulo;
	     O conteúdo do documento deve ser enviado em base64
	  dataReferencia: timestamp não vazio nem nulo;
	  unidade: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	  processo: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	  tipoDocumento: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	  nivelAcesso: não vazio nem nulo;
	     idNivelAcessoTipoProcesso: numérico não vazio nem nulo
	  hipoteseLegal: não vazio nem nulo, se o nível de acesso for diferente de Público;
	     id: numérico não vazio nem nulo
	  assunto: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	  destinatario: não vazio nem nulo;
	     pessoa: não vazio nem nulo;
	        id: numérico não vazio nem nulo
	  tipoSuporteDocumento: não vazio nem nulo;
	  interessados: pode ser vazio e nulo;
	     pessoa: não vazio nem nulo;
	        id: numérico não vazio nem nulo
	  tipoConferencia: Boolean não vazio nem nulo;
	  localização: alfanumérico não vazio nem nulo, se o atributo tipoConferencia for true;
	  token: alfanumérico não vazio nem nulo;
	Resposta:
	  id: numérico não vazio nem nulo;
	  numero: não vazio nem nulo;


DOCUMENTO UPLOAD

Serviço de criação de documento.

Method
HTML
Request
Response
Fields
|
	Solicitação:
 	  idDocumento: numérico não vazio nem nulo
	  file: não vazio nem nulo
	  token: alfanumérico não vazio nem nulo


GET BY ID PROCESS

Serviço que recupera detalhes de um processo, de acordo com seu identificador.

Method
HTML
Request
Response
Fields
|
	Solicitação:
 	  id: numérico não vazio nem nulo
	  token: alfanumérico não vazio nem nulo
	Resposta:
	  assuntoComplementar: alfanumérico não vazio nem nulo
	  observacaoGeral: alfanumérico não vazio nem nulo
	  dataReferencia:
	  unidade: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	  nome: alfanumérico não vazio nem nulo
	  tipoProcesso: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	  nome: alfanumérico não vazio nem nulo
	     nivelAcesso: não vazio nem nulo;
	     idNivelAcessoTipoProcesso: numérico não vazio nem nulo
	     descricao: alfanumérico não vazio nem nulo
	  hipoteseLegal: não vazio nem nulo, se o nível de acesso for diferente de Público.
	     id: numérico não vazio nem nulo
	     nome: alfanumérico não vazio nem nulo
	assunto: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	     assunto: alfanumérico não vazio nem nulo
	interessados: pode ser vazio e nulo;
	     pessoa: não vazio nem nulo;
	        id: numérico não vazio nem nulo
	        nome: : alfanumérico não vazio nem nulo 


LISTA DE PROCESSO

Listagem de processos a serem usados por um documento

Method
HTML
Request
Response
Fields
|
	Solicitação:
 	  nup: alfanumérico podendo ser vazio ou nulo;
	  token: alfanumérico podendo ser vazio ou nulo
	Resposta:
	  id: numérico não vazio nem nulo
	  assuntoComplementar: alfanumérico podendo ser vazio ou nulo
	  status: alfanumérico podendo ser vazio ou nulo
  	     CONCLUIDO: "Concluído";
	     EM_ANDAMENTO: "Em andamento";
	     AGUARDANDO_VALIDACAO: "Aguardando validação "
	     VALIDADO: "Válido";
	     ANEXADO: "Anexado";
	  tipoProcesso: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	     nome: alfanumérico podendo ser vazio ou nulo
	  nivelAcesso: não vazio nem nulo
	     idNivelAcessoTipoProcesso: numérico não vazio nem nulo
	     descricao: alfanumérico podendo ser vazio ou nulo
	  hipoteseLegal: não vazio nem nulo, se o nível de acesso for diferente de Público.
	     id: numérico não vazio nem nulo
	     nome: alfanumérico podendo ser vazio ou nulo
	  assunto: não vazio nem nulo;
	     id: numérico não vazio nem nulo
	     assunto: alfanumérico podendo ser vazio ou nulo
	  hipoteseLegal: não vazio nem nulo, se o nível de acesso for diferente de Público.
	     id: numérico não vazio nem nulo
	     name: alfanumérico podendo ser vazio ou nulo 




Did this page help you?
PREVIOUS
Webservices - CITSmart Neuro
NEXT
Webservices para uso na plataforma CITSmart
Docs powered by
Archbee
TABLE OF CONTENTS
LOGIN
LISTA DEPARTMENTO
LISTA TIPO DE PROCESSO
LISTA NÍVEL DE ACESSO DO TIPO DE PROCESSO
LISTA NÍVEL DE ACESSO DO TIPO DE DOCUMENTO
LISTA DE ASSUNTO
LISTA DE HIPÓTESES LEGAIS
LISTA DE PESSOAS
LISTA DA FORMA DE CONFERÊNCIA
LISTA DE TIPOS DE MÍDIA
LISTA TIPOS DE DOCUMENTO
CRIAR PROCESSO
CRIAR DOCUMENTO
DOCUMENTO UPLOAD
GET BY ID PROCESS
LISTA DE PROCESSO
Docs powered by
Archbee

  • Treinamentos

    Visite nossa plataforma de treinamentos

  • Idioma

    Português
    English

© Copyright CITSmart - 2021