--- title: 4Biz Docs slug: dev-es/4biz-docs description: Learn about the REST communication framework for applications and backend servers in this comprehensive document. Discover details on API endpoints for accessing access levels, subjects, legal hypotheses, people, and conference forms. Explore information createdAt: 2022-06-26T18:41:31.000Z --- Esta sección pretende describir el marco de comunicación REST, establecido entre las aplicaciones y el servidor backend. :::hint{type="warning"} ⚠️**Atención****!** **4biz\_URL**: prefijo de URL inmutable, para que pueda acceder a los servicios disponibles para las aplicaciones móviles **CADA API QUE NECESITE UN "ID de sesión" DEBE ESTAR EN LA SECCIÓN PROPORCIONADA POR LA API "Iniciar sesión".** ::: *** ### LOGIN Servicio de autenticación de usuarios. :::CodeblockTabs Método ```Text GET ``` URL ```html /cit-portal-web/rest/usuario/getToken ``` Solicitación ```json { "username":"rogerio.cassimiro", "password":"123456" } ``` ::: :::CodeblockTabs Respuesta ```json { "id":25080, "dateEdition":"2017-09-12T11:06:28.907-0300", "dateCreation":"2017-08-10T10:00:51.274-0300", "username":"rogerio.cassimiro", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074", "name":"rogerio.cassimiro", "version":":59" } ``` Campos ```none Solicitación: name de usuario: alfanumérico no vacío, no nulo; password: alfanumérica no vacía, no nula; Respuesta: id: numérico ni vacío ni nulo; dateEdition: marca de tiempo no vacía y no nula; dateCreation: marca de tiempo no vacía y no nula; name de usuario: alfanumérico no vacío, no nulo; token: alfanumérico no vacío, no nulo; name: alfanumérico no vacío, no nulo; versión: numérica ni vacía ni nula; ``` ::: ### LISTA DE DEPARTAMENTOS Lista de servicios departamentales a utilizar. :::CodeblockTabs Método ```Text GET ``` URL ```html /cit-ecm-web/integracao/listUnidade ``` Solicitación ```json { "name":"Department 1", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Resposta ```json { "units":[ { "id":93794, "name":"Department 1", "code":"000001" } ] } ``` Campos ```none Solicitación: name: alfanumérico no vacío, no nulo token: alfanumérico no vacío, no nulo Respuesta: unit: Lista vacía, no nula; id: numérico no vacío ni nulo name: alfanumérico no vacío, no nulo code: alfanumérico no vacío, no nulo ``` ::: ### LISTA DE TIPOS DE PROCESO Servicio de listado de tipos de proceso de un proceso a utilizar. :::CodeblockTabs Método ```Text GET ``` URL ```html /cit-ecm-web/integracao/listTipoProcesso ``` Solicitación ```json { "name":"Department 1", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "typeProcess":[ { "id":6967, "name":"Pattern process", "description":"Pattern process detailing" } ] } ``` Campos ```none Solicitación: name: alfanumérico no vacío, no nulo token: alfanumérico no vacío, no nulo Respuesta: typeProcess: Lista vacía, no nula; id: numérico no vacío ni nulo name: alfanumérico no vacío, no nulo description: alfanumérico no vacío, no nulo ``` ::: ### LISTA DE NIVELES DE ACCESO POR TIPO DE PROCESO El servicio de listado de materias de un proceso y/o documento, a ser utilizado. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listNivelAcessoTipoProcesso ``` Solicitación ```json { "idTypeProcess":"54654", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "levelAccessTypeProcess":[ { "idLevelAccessTypeProcess":97942, "idLevelAccess:":"23121", "name":"PUBLIC" }, { "idLevelAccessTypeProcess":97947, " idLevelAccess":91426, "name":"RESTRICT" } ] } ``` Campos ```none Solicitación: idTypeProcess: numérico no vacío ni nulo token: alfanumérico no vacío, no nulo Respuesta: levelAccessTypeProcess: lista no vacía y no nula; idLevelAccess: numérico no vacío ni nulo idLevelAccessTypeProcess: numérico no vacío ni nulo name: alfanumérico no vacío, no nulo ``` ::: ### LISTA DE NIVELES DE ACCESO DEL TIPO DE DOCUMENTO El servicio de listado de materias de un proceso y/o documento, a ser utilizado. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listNivelAcessoTipoDocumento ``` Solicitación ```json { "idTypeDocument":"54654", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "levelAccessTypeDocument":[ { "idLevelAccessTypeDocument":97942, " idLevelAccess:":"23121", "name":"PUBLIC" }, { "idLevelAccessTypeDocument ":97947, "idLevelAccess":91426, "name":"RESTRICTED" } ] } ``` Campos ```none Solicitación: idTypeDocument: numérico no vacío ni nulo token: alfanumérico no vacío ni nulo Respuesta: levelAccesTypeDocument: lista no vacía ni nula; idLevelAccess: numérico no vacío ni nulo idLevelAccessTypeDocument: numérico no vacío ni nulo name: alfanumérico no vacío ni nulo ``` ::: ### LISTA DE MATERIA El servicio de listado de materias de un proceso y/o documento, a ser utilizado. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listAssunto ``` Solicitación ```json { "name":"HEARING.MEETINGS" "code":"010.3", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "subjects":[ { "id":6982, "code":"010.3", "name":"HEARING.MEETINGS", "subject":"010.3 – ADMINISTRATION.GENERAL " } ] } ``` Campos ```none Solicitación: name: alfanumérico no vacío ni nulo code: alfanumérico no vacío ni nulo token: alfanumérico no vacío ni nulo Respuesta: subjects: Listano vacía ni nula; id: numérico no vacío ni nulo code: alfanuméricono vacío ni nulo name: alfanumérico no vacío ni nulo subject: alfanumérico no vacío ni nulo ``` ::: ### LISTA DE HIPÓTESIS JURÍDICAS Relación de hipótesis jurídicas de un proceso o documento a utilizar. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listHipoteseLegal ``` Solicitación ```json { "idLevelAccess":"97947", "name":"Information name", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "hypoteseLegal":[ { "id":7340, "description":"Law description", "name":"Information name" } ] } ``` Campos ```none Solicitación: idLevelAccess: numérico no vacío ni nulo name: alfanumérico no vacío ni nulo token: alfanumérico no vacío ni nulo Respuesta: hypoteseLegal: Lista no vacía ni nula; id: numérico no vacío ni nulo description: alfanumérico no vacío ni nuloo name: alfanumérico no vacío ni nulo ``` ::: ### LISTA DE PERSONAS Lista de personas interesadas en un proceso o documento a utilizar. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listPessoas ``` Solicitación ```json { "name":"Maycon", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "people":[ { "id":98064, "name":"Maycon" } ] } ``` Campos ```none Solicitación: name: alfanumérico no vacío ni nulo token: alfanumérico no vacío ni nulo Respuesta: people: Lista no vacía ni nula; id: numérico no vacío ni nulo name: alfanumérico no vacío ni nulo ``` ::: ### FORMULARIO DE LISTA DE CONFERENCIA Lista de formularios de conferencia de un proceso y/o documento, a utilizar. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listTipoSuporte ``` Solicitación ```json { "name":"Name type media", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "typeSupport":[ { "id":97975, "name":"Name type media" } ] } ``` Campos ```none Solicitación: name: alfanumérico no vacío ni nulo token: alfanumérico no vacío ni nulo Respuesta: typeSupport: Lista no vacia ni nula; id: numérico no vacío ni nulo name: alfanumérico no vacío ni nulo ``` ::: ### LISTA DE TIPOS DE MEDIOS Lista de tipos de medios para que se utilice un documento. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listTipoSuporte ``` Solicitación ```json { "name":"Name type media", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "typeSupport":[ { "id":97975, "name":"Name type media" } ] } ``` Campos ```none Solicitación: name: alfanumérico no vacío ni nulo token: alfanumérico no vacío ni nulo Respuesta: typeSupport: Lista no vacía ni nula; id: numérico no vacío ni nulo name: alfanumérico no vacío ni nulo ``` ::: ### LISTA DE TIPOS DE DOCUMENTOS Servicio para enumerar los tipos de documentos de un documento que se utilizará. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listTipoDocumento ``` Solicitación ```json { "name":"Document type name", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "typeDocument":[ { "id":97949, "name":"Document type name" } ] } ``` Campos ```none Solicitación: name: alfanumérico no vacío ni nulo token: alfanumérico no vacío ni nulo Respuesta: typeDocument: Lista no vacao ni nula; id: numérico no vacío ni nulo name: alfanumérico no vacío ni nulo ``` ::: ### PROCESO DE CREACIÓN Servicio de creación de procesos. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/processo ``` Solicitación ```json { "assuntoComplementar":"Subject Detail", "observacaoGeral":"General observation", "unidade":{ "id":40358 }, "tipoProcesso":{ "id":40394 }, "nivelAcesso":{ "idNivelAcessoTipoProcesso":40395 }, "assunto":{ "id":40393 }, "interessados":[ { "interessado":{ "id":40355 } } ], "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "id":"25353", "nup":"00001.00002/2016-58" } ``` Campos ```none Solicitación: subjectComplementary: alfanumérico no vacío ni nulo observationGeneral: alfanumérico no vacío ni nulo unit: no vacío ni nulo; id: no vacío ni nulo; typeProcess: no vacío ni nulo; id: no vacío ni nulo; levelAccess: no vacío ni nulo; idLevelAccessTypeProcess: no vacío ni nulo; hypoteseLegal: no vacío o nulo si el nivel de acceso difiere de Público. id: númerico no vacío ni nulo subject: no vacío ni nulo; id: no vacío ni nulo; interested: puede ser vacio o no; personal token: alfanumérico no vacío ni nulo Respuesta: id: numérico no vacío ni nulo nup: alfanumérico no vacío ni nulo ``` ::: ### CREAR DOCUMENTO Servicio de creación de documentos. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/documento ``` Solicitación ```json { "numero":"9999", "assuntoComplementar":"Complementary Subject", "dataReferencia":"2016-08-19T14:45:25.360-0300", "unidade":{ "id":40358 }, "processo":{ "id":40503 }, "tipoDocumento":{ "id":40426 }, "nivelAcesso":{ "idNivelAcessoTipoDocumento":40427 }, "hipoteseLegal":{ "id": 5658 }, "assunto":{ "id":40393 }, "destinatario":{ "id":40355 }, "tipoSuporteDocumento":{ "id":40430 }, "interessados":[ { "interessado":{ "id":40355 } } ], "tipoConferencia":{ "id":39950 }, "localizacao":"Physical location", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "id":"25353", "numero":"00001.00002/2016-58" } ``` Campos ```none Solicitación: número: alfanumérico no vacío, no nulo; AsuntoComplementario: no vacío, no nulo alfanumérico; ubicación: alfanumérico no vacío, no nulo; contenido: no vacío o nulo; El contenido del documento debe enviarse en base64 dataReferencia: sello de tiempo no vacío y no nulo; unidad: ni vacía ni nula; id: numérico no vacío ni nulo proceso: ni vacío ni nulo; id: numérico no vacío ni nulo documentType: ni vacío ni nulo; id: numérico no vacío ni nulo AccessLevel: ni vacío ni nulo; idLevelAccessTypeProcess: numérico no vacío ni nulo Hipótesis legal: no vacío o nulo, si el nivel de acceso es diferente de Público; id: numérico no vacío ni nulo sujeto: no vacío ni nulo; id: numérico no vacío ni nulo destinatario: no vacío o nulo; persona: no vacío o nulo; id: numérico no vacío ni nulo documentSupportType: ni vacío ni nulo; interesado: puede ser vacío y nulo; persona: no vacío o nulo; id: numérico no vacío ni nulo tipoConferencia: booleano no vacío o nulo; ubicación: alfanumérico no vacío o nulo, si el atributo ConferenceType es verdadero; token: alfanumérico no vacío, no nulo; Respuesta: id: numérico ni vacío ni nulo; número: no vacío o nulo; ``` ::: ### CARGA DE DOCUMENTOS Servicio de creación de documentos. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/uploadAnexo ``` Solicitación ```json { "file":"9999", "idDocumento":"25353", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json N/A ``` Campos ```none Solicitación: idDocument: numérico ni vacío ni nulo archivo: no vacío ni nulo token: alfanumérico no vacío, no nulo ``` ::: ### GET BY ID PROCESS Servicio que recupera detalles de un proceso, según su identificador. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/getByIdProcesso ``` Solicitación ```json { "id":6967 } ``` ::: :::CodeblockTabs Respuesta ```json { "id":"5252", "assuntoComplementar":"Complementary Subject", "observacaoGeral":"General observation", "dataReferencia":null, "situacao":"In progress", "tipoProcesso":{ "id":97930, "nome":"Type reserved process" }, "nivelAcesso":{ " idNivelAcessoTipoProcesso ":91428, "descricao":"Public" }, "hipoteseLegal":{ "id":97841, "nome":"Information name" }, "assunto":{ "id":97839, "nome":"ADM", "assunto":"0001 - ADM " }, "interessados":[ { "pessoas":{ "id":98064, "nome":"Maycon" } } ], "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` Campos ```none Solicitación: id: numérico no vacío ni nulo token: alfanumérico no vacío, no nulo Respuesta: Sujeto complementario: alfanumérico no vacío, no nulo GeneralNote: Alfanumérico no vacío, no nulo fechaReferencia: unidad: ni vacía ni nula; id: numérico no vacío ni nulo nombre: alfanumérico no vacío, no nulo ProcessType: ni vacío ni nulo; id: numérico no vacío ni nulo nombre: alfanumérico no vacío, no nulo AccessLevel: ni vacío ni nulo; idLevelAccessTypeProcess: numérico no vacío ni nulo descripción: alfanumérico no vacío, no nulo Hipótesis legal: no vacío o nulo, si el nivel de acceso es distinto de Público. id: numérico no vacío ni nulo nombre: alfanumérico no vacío, no nulo sujeto: no vacío ni nulo; id: numérico no vacío ni nulo asunto: alfanumérico no vacío, no nulo interesados: puede ser vacío y nulo; persona: no vacío o nulo; id: numérico no vacío ni nulo nombre: : alfanumérico no vacío, no nulo ``` ::: ### LISTA DE PROCESOS Listado de procesos a utilizar por un documento. :::CodeblockTabs Método ```Text GET ``` URL ```html <4biz_URL>/cit-ecm-web/integracao/listProcesso ``` Solicitación ```json { "nup":"00010.000012/2016-94", "token":"TGT-17-BI06OJWapCune4uamf6zUDOcyf0GNPPxjrOSDJ66ZxtcthZGhf-CITDFSRV074" } ``` ::: :::CodeblockTabs Respuesta ```json { "processo":[ { "id":"5252", "assuntoComplementar":"Complementary Subject", "nup":"00010.000012/2016-94", "status":"Complementary Subject", "tipoProcesso":{ "id":97930, "nome":"type reserved process" }, "nivelAcesso":{ "descricao":"Público" }, "assunto":{ "id":97839, "nome":"ADM", "assunto":"0001 - ADM" }, "hipoteseLegal":{ "id":97841, "nome":"Information name hypothesis" } } ] } ``` Campos ```none Solicitación: nup: alfanumérico puede estar vacío o nulo; token: alfanumérico puede estar vacío o nulo Respuesta: id: numérico no vacío ni nulo Asunto complementario: alfanumérico puede estar vacío o nulo estado: alfanumérico puede estar vacío o nulo Hecho "hecho"; IN_PROGRESS: "En curso"; AGUARDANDO_VALIDACAO: "Esperando validación" VALIDADO: "Válido"; ADJUNTO: "Adjunto"; ProcessType: ni vacío ni nulo; id: numérico no vacío ni nulo nombre: alfanumérico puede estar vacío o nulo AccessLevel: no vacío o nulo idLevelAccessTypeProcess: numérico no vacío ni nulo descripción: alfanumérico puede estar vacío o nulo Hipótesis legal: no vacío o nulo, si el nivel de acceso es distinto de Público. id: numérico no vacío ni nulo nombre: alfanumérico puede estar vacío o nulo sujeto: no vacío ni nulo; id: numérico no vacío ni nulo asunto: alfanumérico puede estar vacío o nulo Hipótesis legal: no vacío o nulo, si el nivel de acceso es distinto de Público. id: numérico no vacío ni nulo nombre: alfanumérico puede estar vacío o nulo ``` :::