2.0info: 1.2.4 bpm_form description: Serviço do BPM para gerenciamento de formulários x-senior-domain: flow x-senior-domain-path: flow x-senior-service-path: bpm_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/flowsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /bpm_form/queries/healthcheck: post: description: Status sobre o status do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Status sobre o status do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/getFormFieldArrayMaxLevels: post: description: Obtém o nível máximo de aninhamento para campos do tipo array tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – maxLevels properties: maxLevels: type: integer format: int64 description: Nível máximo de aninhamento para campos do tipo array 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o nível máximo de aninhamento para campos do tipo array tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – maxLevels properties: maxLevels: type: integer format: int64 description: Nível máximo de aninhamento para campos do tipo array 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/getFormIoSchema: post: description: Obtém o JSON de configuração do Form.io na versão especificada ou, caso não seja informada, na última versão disponível tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId properties: formId: type: string description: Id do formulário formVersion: type: integer format: int64 description: Versão do formulário minimum: 1 responses: 200: description: Ok schema: type: object required: – formMetadata properties: formMetadata: type: string format: byte description: Json com as configurações do formulário definidas pelo form.io 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o JSON de configuração do Form.io na versão especificada ou, caso não seja informada, na última versão disponível tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formId description: Id do formulário in: query required: true type: string – name: formVersion description: Versão do formulário in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – formMetadata properties: formMetadata: type: string format: byte description: Json com as configurações do formulário definidas pelo form.io 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/loadFormExternalByFormId: post: description: Obter formulário externalizado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId properties: formId: type: string description: Id do formulário responses: 200: description: Ok schema: type: object required: – formExternal properties: formExternal: type: object allOf: – #/definitions/formExternalDto description: Formulário externalizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter formulário externalizado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formId description: Id do formulário in: query required: true type: string responses: 200: description: Ok schema: type: object required: – formExternal properties: formExternal: type: object allOf: – #/definitions/formExternalDto description: Formulário externalizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/getLegacyForm: post: description: Obter formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formName properties: formName: type: string description: Nome do formulário formVersion: type: integer format: int64 description: Versão do formulário responses: 200: description: Ok schema: type: object required: – form properties: form: type: object allOf: – #/definitions/getFormPayload description: Formulário retornado com metadados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formName description: Nome do formulário in: query required: true type: string – name: formVersion description: Versão do formulário in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – form properties: form: type: object allOf: – #/definitions/getFormPayload description: Formulário retornado com metadados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/getFormFields: post: description: Obtém todos os campos e seus relacionamentos na versão especificada do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId – formVersion properties: formId: type: string description: Id do formulário formVersion: type: integer format: int64 description: Versão do formulário minimum: 1 responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/formFieldHierarchyDto minimum: 1 description: Lista completa de campos, com vínculos entre pais e filhos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém todos os campos e seus relacionamentos na versão especificada do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formId description: Id do formulário in: query required: true type: string – name: formVersion 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: object allOf: – #/definitions/formFieldHierarchyDto minimum: 1 description: Lista completa de campos, com vínculos entre pais e filhos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/getData: post: description: Obtém dados das tabelas customizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formName properties: formName: type: string description: Nome do formulário filters: type: array items: type: object allOf: – #/definitions/filterDto description: Nome do formulário page: type: integer format: int64 description: Página da consulta minimum: 0 default: 0 size: type: integer format: int64 description: Quantidade de linhas da consulta minimum: 1 maximum: 100 default: 10 searchSubtable: type: boolean description: Flag para definir se deve pesquisar as subtabelas default: false 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: string format: byte description: Dados das tabelas customizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/exportFormData: post: description: Exporta os dados das tabelas customizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formName – selectedColumns properties: formName: type: string description: Nome do formulário selectedColumns: type: string description: Colunas selecionadas para exportação responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: string format: byte description: Dados das tabelas customizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Exporta os dados das tabelas customizadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formName description: Nome do formulário in: query required: true type: string – name: selectedColumns description: Colunas selecionadas para exportação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: string format: byte description: Dados das tabelas customizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/listRoles: post: description: Endpoint para consulta dos papéis do tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pagination properties: searchValue: type: string description: Campo para busca de um determinado papel pagination: type: object allOf: – #/definitions/rolesPagination description: Paginação dos papéis responses: 200: description: Ok schema: type: object required: – roles – totalRecords – totalPages properties: roles: type: array items: type: object allOf: – #/definitions/tenantRole minimum: 1 description: totalRecords: type: integer format: int64 description: totalPages: type: integer format: int64 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/getPermissionsByFormCustomResource: post: description: Endpoint para consultar permissões e recursos autorizados do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId – role – resourceType properties: formId: type: string description: Identificador do formulário para consulta das permissões autorizadas do usuário role: type: string description: Papel do usuário para consulta das permissões autorizadas do usuário resourceType: type: string allOf: – #/definitions/permissionResourceType description: Tipo do recurso de permissão a ser consultado responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: string minimum: 1 description: Lista de permissões autorizadas do usuário para o recurso consultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para consultar permissões e recursos autorizados do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: formId description: Identificador do formulário para consulta das permissões autorizadas do usuário in: query required: true type: string – name: role description: Papel do usuário para consulta das permissões autorizadas do usuário in: query required: true type: string – name: resourceType description: Tipo do recurso de permissão a ser consultado in: query required: true type: string allOf: – #/definitions/permissionResourceType responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: string minimum: 1 description: Lista de permissões autorizadas do usuário para o recurso consultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/queries/getExternalForm: post: description: Obtém o URI do formulário externo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashToken – type properties: hashToken: type: string maxLength: 255 description: Token hash gerado para acesso externo type: type: string allOf: – #/definitions/formSchemaType description: Tipo de externalização responses: 200: description: Ok schema: type: object required: – formName – formMetadata properties: formName: type: string description: Nome do formulário formMetadata: type: string format: byte description: Json com as configurações do formulário definidas pelo form.io default: description: Error response schema: #/definitions/genericError get: description: Obtém o URI do formulário externo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: hashToken description: Token hash gerado para acesso externo in: query required: true type: string maxLength: 255 – name: type description: Tipo de externalização in: query required: true type: string allOf: – #/definitions/formSchemaType responses: 200: description: Ok schema: type: object required: – formName – formMetadata properties: formName: type: string description: Nome do formulário formMetadata: type: string format: byte description: Json com as configurações do formulário definidas pelo form.io default: description: Error response schema: #/definitions/genericError /bpm_form/queries/listAcceptedOriginUrlByHashToken: post: description: Retorna uma lista de origens aceitas por um determinado hashToken tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashToken properties: hashToken: type: string maxLength: 255 description: Token hash gerado do formulário externalizado responses: 200: description: Ok schema: type: object required: – acceptedOriginUrlList properties: acceptedOriginUrlList: type: array items: type: string minimum: 1 description: Origens aceitas default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de origens aceitas por um determinado hashToken tags: – Queries x-senior-visibility: PRIVATE parameters: – name: hashToken description: Token hash gerado do formulário externalizado in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – acceptedOriginUrlList properties: acceptedOriginUrlList: type: array items: type: string minimum: 1 description: Origens aceitas default: description: Error response schema: #/definitions/genericError /bpm_form/queries/taskQueueErrorCount: post: description: Retorna o número de erros da taskqueue tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – errors – pending properties: errors: type: integer format: int64 description: pending: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError get: description: Retorna o número de erros da taskqueue tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – errors – pending properties: errors: type: integer format: int64 description: pending: type: integer format: int64 description: default: description: Error response schema: #/definitions/genericError /bpm_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 /bpm_form/queries/exportForm: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/exportFormVersion: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/exportFormVersionField: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/exportFormField: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/exportTableImportEvent: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/exportTableImportCache: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/exportFormIoSchema: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/exportFormExternal: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/exportAcceptedOrigin: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /bpm_form/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE 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: PRIVATE 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 /bpm_form/actions/getUploadFileUrl: post: description: Obtém a URL assinada para upload de um arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – uploadFileType properties: uploadFileType: type: string allOf: – #/definitions/uploadFileType description: Tipo de upload de arquivo folderPath: type: string maxLength: 59 description: Pasta do arquivo fileSize: type: integer format: int64 description: Tamanho do arquivo (em bytes) minimum: 1 fileId: type: string description: Id do arquivo fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – signedUrl – filePath – detail properties: signedUrl: type: string description: URL assinada para upload do arquivo filePath: type: string description: Path do arquivo detail: type: string format: byte description: Detalhes de retorno do serviço de blob 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/saveExternalFormToken: post: description: Cria um token do formulário externalizado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId – type – allowExternalUse properties: formId: type: string description: Id do formulário type: type: string allOf: – #/definitions/formSchemaType description: Tipo de externalização allowExternalUse: type: boolean description: Permitir uso externo acceptedOrigins: type: array items: type: object allOf: – #/definitions/keyValueDto description: Origens aceitas responses: 200: description: Ok schema: type: object required: – hashToken properties: hashToken: type: string description: Token hash gerado para acesso externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/restoreForm: post: description: Reativa um formulário excluído tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId properties: formId: type: string maxLength: 255 description: Id do formulário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/addData: post: description: Inserir dados na tabela customizada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId – formVersion – data properties: formId: type: string description: Id do formulário formVersion: type: integer format: int64 description: Versão do formulário taskId: type: integer format: int64 description: Id da tarefa caso seja origem BPM data: type: string format: byte description: Json com os dados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/removeData: post: description: Remover dados na tabela customizada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formName – id properties: formName: type: string description: Nome do formulário id: type: string description: Id do registro a ser removido responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/updateData: post: description: Atualizar dados na tabela customizada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formId – data properties: formId: type: string description: Id do formulário customTableId: type: string description: Id do dado da tabela customizada data: type: string format: byte description: Json com os dados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/dropCustomTable: post: description: Drop tabela customizada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tableName properties: tableName: type: string description: Nome da tabela customizada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/addExternalFormData: post: description: Registra dados no formulário via token hash tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashToken – data properties: hashToken: type: string maxLength: 255 description: Token hash gerado para acesso externo recaptchaToken: type: string description: Token do reCAPTCHA data: type: string format: byte description: Json com os dados responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /bpm_form/actions/getFileUploadUrlExternalForm: post: description: Obtém o URI do para upload de arquivo do formulário externo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashToken – uploadFileType properties: hashToken: type: string description: Token hash do formulário externo uploadFileType: type: string allOf: – #/definitions/uploadFileType description: Tipo de upload de arquivo folderPath: type: string maxLength: 50 description: Pasta do arquivo fileSize: type: integer format: int64 description: Tamanho do arquivo (em bytes) minimum: 1 fileId: type: string description: Id do arquivo fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – signedUrl – filePath – detail properties: signedUrl: type: string description: URL assinada para upload do arquivo filePath: type: string description: Path do arquivo detail: type: string format: byte description: Detalhes de retorno do serviço de blob default: description: Error response schema: #/definitions/genericError /bpm_form/actions/uploadFile: post: description: Realiza upload de arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName – fileUrl – uploadFileType properties: fileName: type: string description: Nome do arquivo fileUrl: type: string description: Url do arquivo folderPath: type: string description: Pasta para salvar o arquivo uploadFileType: type: string allOf: – #/definitions/uploadFileType description: Tipo de upload de arquivo responses: 200: description: Ok schema: type: object required: – ticketId properties: ticketId: type: string description: Ticket para consulta do status do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/uploadFileFormExternal: post: description: Realiza upload de arquivo para formulário externo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashToken – fileName – fileUrl – uploadFileType properties: hashToken: type: string maxLength: 255 description: Token hash gerado para acesso externo fileName: type: string description: Nome do arquivo fileUrl: type: string description: Url do arquivo folderPath: type: string description: Pasta para salvar o arquivo uploadFileType: type: string allOf: – #/definitions/uploadFileType description: Tipo de upload de arquivo responses: 200: description: Ok schema: type: object required: – ticketId properties: ticketId: type: string description: Ticket para consulta do status do arquivo default: description: Error response schema: #/definitions/genericError /bpm_form/actions/downloadFile: post: description: Realiza download do arquivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileName – ticketId – downloadFileType properties: fileName: type: string description: Nome do arquivo ticketId: type: string description: Ticket do arquivo para consulta downloadFileType: type: string allOf: – #/definitions/downloadFileType description: Tipo de download de arquivo responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url assinada para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/downloadFileFormExternal: post: description: Realiza download do arquivo no formulário externo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashToken – fileName – ticketId – downloadFileType properties: hashToken: type: string maxLength: 255 description: Token hash gerado para acesso externo fileName: type: string description: Nome do arquivo ticketId: type: string description: Ticket do arquivo para consulta downloadFileType: type: string allOf: – #/definitions/downloadFileType description: Tipo de download de arquivo responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url assinada para download do arquivo default: description: Error response schema: #/definitions/genericError /bpm_form/actions/integrateFormDataWithWorkflow: post: description: Primitiva para intermediar as chamadas do projeto BPM-FORM tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – bpmFormPrimitiveToCall properties: data: type: string format: byte description: Dados que serão passados para a primitiva bpmFormPrimitiveToCall: type: string allOf: – #/definitions/bpmFormPrimitives description: Nome da primitiva que será chamada taskId: type: integer format: int64 description: ID da tarefa responses: 200: description: Ok schema: type: object required: – result properties: result: type: string format: byte description: Retorno da primitiva chamada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/exportViewFormData: post: description: Exporta os dados das tabelas customizadas via visão dinâmica tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – formName properties: formName: type: string description: Nome do formulário responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/executeDataSourceIntegration: post: description: Realiza a integração com senior connect tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – payload properties: payload: type: object allOf: – #/definitions/workflowIntegrationDTO description: DTO para integração com workflow do connect responses: 200: description: Ok schema: type: object required: – response properties: response: type: string format: byte description: Resposta da integração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/executeExternalDataSourceIntegration: post: description: Realiza a integração com senior connect tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hashToken – payload properties: hashToken: type: string maxLength: 255 description: Hash do formulário externalizado payload: type: object allOf: – #/definitions/workflowIntegrationDTO description: DTO para integração com workflow do connect responses: 200: description: Ok schema: type: object required: – response properties: response: type: string format: byte description: Resposta da integração default: description: Error response schema: #/definitions/genericError /bpm_form/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/actions/importForm: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/actions/importFormVersion: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/actions/importFormVersionField: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/actions/importFormField: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/actions/importTableImportEvent: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/actions/importTableImportCache: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/actions/importFormIoSchema: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/actions/importFormExternal: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/actions/importAcceptedOrigin: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /bpm_form/signals/publishForm: post: description: Publica o formulário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – formName – formLabel – allowExternalUse – fileName – logHashId – formPublishType properties: formId: type: string description: Id do formulário formName: type: string maxLength: 50 description: Nome do formulário formLabel: type: string maxLength: 255 description: Descrição do formulário currentVersion: type: integer format: int64 description: Versão atual do formulário minimum: 1 allowExternalUse: type: boolean description: Permite uso externo fileId: type: string description: Id do arquivo json com as configurações do formulário fileName: type: string description: Nome do arquivo json com as configurações do formulário logHashId: type: string maxLength: 255 description: Hash para consulta do serviço de log formPublishType: type: string allOf: – #/definitions/formPublishType description: Tipo de publicação do formulário responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /bpm_form/events/formEventDispatcher: post: description: Notifica sobre eventos relacionados as entidades do form x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – resourceName – resourceId – eventType properties: resourceName: type: string maxLength: 255 description: Nome do recurso resourceId: type: string maxLength: 255 description: Id do recurso relacionado ao evento eventType: type: string maxLength: 255 description: Tipo do evento genérico content: type: string format: byte description: Conteúdo do evento triggeredBy: type: string maxLength: 255 description: Usuário que disparou o evento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importFormEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportFormEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importFormVersionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportFormVersionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importFormVersionFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportFormVersionFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importFormFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportFormFieldEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importTableImportEventEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportTableImportEventEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importTableImportCacheEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportTableImportCacheEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importFormIoSchemaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportFormIoSchemaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importFormExternalEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportFormExternalEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/importAcceptedOriginEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/events/exportAcceptedOriginEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /bpm_form/entities/form: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/form responses: 200: description: The created resource schema: #/definitions/form 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/form responses: 200: description: The created resource schema: #/definitions/form 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/form 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/form/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editForm responses: 200: description: Ok schema: #/definitions/editForm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/form responses: 200: description: Ok schema: #/definitions/form 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/form 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /bpm_form/entities/form/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/form responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/formField: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/formField responses: 200: description: The created resource schema: #/definitions/formField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/formField responses: 200: description: The created resource schema: #/definitions/formField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/formField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/formField/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFormField responses: 200: description: Ok schema: #/definitions/editFormField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/formField responses: 200: description: Ok schema: #/definitions/formField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/formField 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /bpm_form/entities/formField/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/formField responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/tableImportEvent: post: description: Esta entidade pode ser customizada. 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: description: Esta entidade pode ser customizada. 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: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tableImportEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/tableImportEvent/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTableImportEvent responses: 200: description: Ok schema: #/definitions/editTableImportEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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: description: Esta entidade pode ser customizada. 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: description: Esta entidade pode ser customizada. 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 /bpm_form/entities/tableImportEvent/bulk: post: description: Esta entidade pode ser customizada. 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 /bpm_form/entities/tableImportEvent/{parentId}/importCache: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/tableImportCache responses: 200: description: The created resources schema: type: array items: #/definitions/tableImportCache 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/tableImportCache responses: 200: description: The created resources schema: type: array items: #/definitions/tableImportCache 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tableImportCache 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/tableImportEvent/{parentId}/importCache/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTableImportCache responses: 200: description: Ok schema: #/definitions/editTableImportCache 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tableImportCache responses: 200: description: Ok schema: #/definitions/tableImportCache 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tableImportCache 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/formIoSchema: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/formIoSchema 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/formExternal: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/formExternal responses: 200: description: The created resource schema: #/definitions/formExternal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/formExternal responses: 200: description: The created resource schema: #/definitions/formExternal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/formExternal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/formExternal/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editFormExternal responses: 200: description: Ok schema: #/definitions/editFormExternal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/formExternal responses: 200: description: Ok schema: #/definitions/formExternal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/formExternal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /bpm_form/entities/formExternal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/formExternal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/acceptedOrigin: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/acceptedOrigin responses: 200: description: The created resource schema: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/acceptedOrigin responses: 200: description: The created resource schema: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/acceptedOrigin/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAcceptedOrigin responses: 200: description: Ok schema: #/definitions/editAcceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/acceptedOrigin responses: 200: description: Ok schema: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 /bpm_form/entities/formExternal/{parentId}/acceptedOrigins: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/acceptedOrigin responses: 200: description: The created resources schema: type: array items: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/acceptedOrigin responses: 200: description: The created resources schema: type: array items: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/formExternal/{parentId}/acceptedOrigins/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editAcceptedOrigin responses: 200: description: Ok schema: #/definitions/editAcceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/acceptedOrigin responses: 200: description: Ok schema: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/acceptedOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /bpm_form/entities/acceptedOrigin/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/acceptedOrigin responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckStatus: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Executando normalmente * `DOWN` – Com problemas formType: type: string enum: – WEB – FORM_IO – LEGACY description: Tipos de formulário: * `WEB` – Formulário WEB * `FORM_IO` – Formulário tipo Form.io * `LEGACY` – Formulário legado formEventType: type: string enum: – FORM_CREATED_SUCCESS – FORM_UPDATED_SUCCESS – FORM_DELETED_SUCCESS – FORM_CREATED_ERROR – FORM_UPDATED_ERROR – FORM_DELETED_ERROR description: Tipo de evento do formulário: * `FORM_CREATED_SUCCESS` – Formulário criado com sucesso * `FORM_UPDATED_SUCCESS` – Formulário atualizado com sucesso * `FORM_DELETED_SUCCESS` – Formulário excluído com sucesso * `FORM_CREATED_ERROR` – Erro ao criar formulário * `FORM_UPDATED_ERROR` – Erro ao atualizar formulário * `FORM_DELETED_ERROR` – Erro ao excluir formulário formFieldEventType: type: string enum: – FORM_FIELD_CREATED_SUCCESS – FORM_FIELD_UPDATED_SUCCESS – FORM_FIELD_DELETED_SUCCESS – FORM_FIELD_CREATED_ERROR – FORM_FIELD_UPDATED_ERROR – FORM_FIELD_DELETED_ERROR description: Tipo de evento do campo do formulário: * `FORM_FIELD_CREATED_SUCCESS` – Campo do formulário criado com sucesso * `FORM_FIELD_UPDATED_SUCCESS` – Campo do formulário atualizado com sucesso * `FORM_FIELD_DELETED_SUCCESS` – Campo do formulário excluído com sucesso * `FORM_FIELD_CREATED_ERROR` – Erro ao criar campo do formulário * `FORM_FIELD_UPDATED_ERROR` – Erro ao atualizar campo do formulário * `FORM_FIELD_DELETED_ERROR` – Erro ao excluir campo do formulário customTableEventType: type: string enum: – CUSTOM_TABLE_CREATED_SUCCESS – CUSTOM_TABLE_CREATED_ERROR – CUSTOM_TABLE_UPDATED_SUCCESS – CUSTOM_TABLE_UPDATED_ERROR – CUSTOM_SUBTABLE_CREATED_SUCCESS – CUSTOM_SUBTABLE_CREATED_ERROR description: Tipos de evento da tabela customizada: * `CUSTOM_TABLE_CREATED_SUCCESS` – Tabela customizada criada com sucesso * `CUSTOM_TABLE_CREATED_ERROR` – Erro ao criar a tabela customizada * `CUSTOM_TABLE_UPDATED_SUCCESS` – Tabela customizada atualizada com sucesso * `CUSTOM_TABLE_UPDATED_ERROR` – Erro ao atualizar a tabela customizada * `CUSTOM_SUBTABLE_CREATED_SUCCESS` – Subtabela customizada criada com sucesso * `CUSTOM_SUBTABLE_CREATED_ERROR` – Erro ao criar subtabela customizada formFieldType: type: string enum: – STRING – INTEGER – DECIMAL – BOOLEAN – DATE – LIST – TEXTAREA – ATTACHMENT – LINK – ARRAY – JSONB – DATE_TIME – TIME – LAYOUT description: Tipos de campo do formulário: * `STRING` – Texto * `INTEGER` – Inteiro * `DECIMAL` – Flutuante * `BOOLEAN` – Booleano * `DATE` – Data * `LIST` – Lista * `TEXTAREA` – Area de Texto * `ATTACHMENT` – Anexo * `LINK` – Link * `ARRAY` – Array * `JSONB` – Jsonb * `DATE_TIME` – Data e Hora * `TIME` – Hora * `LAYOUT` – Layout ruleTriggerType: type: string enum: – ON_START – ON_FIELD_EXIT – ON_SUBMIT description: Tipos de gatilho da regra: * `ON_START` – Ao iniciar o formulário * `ON_FIELD_EXIT` – Ao sair de um campo * `ON_SUBMIT` – Ao enviar o formulário ruleActionType: type: string enum: – DISABLE_FIELDS – ENABLE_FIELDS – HIDE_FIELDS – MAKE_FIELDS_VISIBLE – MAKE_FIELDS_REQUIRED – MAKE_FIELDS_CONSISTENCE description: Ações da regra do formulário: * `DISABLE_FIELDS` – Desabilitar campos * `ENABLE_FIELDS` – Habilitar campos * `HIDE_FIELDS` – Esconder campos * `MAKE_FIELDS_VISIBLE` – Tornar campos visíveis * `MAKE_FIELDS_REQUIRED` – Tornar campos obrigatórios * `MAKE_FIELDS_CONSISTENCE` – Consistir campos tableImportStatus: type: string enum: – SUCCESS – PENDING description: Status de importação da tabela: * `SUCCESS` – Importação realizada com sucesso * `PENDING` – Importação pendente queueNameType: type: string enum: – CREATE_FORM_DDL description: Utilizado para criar o nome da fila no taskManager: * `CREATE_FORM_DDL` – CREATE FORM DDL uploadFileType: type: string enum: – FORM_IO_SCHEMA – GED – BLOB description: Tipos de upload de arquivo: * `FORM_IO_SCHEMA` – Json com schema de configuração do formulário do form.io * `GED` – Arquivo GED * `BLOB` – Arquivo Blob Service downloadFileType: type: string enum: – GED – BLOB description: Tipos de download de arquivo: * `GED` – Arquivo GED * `BLOB` – Arquivo Blob Service areaSecretUploadType: type: string enum: – BPM_FORM_LEGACY_UPLOAD description: Tipos de area secret para upload de arquivos: * `BPM_FORM_LEGACY_UPLOAD` – Formulário legado publishFormEventType: type: string enum: – PUBLISH_FORM_SUCCESS – PUBLISH_FORM_ERROR description: Tipos de evento para a action de publishForm: * `PUBLISH_FORM_SUCCESS` – Formulário publicado com sucesso * `PUBLISH_FORM_ERROR` – Erro ao publicar formulário formActionType: type: string enum: – CREATE_SCHEMA – UPDATE_SCHEMA description: Tipos de ação para publishForm: * `CREATE_SCHEMA` – Criar schema * `UPDATE_SCHEMA` – Atualizar schema formPublishType: type: string enum: – CREATE_FORM_IO – UPDATE_FORM_IO – CREATE_FORM_LEGACY – UPDATE_FORM_LEGACY description: Tipos de publicação do formulário: * `CREATE_FORM_IO` – Criar formulário tipo Form.io * `UPDATE_FORM_IO` – Atualizar formulário tipo Form.io * `CREATE_FORM_LEGACY` – Criar formulário legado * `UPDATE_FORM_LEGACY` – Atualizar formulário legado valuePolicy: type: string enum: – DATASOURCE – ANY description: Política de valor para a fonte de dados: * `DATASOURCE` – Valor obtido diretamente da fonte de dados externa * `ANY` – Aceita qualquer valor fornecido pelo usuário ou sistema formFieldDatasourceConfigType: type: string enum: – QUERY – RESULTING description: Tipo de configuração de fonte de dados do campo de formulário: * `QUERY` – Configuração definida por meio de consulta (QUERY) à fonte de dados * `RESULTING` – Configuração baseada em dados já resultantes (RESULTING) de outra operação logicalOperator: type: string enum: – AND – OR description: Operador lógico para combinação de múltiplos filtros: * `AND` – Operador lógico E (AND) – todos os filtros devem ser verdadeiros * `OR` – Operador lógico OU (OR) – ao menos um dos filtros deve ser verdadeiro datasourceConfigFilterOperator: type: string enum: – GREATER_THAN_OR_EQUAL – EQUAL – IS_NOT description: Operador de comparação usado nos filtros de configuração de fonte de dados: * `GREATER_THAN_OR_EQUAL` – Compara se o valor é maior ou igual ao especificado * `EQUAL` – Compara se o valor é igual ao especificado * `IS_NOT` – Compara se o valor é diferente do especificado filterOperator: type: string enum: – EQ – NE – LT – GT – LE – GE description: Operador suportados pela busca com filtro: * `EQ` – Igual * `NE` – Diferente * `LT` – Menor que * `GT` – Maior que * `LE` – Menor ou igual * `GE` – Maior ou igual formSchemaType: type: string enum: – DIRECT – INTEGRATED description: Tipo de schema do formulário: * `DIRECT` – Direto * `INTEGRATED` – Integrado permissionResourceType: type: string enum: – FORM – DATA_COLLECTED description: Tipo do recurso de permissão consultado: * `FORM` – Permissão do formulário * `DATA_COLLECTED` – Permissão dos dados coletados bpmFormPrimitives: type: string enum: – GET_FORM_DATA – SAVE_FORM_DATA – UPDATE_FORM_DATA userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde createFormCustomTablePayload: description: DTO para criação da tabela customizada type: object required: – formId – formVersion – userToNotify properties: formId: type: string description: Id do formulário formVersion: type: integer format: int64 description: Versão do formulário userToNotify: type: string description: Usuário que irá receber a notificação após a criação da tabela logHashId: type: string maxLength: 255 description: Hash para consulta do serviço de log logOrder: type: integer format: int64 description: Ordenação de logs getFormPayload: description: DTO para retorno da primitiva getForm type: object required: – id – name – label – currentVersion – formType – allowExternalUse properties: id: type: string description: Id do formulário name: type: string description: Nome do formulário label: type: string description: Descrição do formulário currentVersion: type: integer format: int64 description: Versão atual do formulário customTableName: type: string description: Nome da tabela customizada formType: type: string allOf: – #/definitions/formType description: Tipo do formulário allowExternalUse: type: boolean description: Permite uso externo deleted: type: boolean description: Indica se o formulário foi deletado fields: type: array items: type: object allOf: – #/definitions/formFieldDto description: Campos do formulário rules: type: array items: type: object allOf: – #/definitions/formRuleDto description: Regras do formulário sections: type: array items: type: object allOf: – #/definitions/formSectionDto description: Seções do formulário formLayout: type: object allOf: – #/definitions/formLayoutDto description: Layout do formulário formFieldHierarchyDto: description: Metadados do campo e vínculo para reconstruir a hierarquia do formulário type: object required: – id – name – label – fieldType properties: id: type: string description: Id do campo name: type: string description: Nome do campo label: type: string description: Label do campo fieldType: type: string allOf: – #/definitions/formFieldType description: Tipo do campo fieldId: type: string description: Id do campo pai, ausente para campos raiz formFieldDto: description: DTO para representar os campos do formulário type: object required: – id – name – label – fieldType properties: id: type: string description: Id do campo name: type: string description: Nome do campo label: type: string description: Label do campo fieldType: type: string allOf: – #/definitions/formFieldType description: Tipo do campo fieldId: type: string description: Id do campo vinculado customSubtableName: type: string description: Nome da tabela customizada calculation: type: object allOf: – #/definitions/calculationDto description: Cálculo associado ao campo properties: type: object allOf: – #/definitions/propertyDto description: Propriedades do campo calculationDto: description: DTO para representar cálculo de um campo type: object required: – id – expression – triggerFields properties: id: type: string description: Id do cálculo expression: type: string description: Expressão do cálculo triggerFields: type: array items: type: object allOf: – #/definitions/triggerFieldDto minimum: 1 description: Campos do gatilho triggerFieldDto: description: DTO para representar os campos de gatilhos no cálculo type: object required: – id – triggerFieldId – triggerFieldName properties: id: type: string description: Id do campo triggerFieldId: type: string description: Id do campo triggerFieldName: type: string description: Nome do campo no gatilho propertyDto: description: DTO para representar as propriedes de um campo type: object required: – id properties: id: type: string description: Id da propriedade fieldOrder: type: integer format: int64 description: Ordem do campo multipleSelect: type: boolean description: Permite múltipla seleção items: type: string description: Itens da lista fieldSize: type: string description: Tamanho do campo regex: type: string description: Regex do campo tooltip: type: string description: Tooltip do campo mask: type: string description: Máscara do campo datasource: type: string description: Configuração de fonte de dados calculationId: type: string description: Id do cálculo associado ao campo appWorkflow: type: boolean description: Flag para indicar se o campo irá para o aplicativo Workflow defaultValue: type: string description: Valor padrão do campo attachmentPrefix: type: string description: Prefixo do anexo defaultPrefix: type: string description: Prefixo padrão do campo breakLine: type: boolean description: Flag para pular linha sectionName: type: string description: Nome da seção do campo isGrid: type: boolean description: Indica se o campo é um grid separatorLabel: type: string description: Label do separador dateFormat: type: string description: Formato de data formRuleDto: description: DTO para representar as regras do formulário type: object required: – id – triggerType – actions – triggerFields properties: id: type: string description: Id da regra description: type: string description: Descrição da regra triggerType: type: string allOf: – #/definitions/ruleTriggerType description: Tipo de gatilho da regra condition: type: string description: Condição da regra actions: type: array items: type: object allOf: – #/definitions/formRuleActionDto minimum: 1 description: Ações da regra triggerFields: type: array items: type: object allOf: – #/definitions/ruleTriggerFieldDto minimum: 1 description: Campos de gatilho da regra enabled: type: boolean description: Flag para habilitar/desabilitar a regra formRuleActionDto: description: DTO para representar as ações da regra type: object required: – id – type – actionFields properties: id: type: string description: Id da ação type: type: string allOf: – #/definitions/ruleActionType description: Tipo da ação actionFields: type: array items: type: object allOf: – #/definitions/ruleActionFieldDto minimum: 1 description: Campos usados na ação ruleActionFieldDto: description: DTO para representar os campos usados nas ações da regra type: object required: – id – fieldId – fieldName properties: id: type: string description: Id do campo usado na ação fieldId: type: string description: Id do campo vinculado fieldName: type: string description: Nome do campo vinculado ruleTriggerFieldDto: description: DTO para representar os campos usados no gatilho da regra type: object required: – id – fieldId – fieldName properties: id: type: string description: Id do gatilho fieldId: type: string description: id do campo vinculado fieldName: type: string description: Nome do campo vinculado formSectionDto: description: DTO para representar a seção de um formulário type: object required: – id – formId – version – name – sectionOrder properties: id: type: string description: Id da seção formId: type: string description: Id do formulário type: integer format: int64 description: Versão do formulário name: type: string description: Nome da seção sectionOrder: type: integer format: int64 description: Ordem de exibição da seção dentro do formulário formLayoutDto: description: DTO para representar os campos de layout do formulário type: object required: – layoutElements properties: layoutElements: type: array items: type: object allOf: – #/definitions/layoutElementDto minimum: 1 description: Layout do formulário layoutElementDto: description: DTO para representar um elemento no layout type: object required: – id – name – order properties: id: type: string description: Id do elemento de layout name: type: string description: Nome do elemento de layout order: type: integer format: int64 description: Ordem do elemento de layout section: type: string description: Seção a que o elemento pertence keyValueDto: description: DTO para representar um map type: object required: – key – value properties: key: type: string description: Chave do map value: type: string description: Valor do map keyValueListDto: description: DTO para representar um hashMap type: object required: – keyValueList properties: keyValueList: type: array items: type: object allOf: – #/definitions/keyValueDto minimum: 1 description: Chave do hashMap filterDto: description: DTO para utilizar como filtro type: object required: – key – operator – value properties: key: type: string description: Chave do filtro operator: type: string allOf: – #/definitions/filterOperator description: Tipo do filtro value: type: string description: Valor do filtro dynamicTableFieldDto: description: DTO para representar tabelas dinâmicas type: object properties: columnName: type: string description: Nome da coluna columnValue: type: string description: Valor da coluna tableContent: type: array items: type: object allOf: – #/definitions/dynamicTableFieldDto description: Conteúdo da tabela formExternalDto: description: DTO para representar formulario externalizado type: object required: – formId – hashToken – type – active – acceptedOrigins properties: formId: type: string description: Id do formulário hashToken: type: string description: Valor do hashtoken type: type: string allOf: – #/definitions/formSchemaType description: Tipo de compartilhamento active: type: boolean description: Status de compartilhamento acceptedOrigins: type: array items: type: object allOf: – #/definitions/keyValueDto minimum: 1 description: Origens aceitas rolesPagination: description: Paginação para listagem dos papeis type: object required: – page – limit properties: page: type: integer format: int64 description: Número da página limit: type: integer format: int64 description: Número de registros por página tenantRole: description: Papel do tenant type: object required: – name – description properties: name: type: string description: Nome do papel description: type: string description: Descrição do papel workflowIntegrationDTO: description: DTO para representar contrato de integração com workflow do connect type: object required: – workflowName properties: workflowName: type: string description: Nome do workflow connect integrationId: type: string description: Id da integração queryParams: type: array items: type: object allOf: – #/definitions/keyValueDto description: Parâmetros enviados na query requestBody: type: array items: type: object allOf: – #/definitions/keyValueDto description: Parâmetros de entrada para a integração requestHeaders: type: array items: type: object allOf: – #/definitions/keyValueDto description: Cabeçalhos de requisição para a integração auth: type: object allOf: – #/definitions/basicAuthDTO description: Tipo de autenticação para a integração subtenant: type: string description: Sub-tenant basicAuthDTO: description: Objeto de autenticação Basic Auth para execução do workflow type: object properties: username: type: string description: Usuário para autenticação Basic Auth password: type: string description: Senha para autenticação Basic Auth form: description: Formulário type: object required: – name – label – formType – allowExternalUse properties: id: type: string format: uuid description: ID do formulário name: type: string maxLength: 59 description: Nome do formulário label: type: string maxLength: 255 description: Descrição do formulário currentVersion: type: integer format: int64 description: Versão atual do formulário minimum: 1 permission: type: string maxLength: 255 description: Recurso de permissão customizado para o formulário formWebUrl: type: string maxLength: 255 description: URL do formulário quando for form tipo WEB formType: type: string allOf: – #/definitions/formType description: Tipo de formulário allowExternalUse: type: boolean description: Permite uso externo customTableName: type: string maxLength: 63 description: Nome da tabela dinâmica gerada deleted: type: boolean description: Flag para indicar se formulário foi deletado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editForm: type: object required: – id allOf: – #/definitions/form formVersion: description: Tabela para controlar as versões do formulário type: object required: – formId – version properties: id: type: string format: uuid description: Id de controle da tabela formId: type: string format: uuid description: Id do formulário type: integer format: int64 description: Versão do formulário minimum: 1 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: formVersionField: description: Tabela para controlar as versões do formulário e seus campos type: object required: – formVersionId – fieldId properties: id: type: string format: uuid description: Id de controle da tabela formVersionId: type: string format: uuid description: Id da versão do formulário fieldId: type: string format: uuid description: Id do campo do formulário createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: formField: description: Campo do formulário type: object required: – formId – name – label – type properties: id: type: string format: uuid description: Id do campo formId: type: string format: uuid description: Formulário fieldId: type: string format: uuid description: Id do subcampo vinculado name: type: string maxLength: 255 description: Nome do campo label: type: string maxLength: 255 description: Rótulo do campo type: type: string allOf: – #/definitions/formFieldType description: Tipo do campo customSubtableName: type: string maxLength: 63 description: Nome da tabela customizada multiple: type: boolean description: Indica se o campo aceita múltiplos valores createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editFormField: type: object required: – id allOf: – #/definitions/formField tableImportEvent: description: Tabela de eventos de importação de tabelas type: object required: – tableName – version – fileId – fileName – fileSize – recordsCount – status – log properties: id: type: string format: uuid description: Id da importação de tabela tableName: type: string maxLength: 255 description: Nome da tabela importada type: integer format: int64 description: Versão do evento de importação minimum: 1 fileId: type: string maxLength: 255 description: Id do arquivo importado fileName: type: string maxLength: 255 description: Nome do arquivo importado fileSize: type: integer format: int64 description: Tamanho do arquivo importado minimum: 1 recordsCount: type: integer format: int64 description: Quantidade de registros do arquivo importado minimum: 1 status: type: string allOf: – #/definitions/tableImportStatus description: Status da importação log: type: string maxLength: 255 description: Logs de importação importCache: type: array items: type: object allOf: – #/definitions/tableImportCache description: Caches de importação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTableImportEvent: type: object required: – id allOf: – #/definitions/tableImportEvent tableImportCache: description: Tabela de eventos de importação de tabelas type: object required: – fileSize – cacheHash – lastImport properties: id: type: string format: uuid description: Id da tabela de cache de importação de tabela importId: type: object allOf: – #/definitions/tableImportEvent description: Id da importação de tabela fileSize: type: integer format: int64 description: Tamanho do arquivo importado minimum: 1 cacheHash: type: string maxLength: 255 description: Hash do cache lastImport: type: string format: date-time description: Data da última importação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTableImportCache: type: object required: – id allOf: – #/definitions/tableImportCache formIoSchema: description: Armazena as configurações do formulário definidas pelo form.io type: object required: – form – filePath properties: id: type: string format: uuid description: ID do formulário form: type: object allOf: – #/definitions/form description: Formulário formVersion: type: object allOf: – #/definitions/formVersion description: Versão do formulário filePath: type: string maxLength: 255 description: Path do json do formulário armazenado no S3 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: formExternal: description: Controle de tokens para formulários externos type: object required: – tenant – formId – hashToken – type – active – acceptedOrigins properties: id: type: string format: uuid description: Id do registro tenant: type: string maxLength: 255 description: Tenant do formulário formId: type: string format: uuid description: Id do formulário hashToken: type: string maxLength: 255 description: Token hash gerado para acesso externo type: type: string allOf: – #/definitions/formSchemaType description: Tipo de externalização active: type: boolean description: Flag indicando se o token está ativo acceptedOrigins: type: array items: type: object allOf: – #/definitions/acceptedOrigin minimum: 1 description: Origens aceitas createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editFormExternal: type: object required: – id allOf: – #/definitions/formExternal acceptedOrigin: description: Origem aceita para formulário externo type: object required: – originUrl properties: id: type: string format: uuid description: Id da origem aceita originUrl: type: string maxLength: 255 description: URL da origem formExternalId: type: object allOf: – #/definitions/formExternal description: Id do formulário externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAcceptedOrigin: type: object required: – id allOf: – #/definitions/acceptedOrigin 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage