Formulários ECM (ecm_form)

2.0info: 2.23.2 Formulários ECM description: Formulários ECM x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: ecm_form contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ecm_form/queries/getEntityFields: post: description: Retorna estrutura de campos de uma entidade considerando todas as versões já criadas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: identificador da entidade. responses: 200: description: Ok schema: type: object required: – name – fields properties: name: type: string description: Nome da Entidade fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: Campos da Entidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna estrutura de campos de uma entidade considerando todas as versões já criadas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: identificador da entidade. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – name – fields properties: name: type: string description: Nome da Entidade fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: Campos da Entidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getEntities: post: description: Retornar informações de uma emtidade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filterType: type: string allOf: – #/definitions/entityType description: Filtro por tipo de entidade page: type: integer format: int64 description: Pagina Inicial pageSize: type: integer format: int64 description: Tamanho da Pagina searchTerm: type: string description: Filtro por título ou nome responses: 200: description: Ok schema: type: object required: – result – totalElements – totalPages properties: result: type: array items: type: object allOf: – #/definitions/entityDef minimum: 1 description: Lista de Entidades totalElements: type: integer format: int64 description: TOtal de Elementos totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getEntityById: post: description: Lista a entidade pelo id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador da entidade responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entityDef description: Entidade Encontrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista a entidade pelo id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador da entidade in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entityDef description: Entidade Encontrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getEntityByName: post: description: Lista a entidade pelo nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Filtro pelo nome responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entityDef description: Entidade Encontrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista a entidade pelo nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Filtro pelo nome in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: object allOf: – #/definitions/entityDef description: Entidade Encontrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/existEntityByName: post: description: Existe a entidade pelo nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Filtro pelo nome responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Entidade Encontrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Existe a entidade pelo nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Filtro pelo nome in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Entidade Encontrada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getImportTableSizeLimit: post: description: Busca o tamanho máximo do arquivo de importação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – size properties: size: type: integer format: int64 description: Tamanho máximo do arquivo de importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o tamanho máximo do arquivo de importação tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – size properties: size: type: integer format: int64 description: Tamanho máximo do arquivo de importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getFieldSizeLimit: post: description: Busca o tamanho máximo de campos do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – size properties: size: type: integer format: int64 description: Tamanho máximo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o tamanho máximo de campos do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – size properties: size: type: integer format: int64 description: Tamanho máximo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getForms: post: description: Retorna lista de Formulários. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: entityFilter: type: string description: Chave para filtrar por nome da entidade allowExternalUse: type: boolean description: Filtro por permissão de uso externo responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/formDef minimum: 1 description: Obtem uma lista da definição dos formulários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de Formulários. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityFilter description: Chave para filtrar por nome da entidade in: query type: string – name: allowExternalUse description: Filtro por permissão de uso externo in: query type: boolean responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/formDef minimum: 1 description: Obtem uma lista da definição dos formulários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/listForms: post: description: Lista de formulários com filtro e paginação. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: formName: type: string description: Filtro por nome do formulário allowExternalUse: type: boolean description: Filtro por permissão de uso externo offset: type: integer format: int64 description: Faixa inicial da consulta default: 0 size: type: integer format: int64 description: Quantidade de linhas da consulta maximum: 100 default: 10 orderby: type: string description: Ordenação dos registros. Exemplo: campo_1 asc, campo_2 desc responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de Registros contents: type: array items: type: object allOf: – #/definitions/formListDef minimum: 1 description: Lista de formulários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista de formulários com filtro e paginação. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formName description: Filtro por nome do formulário in: query type: string – name: allowExternalUse description: Filtro por permissão de uso externo in: query type: boolean – name: offset description: Faixa inicial da consulta in: query type: integer format: int64 – name: size description: Quantidade de linhas da consulta in: query type: integer format: int64 – name: orderby description: Ordenação dos registros. Exemplo: campo_1 asc, campo_2 desc in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de Registros contents: type: array items: type: object allOf: – #/definitions/formListDef minimum: 1 description: Lista de formulários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getFormVersions: post: description: Obtem a lista da versão dos formulários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: name: type: string description: Nome do formulário responses: 200: description: Ok schema: type: object properties: forms: type: array items: type: object allOf: – #/definitions/formVersions description: lista de versões de um formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem a lista da versão dos formulários tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Nome do formulário in: query type: string responses: 200: description: Ok schema: type: object properties: forms: type: array items: type: object allOf: – #/definitions/formVersions description: lista de versões de um formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getFormLogs: post: description: Retorna o json anterior e atual das mudanças de um formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName properties: entityName: type: string description: Nome do formulário responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/viewFormLogs minimum: 1 description: Retorna as mudanças no formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o json anterior e atual das mudanças de um formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome do formulário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/viewFormLogs minimum: 1 description: Retorna as mudanças no formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getFormFields: post: description: Retorna estrutura de campos de uma versão de formulário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: identificador da entidade. type: integer format: int64 description: versão do formulário. hideArrayFields: type: boolean description: Esconder campos pai/filho responses: 200: description: Ok schema: type: object required: – name – title – version – internal – fields properties: name: type: string description: nome da entidade. type: string description: título do formulário. type: integer format: int64 description: versão do formulário. internal: type: boolean description: Indica se o formulário é interno fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: lista de campos definidos no formulário. allowExternalUse: type: boolean description: Indica se formulário pode ser usado em Widget de Crud 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna estrutura de campos de uma versão de formulário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: identificador da entidade. in: query required: true type: string – name: version description: versão do formulário. in: query type: integer format: int64 – name: hideArrayFields description: Esconder campos pai/filho in: query type: boolean responses: 200: description: Ok schema: type: object required: – name – title – version – internal – fields properties: name: type: string description: nome da entidade. type: string description: título do formulário. type: integer format: int64 description: versão do formulário. internal: type: boolean description: Indica se o formulário é interno fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: lista de campos definidos no formulário. allowExternalUse: type: boolean description: Indica se formulário pode ser usado em Widget de Crud 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getFormSections: post: description: Retorna as seções de uma versão do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – version properties: name: type: string description: Identificador da entidade do formulário type: integer format: int64 description: Versão do formulário responses: 200: description: Ok schema: type: object required: – formSections properties: formSections: type: array items: type: object allOf: – #/definitions/formSection minimum: 1 description: Seções do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as seções de uma versão do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Identificador da entidade do formulário in: query required: true type: string – name: version description: Versão do formulário in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – formSections properties: formSections: type: array items: type: object allOf: – #/definitions/formSection minimum: 1 description: Seções do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getForm: post: description: Retorna estrutura do form completa. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: identificador da entidade. type: integer format: int64 description: versão do formulário. responses: 200: description: Ok schema: type: object required: – name – title – version – fields – formLayout – internal properties: name: type: string description: Nome da entidade type: string description: Título do formulário type: integer format: int64 description: Versão do formulário fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: Lista de campos definidos no formulário formLayout: type: string description: Parte visual do formulário formSections: type: array items: type: object allOf: – #/definitions/formSection description: Seções do formulário formRules: type: array items: type: object allOf: – #/definitions/formRuleRec description: Regras do formulário internal: type: boolean description: Se o formulário é interno, ou seja, não foi criado pelo editor de formulários do ECM. allowExternalUse: type: boolean description: Indica se formulário pode ser usado em Widget de Crud 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna estrutura do form completa. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: identificador da entidade. in: query required: true type: string – name: version description: versão do formulário. in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – name – title – version – fields – formLayout – internal properties: name: type: string description: Nome da entidade type: string description: Título do formulário type: integer format: int64 description: Versão do formulário fields: type: array items: type: object allOf: – #/definitions/fieldDef minimum: 1 description: Lista de campos definidos no formulário formLayout: type: string description: Parte visual do formulário formSections: type: array items: type: object allOf: – #/definitions/formSection description: Seções do formulário formRules: type: array items: type: object allOf: – #/definitions/formRuleRec description: Regras do formulário internal: type: boolean description: Se o formulário é interno, ou seja, não foi criado pelo editor de formulários do ECM. allowExternalUse: type: boolean description: Indica se formulário pode ser usado em Widget de Crud 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getFormFieldsData: post: description: Retorna os campos e seus respectivos valores (no formato json), de um registro de formulário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recordId – entityName properties: recordId: type: integer format: int64 description: identificador do registro do formulário. entityName: type: string description: nome da entidade associado ao formulário responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Dados dos campos que correspondem ao registro de formulário fornecido. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os campos e seus respectivos valores (no formato json), de um registro de formulário. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: recordId description: identificador do registro do formulário. in: query required: true type: integer format: int64 – name: entityName description: nome da entidade associado ao formulário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/fieldData minimum: 1 description: Dados dos campos que correspondem ao registro de formulário fornecido. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getLastFormVersion: post: description: Retorna última versão do formulário a partir do nome da entidade. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName properties: entityName: type: string description: Nome da entidade responses: 200: description: Ok schema: type: object required: – version properties: type: integer format: int64 description: Versão do Formaulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna última versão do formulário a partir do nome da entidade. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string responses: 200: description: Ok schema: type: object required: – version properties: type: integer format: int64 description: Versão do Formaulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDataSources: post: description: Lista os datasources tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Página atual pageSize: type: integer format: int64 description: Tamenho da Páginação searchTerm: type: string description: Pesquisa por nome ou link da fonte de dados orderName: type: string description: Ordena as fontes por nome ASC ou DESC default: ASC hiddenConector: type: boolean description: Esconde os conectores da listagem default: false onlyConector: type: boolean description: default: false responses: 200: description: Ok schema: type: object required: – dataSources – totalElements – totalPages properties: dataSources: type: array items: type: object allOf: – #/definitions/dataSource minimum: 1 description: Lista de Datasources totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os datasources tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Página atual in: query type: integer format: int64 – name: pageSize description: Tamenho da Páginação in: query type: integer format: int64 – name: searchTerm description: Pesquisa por nome ou link da fonte de dados in: query type: string – name: orderName description: Ordena as fontes por nome ASC ou DESC in: query type: string – name: hiddenConector description: Esconde os conectores da listagem in: query type: boolean – name: onlyConector description: in: query type: boolean responses: 200: description: Ok schema: type: object required: – dataSources – totalElements – totalPages properties: dataSources: type: array items: type: object allOf: – #/definitions/dataSource minimum: 1 description: Lista de Datasources totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDataSourceById: post: description: Lista o datasources pelo id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do Data Source responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Datasource encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista o datasources pelo id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do Data Source in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Datasource encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDataSourceByConectorId: post: description: Obtem o datasource pelo conectorid tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do conector conectorConfigurationId: type: string description: Identificador da configuração do conector responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Datasource encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem o datasource pelo conectorid tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do conector in: query required: true type: string – name: conectorConfigurationId description: Identificador da configuração do conector in: query type: string responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Datasource encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/isConectorConfigured: post: description: Obtem o datasource pelo conectorid tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: array items: type: string minimum: 1 description: Identificador do conector responses: 200: description: Ok schema: type: object required: – conectorConfigureds properties: conectorConfigureds: type: array items: type: object allOf: – #/definitions/conectorConfigured minimum: 1 description: Datasource encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem o datasource pelo conectorid tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do conector in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – conectorConfigureds properties: conectorConfigureds: type: array items: type: object allOf: – #/definitions/conectorConfigured minimum: 1 description: Datasource encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDataSourceByName: post: description: Lista o datasources pelo nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do Datasource responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Datasource encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista o datasources pelo nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Nome do Datasource in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Datasource encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDataSourceByNames: post: description: Lista os datasources pelos nomes informados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – listMethod properties: name: type: array items: type: string minimum: 1 description: Nome do Datasource listMethod: type: string allOf: – #/definitions/listMethodDataSource description: Metodo de listagem responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: array items: type: object allOf: – #/definitions/dataSource minimum: 1 description: Datasources encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDataSourcesTemplates: post: description: Lista os datasources Templates tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – templates properties: templates: type: array items: type: object allOf: – #/definitions/dataSourceTemplate minimum: 1 description: Lista dos Tenplates 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os datasources Templates tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – templates properties: templates: type: array items: type: object allOf: – #/definitions/dataSourceTemplate minimum: 1 description: Lista dos Tenplates 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDataSourcesTemplateByName: post: description: Lista os datasources Templates tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – templateName properties: templateName: type: string description: Nome do Template responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Retrono datasource 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os datasources Templates tags: – Queries x-senior-visibility: PRIVATE parameters: – name: templateName description: Nome do Template in: query required: true type: string responses: 200: description: Ok schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Retrono datasource 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getResultSet: post: description: Lista um conjunto de dados de um datasource ecm tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataSource properties: dataSource: type: string description: nome do datasource token: type: string description: Token Autenticação Serviço dataSourceField: type: string description: Campo do data source utilizado para filtragem searchingValue: type: string description: Valor atual do componente datasource filters: type: array items: type: object allOf: – #/definitions/queryDataSourceFilter description: filtro de dados complementares skip: type: integer format: int64 description: Número de registros para pular na busca top: type: integer format: int64 description: Numero maximo de registros para busca enableCache: type: boolean description: Indica se o cache da fonte de dados será habilitado formName: type: string description: Nome do formulário formFieldName: type: string description: Nome do campo do formulário responses: 200: description: Ok schema: type: object required: – data properties: data: type: string description: dados em formato json 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDataSourceStats: post: description: Lista informações sobre as requisições de datasource tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataSource properties: dataSource: type: string description: nome do datasource responses: 200: description: Ok schema: type: object required: – averageTime – requests – requestsFail properties: averageTime: type: integer format: int64 description: Tempo médio de execução em ms requests: type: integer format: int64 description: Total de Requisições requestsFail: type: integer format: int64 description: Número de requisições com falhas lastEvent: type: object allOf: – #/definitions/datasourceEvent description: Último evento registrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista informações sobre as requisições de datasource tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataSource description: nome do datasource in: query required: true type: string responses: 200: description: Ok schema: type: object required: – averageTime – requests – requestsFail properties: averageTime: type: integer format: int64 description: Tempo médio de execução em ms requests: type: integer format: int64 description: Total de Requisições requestsFail: type: integer format: int64 description: Número de requisições com falhas lastEvent: type: object allOf: – #/definitions/datasourceEvent description: Último evento registrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/existEntity: post: description: Existe Entity tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Identificador unico do formulário responses: 200: description: Ok schema: type: object required: – exist properties: exist: type: boolean description: Indica se o formulário existe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Existe Entity tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Identificador unico do formulário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – exist properties: exist: type: boolean description: Indica se o formulário existe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/validateFormRuleCondition: post: description: Primitiva para verificar se a condição de uma regra é válida – Deprecada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – condition properties: condition: type: string description: Condição configurada responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Se a condição configurada é válida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva para verificar se a condição de uma regra é válida – Deprecada. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: condition description: Condição configurada in: query required: true type: string responses: 200: description: Ok schema: type: object required: – valid properties: valid: type: boolean description: Se a condição configurada é válida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/requestFieldAttachmentUpload: post: description: Retorna dados para upload de um arquivo em um campo do tipo anexo. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName – fileSize properties: fileName: type: string description: Nome do arquivo fileSize: type: integer format: int64 description: Tamanho do arquivo responses: 200: description: Ok schema: type: object required: – uploadUrl – fieldValue properties: uploadUrl: type: string description: Url para realizar o upload do arquivo fieldValue: type: string description: Valor para atribuir ao campo quando o upload for realizado com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna dados para upload de um arquivo em um campo do tipo anexo. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: fileName description: Nome do arquivo in: query required: true type: string – name: fileSize description: Tamanho do arquivo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – uploadUrl – fieldValue properties: uploadUrl: type: string description: Url para realizar o upload do arquivo fieldValue: type: string description: Valor para atribuir ao campo quando o upload for realizado com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/requestFieldAttachmentDownload: post: description: Retorna dados para o download de um arquivo em um campo do tipo anexo. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – fieldName properties: entityName: type: string description: Nome da entidade recordId: type: integer format: int64 description: Id do registro fieldName: type: string description: Nome do campo processInstanceId: type: integer format: int64 description: Identificador da Instância de Processo BPM timeToLive: type: integer format: int64 description: Tempo de vida do link default: 300 responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url de download do documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna dados para o download de um arquivo em um campo do tipo anexo. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: recordId description: Id do registro in: query type: integer format: int64 – name: fieldName description: Nome do campo in: query required: true type: string – name: processInstanceId description: Identificador da Instância de Processo BPM in: query type: integer format: int64 – name: timeToLive description: Tempo de vida do link in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url de download do documento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getFormData: post: description: Retorna dados de formulários para o frontend tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – recordId properties: entityName: type: string description: Nome da entidade recordId: type: integer format: int64 description: ID Registro responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: string format: byte description: Retorno dos valores dos campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna dados de formulários para o frontend tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: recordId description: ID Registro in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: string format: byte description: Retorno dos valores dos campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getFormFatherField: post: description: Retorna o pai de um filho tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fieldName – entityName properties: fieldName: type: string description: Nome do field entityName: type: string description: Nome da entidade responses: 200: description: Ok schema: type: object required: – fieldName properties: fieldName: type: string description: Retorna o nome do campo pai relacionado ao filho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o pai de um filho tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fieldName description: Nome do field in: query required: true type: string – name: entityName description: Nome da entidade in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fieldName properties: fieldName: type: string description: Retorna o nome do campo pai relacionado ao filho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getConectorInputConfigurationValue: post: description: Obter valores de configurações do conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – conectorId – conectorConfigurationId – datasourceId – formName – formItemName properties: conectorId: type: string description: Id do conector conectorConfigurationId: type: string description: Id da configuração datasourceId: type: integer format: int64 description: Id do datasoure formName: type: string description: Nome do formulário formItemName: type: string description: Nome do campo do formulário responses: 200: description: Ok schema: type: object required: – configurationValues properties: configurationValues: type: array items: type: object allOf: – #/definitions/conectorInputConfigurationValue minimum: 1 description: Dados da configuração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter valores de configurações do conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: conectorId description: Id do conector in: query required: true type: string – name: conectorConfigurationId description: Id da configuração in: query required: true type: string – name: datasourceId description: Id do datasoure in: query required: true type: integer format: int64 – name: formName description: Nome do formulário in: query required: true type: string – name: formItemName description: Nome do campo do formulário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – configurationValues properties: configurationValues: type: array items: type: object allOf: – #/definitions/conectorInputConfigurationValue minimum: 1 description: Dados da configuração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getUseNewFormFlag: post: description: Retorna a preferência de querer ou não utilizar o novo formulário, caso esteja criando um novo formulário e o entityName seja null é retornado a ultima escolha tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: entityName: type: string description: Nome do Formulário responses: 200: description: Ok schema: type: object required: – useNewForm properties: useNewForm: type: boolean description: Flag que controla se quer ou não utilizar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a preferência de querer ou não utilizar o novo formulário, caso esteja criando um novo formulário e o entityName seja null é retornado a ultima escolha tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome do Formulário in: query type: string responses: 200: description: Ok schema: type: object required: – useNewForm properties: useNewForm: type: boolean description: Flag que controla se quer ou não utilizar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDeletedFieldsNameLinkedToRules: post: description: Retorna o nome de campos que foram deletados do form e que ainda estão vinculado a regras de consistência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – entityVersion properties: entityName: type: string description: Nome da entidade entityVersion: type: integer format: int64 description: Versão do formulário responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: string minimum: 1 description: Nome dos campos deletados e vinculados a regras de consistência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o nome de campos que foram deletados do form e que ainda estão vinculado a regras de consistência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: entityVersion description: Versão do formulário in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: string minimum: 1 description: Nome dos campos deletados e vinculados a regras de consistência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/exportFormRule: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/exportRuleAction: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/exportRuleField: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/exportCalculation: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/exportCalculationField: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/exportDatasourceEvent: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/exportFeatureToggle: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/exportTableImportEvent: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/createRecord: post: description: Cria um registro em uma entidade do ECM tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – data properties: entityName: type: string description: Nome da Entidade processInstanceId: type: integer format: int64 description: Identificador da Instância de Processo BPM data: type: string description: Estrutura de Dados com os valores dos atributos responses: 200: description: Ok schema: type: object required: – recordId properties: recordId: type: integer format: int64 description: ID Registro Criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/deleteRecord: post: description: Remove um registro em uma entidade do ECM tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – recordId properties: entityName: type: string description: Nome da Entidade recordId: type: integer format: int64 description: ID Registro para remoção responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica se removeu o registro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/publishForm: post: description: Salva uma nova definição de formulários e seus campos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – title properties: name: type: string description: Identificar unico do formulário type: string description: Titulo do formulário fields: type: array items: type: object allOf: – #/definitions/fieldDef description: Campos do formulário formSections: type: array items: type: object allOf: – #/definitions/formSection description: Seções do formulário internal: type: boolean description: Indica que o formulário é interno. Não aparece na lista de formulários do ECM para edição formLayout: type: string description: Definições layout tela formRules: type: array items: type: object allOf: – #/definitions/formRuleRec description: Regras do formulário type: integer format: int64 description: Opcionalmente pode definir qual deve ser a versão do formulário incrementVersion: type: boolean description: Indica opcionalmente que a versão do formulário deve ser incrementada allowExternalUse: type: boolean description: Indica se formulário pode ser usado em Widget de Crud responses: 200: description: Ok schema: type: object required: – status – version properties: status: type: boolean description: Se foi publica do sucesso retorna true, caso contrario retorna false type: integer format: int64 description: Versão do Formulário Publicado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/saveFormContent: post: description: Salva o conteúdo de um formulário. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: identificador da base responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: retorna true caso os conteúdos de testes foram criados com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/saveAttributeValue: post: description: Salva os campos do formulário ECM tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId – formContent – entityName properties: processInstanceId: type: integer format: int64 description: identificador da instância do processo do workflow G6 formContent: type: string format: byte description: conteudo do form entityName: type: string description: conteudo do form responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/responseWorkflowPendency: post: description: Envia uma resposta para o workflow quando tiver integração. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – flowToken – seniorToken properties: flowToken: type: string description: Identificador da pendência seniorToken: type: string description: Token de autenticação do serviço responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: Retorna status true quando sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/startWorkflowProcess: post: description: Chamar o serviço do workflow G6 capaz iniciar um processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processName – seniorToken properties: processName: type: string description: Nome do processo a ser iniciado seniorToken: type: string description: Token de autenticação do serviço responses: 200: description: Ok schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: identificador da instância do processo do workflow G6 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/getWorkflowIntegrationData: post: description: Retorna os dados necessários para integração com o workflow G6. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – integrationToken properties: integrationToken: type: string description: identificador do processo de workflow. responses: 200: description: Ok schema: type: object required: – seniorToken – flowToken – processName – isHomeScreen properties: seniorToken: type: string description: Token Senior G5 flowToken: type: string description: Token do Tarefa do Workflow processInstanceId: type: integer format: int64 description: Instancia de Processo processName: type: string description: Nome do Processo isHomeScreen: type: boolean description: Indica se é uma tela inicial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/getRecordIdByWorkflowProcessId: post: description: Retorna o identificador de um registro do formulário utilizando a instância do processo no caso de integração. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – processInstanceId properties: entityName: type: string description: nome da entidade processInstanceId: type: integer format: int64 description: identificador do processo de workflow. responses: 200: description: Ok schema: type: object required: – recordId properties: recordId: type: integer format: int64 description: Identificador do registro do formulário. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/addEntity: post: description: Adiciona uma entidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – title – type – attributes properties: name: type: string maxLength: 80 description: Nome da Entidade type: string maxLength: 100 description: Título da Entidade type: type: string allOf: – #/definitions/entityType description: Tipo de Entidade attributes: type: array items: type: object allOf: – #/definitions/attributeDef minimum: 1 description: Atributos da Entidade fields: type: array items: type: object allOf: – #/definitions/fieldDef description: Lista de campos responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador da Entidade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/deleteEntity: post: description: Remover uma entidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador da Entidade responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/updateEntity: post: description: Atualiza uma entidade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: object allOf: – #/definitions/entityDef description: Entidade a ser alterada fields: type: array items: type: object allOf: – #/definitions/fieldDef description: Lista de campos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/addDataSource: post: description: Adiciona um datasource tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – format – filterSupport – fields properties: name: type: string maxLength: 50 description: Nome do Data Source format: type: string allOf: – #/definitions/datasourceFormat description: Formato JSON ou TABELA dataUrl: type: string maxLength: 255 description: URL da fonte de dados jsonRootElement: type: string maxLength: 50 description: Elemento razi quando formato JSON entityName: type: string description: Nome da Entidade quando formato TABLE filterSupport: type: boolean description: Indica se suporta filtro no serviço fields: type: array items: type: object allOf: – #/definitions/dataSourceField minimum: 1 description: Campos do Data Source conectorId: type: string description: Id do conector configurado como fonte externa conectorVersionId: type: string description: Id da versão do conector configurado como fonte externa conectorConfigurationId: type: string description: Id da configuração do conector responses: 200: description: Ok schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do datasource criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/deleteDataSource: post: description: Remover um datasource tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Identificador do DataSource para remover responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/updateEnableCacheDataSource: post: description: Atualiza a propriedade enableCache de um dataSource tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataSource – enableCache properties: dataSource: type: string description: nome do datasource enableCache: type: boolean description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/updateDataSource: post: description: Atualiza um data Source tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataSource properties: dataSource: type: object allOf: – #/definitions/dataSource description: Objeto datasource a ser atualizado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/commitAttachmentFile: post: description: Commita o arquivo enviado tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fileName – version – targetObject properties: fileName: type: string description: Nome do arquivo type: string description: Versão do arquivo targetObject: type: string description: Identificador único do arquivo responses: 200: description: Ok schema: type: object required: – targetObject properties: targetObject: type: string description: Identificador único do arquivo name: type: string description: Nome do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/exportTableFields: post: description: Exporta os campos de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName properties: entityName: type: string description: Nome da entidade responses: 200: description: Ok schema: type: object required: – entityName – fileId properties: entityName: type: string description: Nome da entidade fileId: type: string description: Id do arquivo importado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importRecordsTable: post: description: Importa os registros de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – fileURL – delimiter – firstLineWithHeaders properties: entityName: type: string description: Nome da entidade fileURL: type: string description: uri para download do arquivo delimiter: type: string description: Delimitador de campos firstLineWithHeaders: type: boolean description: Primeira linha contém headers fileId: type: string description: ID do arquivo no blob service fileName: type: string description: nome do arquivo no blob service responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de registros importados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importTableFields: post: description: Importa os campos de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – fileId – fileName – delimiter – firstLineWithHeaders properties: entityName: type: string description: Nome da entidade fileId: type: string description: ID do arquivo no blob service fileName: type: string description: nome do arquivo no blob service delimiter: type: string description: Delimitador de campos firstLineWithHeaders: type: boolean description: Primeira linha contém headers fields: type: array items: type: object allOf: – #/definitions/attributeDef description: Campos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/migrateInternalForm: post: description: Migra Formulário de tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName properties: entityName: type: string description: Nome da entidade responses: 200: description: Ok schema: type: object required: – version properties: type: integer format: int64 description: Versão do Formulário Publicado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/saveConectorInputConfigurationValue: post: description: Salva valor de configuração do conector tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – configurationValues properties: configurationValues: type: array items: type: object allOf: – #/definitions/conectorInputConfigurationValue minimum: 1 description: Dados da configuração responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/changeUseNewFormFlag: post: description: Altera se usuário quer utilizar o novo formulário ou o antigo em tal Formulário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – useNewForm properties: entityName: type: string description: Nome do Formulário useNewForm: type: boolean description: Flag que controla se quer ou não utilizar responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/deleteDatasourceByConectorConfigurationId: post: description: Deleta uma fonte de dados pelo ID da configuração do conector tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – conectorConfigurationId properties: conectorConfigurationId: type: string description: Id da configuração do conector responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importFormRule: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importRuleAction: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importRuleField: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importCalculation: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importCalculationField: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importDatasourceEvent: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importFeatureToggle: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/actions/importTableImportEvent: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/formRule: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/formRule responses: 200: description: The created resource schema: #/definitions/formRule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/formRule responses: 200: description: The created resource schema: #/definitions/formRule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/formRule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/formRule/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/formRule responses: 200: description: Ok schema: #/definitions/formRule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/formRule responses: 200: description: Ok schema: #/definitions/formRule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/formRule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/formRule/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/formRule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/ruleAction: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ruleAction responses: 200: description: The created resource schema: #/definitions/ruleAction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ruleAction responses: 200: description: The created resource schema: #/definitions/ruleAction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/ruleAction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/ruleAction/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ruleAction responses: 200: description: Ok schema: #/definitions/ruleAction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ruleAction responses: 200: description: Ok schema: #/definitions/ruleAction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ruleAction 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/ruleAction/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ruleAction responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/ruleField: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ruleField responses: 200: description: The created resource schema: #/definitions/ruleField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ruleField responses: 200: description: The created resource schema: #/definitions/ruleField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/ruleField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/ruleField/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ruleField responses: 200: description: Ok schema: #/definitions/ruleField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ruleField responses: 200: description: Ok schema: #/definitions/ruleField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ruleField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/ruleField/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ruleField responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/calculation: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/calculation responses: 200: description: The created resource schema: #/definitions/calculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/calculation responses: 200: description: The created resource schema: #/definitions/calculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/calculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/calculation/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calculation responses: 200: description: Ok schema: #/definitions/calculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calculation responses: 200: description: Ok schema: #/definitions/calculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/calculation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/calculation/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/calculation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/calculationField: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/calculationField responses: 200: description: The created resource schema: #/definitions/calculationField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/calculationField responses: 200: description: The created resource schema: #/definitions/calculationField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/calculationField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/calculationField/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calculationField responses: 200: description: Ok schema: #/definitions/calculationField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calculationField responses: 200: description: Ok schema: #/definitions/calculationField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/calculationField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/calculationField/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/calculationField responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/datasourceEvent: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/datasourceEvent responses: 200: description: The created resource schema: #/definitions/datasourceEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/datasourceEvent responses: 200: description: The created resource schema: #/definitions/datasourceEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/datasourceEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/datasourceEvent/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/datasourceEvent responses: 200: description: Ok schema: #/definitions/datasourceEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/datasourceEvent responses: 200: description: Ok schema: #/definitions/datasourceEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/datasourceEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/datasourceEvent/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/datasourceEvent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/featureToggle: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/featureToggle responses: 200: description: The created resource schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/featureToggle responses: 200: description: The created resource schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/featureToggle/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/featureToggle responses: 200: description: Ok schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/featureToggle responses: 200: description: Ok schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/featureToggle/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/featureToggle responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/tableImportEvent: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tableImportEvent responses: 200: description: The created resource schema: #/definitions/tableImportEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tableImportEvent responses: 200: description: The created resource schema: #/definitions/tableImportEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tableImportEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/tableImportEvent/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tableImportEvent responses: 200: description: Ok schema: #/definitions/tableImportEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tableImportEvent responses: 200: description: Ok schema: #/definitions/tableImportEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tableImportEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ecm_form/entities/tableImportEvent/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tableImportEvent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: orderDirection: description: Informa o tipo de ordenação type: string enum: – ASC – DESC listMethodDataSource: description: Metodo de listagem de datasources type: string enum: – ALL – OnlyDataSource – OnlyConector fieldTypeDef: description: Tipo de campo. type: string enum: – Boolean – Integer – String – Double – Date – List – TextArea – Attachment – Link – Array dataSourceFieldTypeDef: description: Tipo de campo. type: string enum: – Boolean – Integer – String – Double – Date datasourceFormat: description: Tipo de campo. type: string enum: – JSON – TABLE entityType: description: Tipo de Entidade type: string enum: – FORM – TABLE dataSourceType: description: Tipo do data source configurado type: string enum: – Query – Resulting formRuleAction: description: Ação a ser realizada pela regra type: string enum: – DISABLE_FIELDS – ENABLE_FIELDS – HIDE_FIELDS – MAKE_FIELDS_VISIBLE – MAKE_FIELDS_REQUIRED – MAKE_FIELDS_CONSISTENCE formRuleTriggerType: description: Tipo de gatilho para a regra type: string enum: – ON_START – ON_FIELD_EXIT – ON_SUBMIT upDown: description: Up or down type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR viewFormLogs: description: Visualizar mudanças no formulário type: object required: – author – previousJson – currentJson properties: author: type: string description: Autor da mudanca do formulario previousJson: type: string description: JSON anterior currentJson: type: string description: JSON atual formVersions: description: Versões de um Fromulário type: object required: – name – versions properties: name: type: string description: Nome do formulário versions: type: array items: type: integer format: int64 minimum: 1 description: Versões do formulário formDef: description: Form definition. type: object required: – formId – entityId – author – folder – lastVersion – internal properties: formId: type: string description: identificador do formulário. entityId: type: string description: identificador da entidade. author: type: string description: Criado do Formulário. folder: type: string description: Caminho do Menu para o formulário. lastVersion: type: integer format: int64 description: ùltima versão publicada do formulário internal: type: boolean description: Formulários internos não aparece para edição na lista do ECM allowExternalUse: type: boolean description: Indica se formulário permite uso externo formListDef: description: Definição de um formulário para listagem type: object required: – formName – entityName – author – lastVersion – internal properties: formName: type: string description: identificador do formulário. entityName: type: string description: identificador da entidade. author: type: string description: Criado do Formulário. lastVersion: type: integer format: int64 description: ùltima versão publicada do formulário internal: type: boolean description: Formulários internos não aparece para edição na lista do ECM allowExternalUse: type: boolean description: Indica se formulário permite uso externo entityDef: description: Entidade type: object required: – id – name – title – type – attributes properties: id: type: integer format: int64 description: Id da Entidade name: type: string maxLength: 80 description: Nome da Entidade type: string maxLength: 100 description: Título da Entidade type: type: string allOf: – #/definitions/entityType description: Tipo de Entidade attributes: type: array items: type: object allOf: – #/definitions/attributeDef minimum: 1 description: Atributos da Entidade attributeDef: description: Atributo da Entidade type: object required: – name – type properties: name: type: string maxLength: 80 description: Nome do Campo type: type: string allOf: – #/definitions/fieldTypeDef description: Tipo do campo. fatherId: type: integer format: int64 description: Id do pai fieldDef: description: Field definition. type: object required: – name – type – label – size – order – required properties: name: type: string description: Nome do Campo type: type: string allOf: – #/definitions/fieldTypeDef description: Tipo do campo. section: type: string description: Indica a seção que o campo faz parte quando os campos estiverem agrupados por seção label: type: string description: Rótulo do campo. size: type: string description: Tamanho do campo order: type: integer format: int64 description: Ordem do campo. multipleSelect: type: boolean description: Indica se o campo lista é de seleção múltipla items: type: array items: type: object allOf: – #/definitions/fieldItem description: Items a serem exibidos no combobox required: type: boolean description: Campo Obrigatório. validationRegex: type: string description: Expressão regular de validação. tooltip: type: string description: Dica. mask: type: string description: Máscara. datasource: type: object allOf: – #/definitions/dataSourceConfig description: Datasource appWorkflow: type: boolean description: Indique que a informação do vampo vai para o Aplicativo Workflow 2.0 isBreakLine: type: boolean description: Indica que o campo é um campo quebra linha calculationConfig: type: object allOf: – #/definitions/calculationConfig description: Cálculo para o valor do campo allowDatagridView: type: boolean description: Indica se campo será exibido na listagem de registros fatherName: type: string description: Utilizados em lista de objetos para referenciar quem é o pai deste campo defaultValue: type: string description: Valor default utilizado no formulário attachmentPrefix: type: string description: Prefixo do anexo isCurrentDateDefault: type: boolean description: Valor que indica o default value de uma data como o dia atual default: false dateFormat: type: string maxLength: 26 description: Formato da data a ser enviado no payload do formulário (caso o campo seja do tipo data) formSection: description: Seção do formulário type: object required: – name – sectionOrder properties: name: type: string description: Nome da seção sectionOrder: type: integer format: int64 description: Define a ordem de exibição da seção dentro de um formulário calculationConfig: description: Configuração do cálculo type: object required: – calculation properties: calculation: type: string maxLength: 5000 description: Cálculo definido triggerFields: type: array items: type: string description: Campos que acionarão o cálculo fieldData: description: Representação dos dados de um campo de formulário type: object required: – name properties: name: type: string description: Nome do campo value: type: string description: Valor do campo arraysValue: type: array items: type: object allOf: – #/definitions/fieldData description: Valor dos campos Lista de objetos fieldItem: description: Items a serem inseridos no campo type: object required: – value properties: value: type: string description: Valor para um item campo tipo lista dataSource: description: Fonte de Dados Externa type: object required: – id – name – format – dataUrl – filterSupport – fields properties: id: type: integer format: int64 description: Identificador Gerador da Fonte de Dados name: type: string maxLength: 50 description: Nome da Fonte de Dados description: type: string description: Descrição resumida da fonte de dados format: type: string allOf: – #/definitions/datasourceFormat description: Formato da Fonte de Dados dataUrl: type: string maxLength: 255 description: URL da Fonte de Dados jsonRootElement: type: string maxLength: 50 description: Elemento raiz dos datasource formato json entityName: type: string description: Nome da Entidade quando o datasource tem o formato TABLE filterSupport: type: boolean description: Indica se o serviço implementa suporte a filtro fields: type: array items: type: object allOf: – #/definitions/dataSourceField minimum: 1 description: Campos da Fonte de Dados enableCache: type: boolean description: Indica se o cache da fonte de dados será habilitado conectorId: type: string description: Id do conector configurado como fonte externa conectorVersionId: type: string description: Id da versão do conector configurado como fonte externa conectorConfigurationId: type: string description: Id da configuração do conector dataSourceField: description: Campos da Fonte de Dados Externa type: object required: – name – description – type properties: name: type: string maxLength: 255 description: Nome do Campo da Fonte de Dados description: type: string maxLength: 255 description: Descrição do Campo que aparece na tela type: type: string allOf: – #/definitions/dataSourceFieldTypeDef description: Tipo de Dado do Campo fieldOrder: type: integer format: int64 description: order do campo na apresentação visible: type: boolean description: Visibilidade do campo default: true dataSourceTemplate: description: Template de DataSource type: object required: – name – description properties: name: type: string description: Nome do DataSourceTemplate description: type: string description: Descrição do Template dataSourceConfig: description: Configuração de um data source no campo type: object required: – type – config properties: type: type: string allOf: – #/definitions/dataSourceType description: Tipo de Data Source config: type: string description: Configuração do Data Source queryDataSourceFilter: description: Filtro definido na configuração do datasource em um campo do formulário type: object required: – fieldName – operator – value properties: fieldName: type: string description: Nome do Campo a ser filtrado operator: type: string description: Operação a ser realizada do filtro (eq, ne, lt, le, gt, ge) value: type: string description: Valor a ser filtrada logicalOperator: type: string description: Operador lógico para o filtro (and, or) openingOrder: type: string description: Abertura de Chave por Ordem closingOrder: type: string description: Fechamento de Chave por Ordem attachmentValue: description: Valor do campo anexo salvo no ECM type: object required: – targetObjectId – fileName – fileSize – version properties: targetObjectId: type: string description: Id do objeto no blob service fileName: type: string description: Nome do arquivo fileSize: type: integer format: int64 description: Tamanho do arquivo type: string description: Versão do arquivo formRuleRec: description: Representação de uma regra de formulário type: object required: – triggerType – actions – enabled properties: triggerType: type: string allOf: – #/definitions/formRuleTriggerType description: Tipo do gatilho triggerFields: type: array items: type: string description: Campos a ser utilizado pelo gatilho (opcional) condition: type: string description: Condição para acionar a regra actions: type: array items: type: object allOf: – #/definitions/ruleActionRec minimum: 1 description: Configurações da regra enabled: type: boolean description: Se a regra esta habilitada ruleActionRec: description: type: object required: – type – fields properties: type: type: string allOf: – #/definitions/formRuleAction description: Ação a ser realizada message: type: string description: Mensagem a ser exibida quando for realizada a consistência fields: type: array items: type: string minimum: 1 description: Campos a ser afetados pela ação checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck conectorConfigured: description: Record para informar se o conector está configurado type: object required: – conectorId – configured properties: conectorId: type: string description: ID do conector configured: type: boolean description: Se está configurado conectorInputConfigurationValue: description: Valores dos campos de conector configurável type: object required: – conectorId – conectorConfigurationId – datasourceId – formName – formItemName – field properties: id: type: string description: Identificador conectorId: type: string description: Id do conector conectorConfigurationId: type: string description: Id da configuração datasourceId: type: integer format: int64 description: Id do datasoure formName: type: string description: Nome do formulário formItemName: type: string description: Nome do campo do formulário field: type: string description: Campo value: type: string description: Valor do campo formRule: description: Regras do formulário type: object required: – formId – formVersion – triggerType – condition – actions – enabled properties: id: type: string format: uuid description: Identificador da regra formId: type: integer format: int64 description: Identificador único do formulário formVersion: type: integer format: int64 description: Versão do formulário triggerType: type: string allOf: – #/definitions/formRuleTriggerType description: Tipo do gatilho triggerFields: type: array items: type: object allOf: – #/definitions/ruleField description: Campos a ser utilizado pelo gatilho (opcional) condition: type: string description: Condição para acionar a regra actions: type: array items: type: object allOf: – #/definitions/ruleAction minimum: 1 description: Configurações da regra enabled: type: boolean description: Se a regra está habilitada ruleAction: description: Configuração da regra do formulario type: object required: – type – fields properties: id: type: string format: uuid description: Identificador da ação da regra type: type: string allOf: – #/definitions/formRuleAction description: Ação a ser realizada message: type: string description: Mensagem a ser exibida quando for realizada a consistência fields: type: array items: type: object allOf: – #/definitions/ruleField minimum: 1 description: Campos a ser afetados pela ação ruleField: description: Campos configurados em uma entidade type: object required: – name properties: id: type: string format: uuid description: name: type: string description: calculation: description: Campos configurados em uma entidade type: object required: – calculation properties: id: type: string format: uuid description: Identificador do cálculo calculation: type: string maxLength: 5000 description: Cálculo a ser executado triggerFields: type: array items: type: object allOf: – #/definitions/calculationField description: Campos que estão configurados no cálculo calculationField: description: Campo configurado em um cálculo type: object required: – name properties: id: type: string format: uuid description: name: type: string description: datasourceEvent: description: Eventos de consultas a Fonte de Dados type: object required: – name – created – createdBy – statusCode – requestTime – requestUrl properties: id: type: string format: uuid description: Identificador name: type: string description: Nome da Fonte de Dados created: type: string format: date-time description: Data da Execução createdBy: type: string maxLength: 255 description: Usuario que executou a requisicao statusCode: type: integer format: int64 description: Status Http requestTime: type: integer format: int64 description: Tempo da Execução em milisegundos requestUrl: type: string maxLength: 512 description: URL da requisição log: type: string maxLength: 2048 description: Log da Execucao featureToggle: description: Configurações do sistema que permitem type: object required: – feature – enable properties: id: type: string format: uuid description: Identificador feature: type: string description: Nome da Funcionalidade enable: type: boolean description: Indica se a funcionalidade esta habilitada tableImportEvent: description: Eventos de importação tabelas para Fonte de Dados type: object required: – tableName – created – createdBy – fileName – requestTime properties: id: type: string format: uuid description: Identificador tableName: type: string description: Nome da Tabela created: type: string format: date-time description: Data da Execução createdBy: type: string maxLength: 255 description: Usuario que executou a requisicao fileName: type: string maxLength: 512 description: Nome do Arquivos Importado requestTime: type: integer format: int64 description: Tempo da Execução em milisegundos fileId: type: string maxLength: 512 description: Identificador do arquivo no repositório blob service recordsCount: type: integer format: int64 description: Total de Registros Importados fileSize: type: integer format: int64 description: Tamanho do arquivo log: type: string maxLength: 2048 description: Log da Execucao statusCode: type: integer format: int64 description: Status code notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE