Mais pesquisados:Customização, Tutorial, Documentação

Workflow (workflow)

4499 views 0 22/10/2018 Atualizado em 21/10/2024 integrador

2.0info: 5.134.0 Workflow description: Serviço de Workflow x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: workflow contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /workflow/queries/getProcessInfo: post: description: Retorna informações sobre o cadastro de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: ProcessID responses: 200: description: Ok schema: type: object required: – id – processVersion – name – isActive – countIntegrationErrors – isSimple properties: id: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo name: type: string description: Nome do processo description: type: string description: Descrição do processo isActive: type: boolean description: O Processo está ativo tag: type: string description: Categoria do processo owner: type: string description: Dono do processo executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formUrl: type: string description: Url do formulário WEB formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado icon: type: string description: Icone do Processo taskVisibleAfterTreated: type: string allOf: – #/definitions/variableVisibility description: Tarefa vísivel após tratada viewName: type: string description: Nome da view para visões dinâmicas generateView: type: boolean description: Define se irá gerar a view para o visões dinâmicas processKey: type: string description: Nome da Chave do processo countIntegrationErrors: type: integer format: int64 description: Contador com a quantidade de erros de integração da última semana isSimple: type: boolean description: Identificador se o processo é simples ou BPM enableRating: type: boolean description: Indicador de avaliação habilitada/desabilitada para o processo rating: type: number format: double description: Avaliação média do processo ratingCount: type: integer format: int64 description: Quantidade de avaliações attachTabVisibility: type: boolean description: Mostra ou oculta a tela de abas da solicitação thirdPartyPermission: type: boolean description: Define a permissão de edição do processo por terceiros que importam o processo tenantOwner: type: string description: Tenant dono do processo enableUserInCopyConfig: type: boolean description: Habilita a funcionaidade Usuário em cópia requestSubjectMandatory: type: boolean description: Define se o campo de assunto da solicitação será obrigatório ou opcional useNewForm: type: boolean description: Habilita o uso do novo formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna informações sobre o cadastro de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: ProcessID in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – id – processVersion – name – isActive – countIntegrationErrors – isSimple properties: id: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo name: type: string description: Nome do processo description: type: string description: Descrição do processo isActive: type: boolean description: O Processo está ativo tag: type: string description: Categoria do processo owner: type: string description: Dono do processo executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formUrl: type: string description: Url do formulário WEB formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado icon: type: string description: Icone do Processo taskVisibleAfterTreated: type: string allOf: – #/definitions/variableVisibility description: Tarefa vísivel após tratada viewName: type: string description: Nome da view para visões dinâmicas generateView: type: boolean description: Define se irá gerar a view para o visões dinâmicas processKey: type: string description: Nome da Chave do processo countIntegrationErrors: type: integer format: int64 description: Contador com a quantidade de erros de integração da última semana isSimple: type: boolean description: Identificador se o processo é simples ou BPM enableRating: type: boolean description: Indicador de avaliação habilitada/desabilitada para o processo rating: type: number format: double description: Avaliação média do processo ratingCount: type: integer format: int64 description: Quantidade de avaliações attachTabVisibility: type: boolean description: Mostra ou oculta a tela de abas da solicitação thirdPartyPermission: type: boolean description: Define a permissão de edição do processo por terceiros que importam o processo tenantOwner: type: string description: Tenant dono do processo enableUserInCopyConfig: type: boolean description: Habilita a funcionaidade Usuário em cópia requestSubjectMandatory: type: boolean description: Define se o campo de assunto da solicitação será obrigatório ou opcional useNewForm: type: boolean description: Habilita o uso do novo formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessRatings: post: description: Lista as avaliações de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Id do processo activity: type: string description: Nome da atividade avaliada startDate: type: string format: date description: Listar apenas avaliações feitas após a data inicial endDate: type: string format: date description: Listar apenas avaliações feitas antes da data final page: type: integer format: int64 description: Número da página, o valor default é 1, sendo também o valor mínimo minimum: 1 default: 1 size: type: integer format: int64 description: Tamanho da página, o valor default é 10 sendo o valor mínimo 1 minimum: 1 default: 10 responses: 200: description: Ok schema: type: object required: – ratings – totalPages – totalElements properties: ratings: type: array items: type: object allOf: – #/definitions/processRatingSummary minimum: 1 description: Lista de avaliações de acordo com os filtros aplicados totalPages: type: integer format: int64 description: Quantidade total de páginas totalElements: type: integer format: int64 description: Quantidade total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as avaliações de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Id do processo in: query required: true type: integer format: int64 – name: activity description: Nome da atividade avaliada in: query type: string – name: startDate description: Listar apenas avaliações feitas após a data inicial in: query type: string format: date – name: endDate description: Listar apenas avaliações feitas antes da data final in: query type: string format: date – name: page description: Número da página, o valor default é 1, sendo também o valor mínimo in: query type: integer format: int64 – name: size description: Tamanho da página, o valor default é 10 sendo o valor mínimo 1 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – ratings – totalPages – totalElements properties: ratings: type: array items: type: object allOf: – #/definitions/processRatingSummary minimum: 1 description: Lista de avaliações de acordo com os filtros aplicados totalPages: type: integer format: int64 description: Quantidade total de páginas totalElements: type: integer format: int64 description: Quantidade total de elementos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/requestUrlsForProcessUpload: post: description: Requisita as URLs para upload do modelo e svg do processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – forPublication properties: processId: type: integer format: int64 description: Id do processo forPublication: type: boolean description: Se está publicando responses: 200: description: Ok schema: type: object required: – processModel properties: processModel: type: object allOf: – #/definitions/fileToUpload description: Modelo do processo processSvg: type: object allOf: – #/definitions/fileToUpload description: Svg do processo, apenas quando publica thumbnail: type: object allOf: – #/definitions/fileToUpload description: Miniatura do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Requisita as URLs para upload do modelo e svg do processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Id do processo in: query required: true type: integer format: int64 – name: forPublication description: Se está publicando in: query required: true type: boolean responses: 200: description: Ok schema: type: object required: – processModel properties: processModel: type: object allOf: – #/definitions/fileToUpload description: Modelo do processo processSvg: type: object allOf: – #/definitions/fileToUpload description: Svg do processo, apenas quando publica thumbnail: type: object allOf: – #/definitions/fileToUpload description: Miniatura do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessTracking: post: description: Consulta da rastreabilidade dos processos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId – historyDate properties: processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso a ser consultado historyDate: type: string format: date-time description: Data do Histórico a ser consultado responses: 200: description: Ok schema: type: object required: – currentData – currentHistoryDate – currentUserName – previousData – previousHistoryDate – previousUserName properties: currentData: type: string description: Dados da etapa atual currentHistoryDate: type: string format: date-time description: Data do Histórico currentUserName: type: string description: Usuário responsável previousData: type: string description: Dados da etapa anterior previousHistoryDate: type: string format: date-time description: Data do Histórico previousUserName: type: string description: Usuário responsável 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta da rastreabilidade dos processos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceId description: Identificador da Instancia do Proceso a ser consultado in: query required: true type: integer format: int64 – name: historyDate description: Data do Histórico a ser consultado in: query required: true type: string format: date-time responses: 200: description: Ok schema: type: object required: – currentData – currentHistoryDate – currentUserName – previousData – previousHistoryDate – previousUserName properties: currentData: type: string description: Dados da etapa atual currentHistoryDate: type: string format: date-time description: Data do Histórico currentUserName: type: string description: Usuário responsável previousData: type: string description: Dados da etapa anterior previousHistoryDate: type: string format: date-time description: Data do Histórico previousUserName: type: string description: Usuário responsável 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/isPendencyAssumed: post: description: Verifica se a pendência já foi assumida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – flowToken properties: flowToken: type: object allOf: – #/definitions/serviceFlowToken description: Identificador da pendência responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/pendencyAssumedStatus description: Status da pendência em lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getRequestProgress: post: description: Retorna uma lista com o progresso das minhas solicitações que estão mais perto de concluir, permite filtrar por um número de solicitação específico ou nome do processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Quantidade de registros default: 5 responses: 200: description: Ok schema: type: object required: – requestProgress properties: requestProgress: type: array items: type: object allOf: – #/definitions/requestProgress minimum: 1 description: Lista do progresso de cada requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com o progresso das minhas solicitações que estão mais perto de concluir, permite filtrar por um número de solicitação específico ou nome do processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Quantidade de registros in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – requestProgress properties: requestProgress: type: array items: type: object allOf: – #/definitions/requestProgress minimum: 1 description: Lista do progresso de cada requisição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getWidgetDataExpirationByUser: post: description: Retorna lista de status de expirações e a quantidade de pendências em cada status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: responsibleId: type: integer format: int64 description: Id do responsável a ser verificado as expirações das pendências, caso não seja informado utiliza o usuário corrente responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/expirationCount minimum: 1 description: Items com status e quantidade no status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de status de expirações e a quantidade de pendências em cada status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: responsibleId description: Id do responsável a ser verificado as expirações das pendências, caso não seja informado utiliza o usuário corrente in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/expirationCount minimum: 1 description: Items com status e quantidade no status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listTasksBatchProcess: post: description: Lista as tarefas para tratamento em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: processId: type: integer format: int64 description: Id do processo activity: type: string description: Id da atividade start: type: integer format: int64 description: Começar da página default: 0 limit: type: integer format: int64 description: Quantidade de registros por página default: 10 filters: type: array items: type: object allOf: – #/definitions/filter description: filtros orders: type: array items: type: object allOf: – #/definitions/order description: Ordenação responses: 200: description: Ok schema: type: object properties: groups: type: array items: type: object allOf: – #/definitions/batch description: Lotes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/canOpenTask: post: description: Verifica e pode abrir uma tarefa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Id do processo responses: 200: description: Ok schema: type: object required: – canOpen properties: canOpen: type: boolean description: Se pode abrir a tarefa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica e pode abrir uma tarefa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Id do processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – canOpen properties: canOpen: type: boolean description: Se pode abrir a tarefa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getPublishedProcess: post: description: Processos Publicado no Workflow tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: processes: type: array items: type: object allOf: – #/definitions/serviceProcess description: Lista de Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Processos Publicado no Workflow tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: processes: type: array items: type: object allOf: – #/definitions/serviceProcess description: Lista de Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessEcm: post: description: Obtém a entidade e versão do processo associado a um formuláio ECM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do Processo responses: 200: description: Ok schema: type: object required: – entityName – formVersion properties: entityName: type: string description: Nome da Entidade formVersion: type: integer format: int64 description: Número da Versão do Formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a entidade e versão do processo associado a um formuláio ECM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – entityName – formVersion properties: entityName: type: string description: Nome da Entidade formVersion: type: integer format: int64 description: Número da Versão do Formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getCurrentTaskInfo: post: description: Obtém Informações da atividade atual de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: FlowToken da pendência responses: 200: description: Ok schema: type: object required: – processName – taskName properties: processName: type: string description: Nome do Processo taskName: type: string description: Label da Atividade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessIcon: post: description: DEPRECADO Obtém o icone de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – processVersion properties: processId: type: integer format: int64 description: Identificador do Processo processVersion: type: integer format: int64 description: Número da Versão do Processo responses: 200: description: Ok schema: type: object required: – icon properties: icon: type: string description: Binário do Icone do Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: DEPRECADO Obtém o icone de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do Processo in: query required: true type: integer format: int64 – name: processVersion description: Número da Versão do Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – icon properties: icon: type: string description: Binário do Icone do Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessSvg: post: description: Obtém Svg (Scalable Vector Graphics) de uma instancia de processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: processId: type: integer format: int64 description: Identificador do Processo processVersion: type: integer format: int64 description: Número da Versão do Processo serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Token do Worfklow que indica processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso returnCurrentSvgTaskId: type: boolean description: . default: false responses: 200: description: Ok schema: type: object required: – svg – svgTaskId properties: svg: type: string description: Retorna o SVG em formato string svgTaskId: type: string description: Retorna o ID da task atual no SVG 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessSvg__2: post: description: Obtém Svg (Scalable Vector Graphics) de uma instancia de processo. Nesta versão os dados do svg são trafegados via BlobService tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: processId: type: integer format: int64 description: Identificador do Processo processVersion: type: integer format: int64 description: Número da Versão do Processo serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Token do Worfklow que indica processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso returnCurrentSvgTaskId: type: boolean description: . default: false responses: 200: description: Ok schema: type: object required: – svgUrl – svgTaskId properties: svgUrl: type: string description: Retorna a url onde o SVG está disponível svgTaskId: type: string description: Retorna o ID da task atual no SVG 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessMetadata: post: description: Retorna um json com a estrutura de artefatos da última versão de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do Processo responses: 200: description: Ok schema: type: object required: – meta properties: meta: type: string description: Metadata do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna um json com a estrutura de artefatos da última versão de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – meta properties: meta: type: string description: Metadata do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getDeployedProcessModel: post: description: Obtém o JSON do processo, para o modelador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do Processo responses: 200: description: Ok schema: type: object required: – jsonProcess properties: id: type: integer format: int64 description: Id do processo name: type: string description: Nome do processo description: type: string description: Descrição do processo tag: type: string description: Categoria do processo owner: type: string description: Dono do processo executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado formUrl: type: string description: Url do formulário WEB jsonProcess: type: string description: json do modelo do processo icon: type: string description: Icone do Processo taskVisibleAfterTreated: type: boolean description: Tarefa vísivel após tratada viewName: type: string description: Nome da view para visões dinâmicas generateView: type: boolean description: Define se irá gerar a view para o visões dinâmicas processKey: type: string description: Nome da Chave do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o JSON do processo, para o modelador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – jsonProcess properties: id: type: integer format: int64 description: Id do processo name: type: string description: Nome do processo description: type: string description: Descrição do processo tag: type: string description: Categoria do processo owner: type: string description: Dono do processo executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado formUrl: type: string description: Url do formulário WEB jsonProcess: type: string description: json do modelo do processo icon: type: string description: Icone do Processo taskVisibleAfterTreated: type: boolean description: Tarefa vísivel após tratada viewName: type: string description: Nome da view para visões dinâmicas generateView: type: boolean description: Define se irá gerar a view para o visões dinâmicas processKey: type: string description: Nome da Chave do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getDeployedProcessModel__2: post: description: Obtém o JSON do processo, para o modelador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do Processo responses: 200: description: Ok schema: type: object required: – jsonProcess properties: id: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo name: type: string description: Nome do processo description: type: string description: Descrição do processo tag: type: string description: Categoria do processo owner: type: string description: Dono do processo executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado formUrl: type: string description: Url do formulário WEB jsonProcess: type: string description: json do modelo do processo icon: type: string description: Icone do Processo variableVisibility: type: string allOf: – #/definitions/variableVisibility description: Configuração de visibilidade das variáveis viewName: type: string description: Nome da view para visões dinâmicas generateView: type: boolean description: Define se irá gerar a view para o visões dinâmicas processKey: type: string description: Nome da Chave do processo processDocumentConfigId: type: string description: Identificador para Configuração de Integração Documentos GED processSignConfigId: type: string description: Identificador para Configuração de Integração com o SIGN 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o JSON do processo, para o modelador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – jsonProcess properties: id: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo name: type: string description: Nome do processo description: type: string description: Descrição do processo tag: type: string description: Categoria do processo owner: type: string description: Dono do processo executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado formUrl: type: string description: Url do formulário WEB jsonProcess: type: string description: json do modelo do processo icon: type: string description: Icone do Processo variableVisibility: type: string allOf: – #/definitions/variableVisibility description: Configuração de visibilidade das variáveis viewName: type: string description: Nome da view para visões dinâmicas generateView: type: boolean description: Define se irá gerar a view para o visões dinâmicas processKey: type: string description: Nome da Chave do processo processDocumentConfigId: type: string description: Identificador para Configuração de Integração Documentos GED processSignConfigId: type: string description: Identificador para Configuração de Integração com o SIGN 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getAllDocumentTickets: post: description: Busca todos os tickets de documentos integrados com o GED tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Identificador da instância de Processo responses: 200: description: Ok schema: type: object required: – tickets properties: tickets: type: array items: type: string minimum: 1 description: Tickets 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todos os tickets de documentos integrados com o GED tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceId description: Identificador da instância de Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tickets properties: tickets: type: array items: type: string minimum: 1 description: Tickets 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getThirdPartyRequestByStatus: post: description: Lista as solicitações de Aplicações Terceiras por Status tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processKey – status properties: processKey: type: string description: Nome da Chave do Processo status: type: string allOf: – #/definitions/pendencyType description: Status da PendÊncia responses: 200: description: Ok schema: type: object required: – requests properties: requests: type: array items: type: object allOf: – #/definitions/thirdpartyRequestResume minimum: 1 description: Solicitações Terceiras 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/findProcess: post: description: Retorna um processo do workflow tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Filtra pelo id responses: 200: description: Ok schema: type: object required: – process properties: process: type: object allOf: – #/definitions/serviceProcess description: Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna um processo do workflow tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Filtra pelo id in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – process properties: process: type: object allOf: – #/definitions/serviceProcess description: Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessesList: post: description: Obtém os processos ativos que o usuário logado tem algum tipo de permissão. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – serviceAction properties: serviceAction: type: string allOf: – #/definitions/serviceType description: Tipo de Ação que indica quais processos serão listado processFilterType: type: string allOf: – #/definitions/processFilterType description: Filtro por tipo de processo tagFilter: type: string description: Tag para filtro onlyActiveProcesses: type: boolean description: Apenas retorna processos ativos default: true serviceEventStartDate: type: string format: date-time description: A partir de qual data buscar eventos de serviços externos responses: 200: description: Ok schema: type: object properties: processes: type: array items: type: object allOf: – #/definitions/serviceProcess description: Lista de Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getRankingProcesses: post: description: Lista os processos mais utilizados pelo usuário tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: start: type: string format: date-time description: Data Inicial para processar o ranking, se não informada usa data hoje menos 6 meses end: type: string format: date-time description: Data Final para processar o ranking, se não informado usa data hoje limit: type: integer format: int64 description: Especifica o número de procesos para retornar default: 3 responses: 200: description: Ok schema: type: object properties: processes: type: array items: type: object allOf: – #/definitions/processRanking description: Lista de Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os processos mais utilizados pelo usuário tags: – Queries x-senior-visibility: PUBLIC parameters: – name: start description: Data Inicial para processar o ranking, se não informada usa data hoje menos 6 meses in: query type: string format: date-time – name: end description: Data Final para processar o ranking, se não informado usa data hoje in: query type: string format: date-time – name: limit description: Especifica o número de procesos para retornar in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: processes: type: array items: type: object allOf: – #/definitions/processRanking description: Lista de Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getMyPendencies: post: description: DEPRECADO – Obtém as pendências do usuário logado conforme o tipo. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: pendencyRequestParameters: type: object allOf: – #/definitions/pendencyRequestParameters description: . responses: 200: description: Ok schema: type: object required: – pendencies properties: pendencies: type: array items: type: object allOf: – #/definitions/pendency minimum: 1 description: . total: type: integer format: int64 description: . 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getUserAssociatedPendencies: post: description: DEPRECADO – Obtém as pendências dos grupos e papéis associados ao usuário logado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/servicePendencyFilter description: . responses: 200: description: Ok schema: type: object required: – pendencies properties: pendencies: type: array items: type: object allOf: – #/definitions/pendency minimum: 1 description: . total: type: integer format: int64 description: . 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/searchTags: post: description: Busca as tags na base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Filtra pelo nome page: type: integer format: int64 description: Página size: type: integer format: int64 description: Tamanho da página responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as tags na base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: q description: Filtra pelo nome in: query type: string – name: page description: Página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/searchProcesses: post: description: Busca os processos da base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Filtra pelo nome page: type: integer format: int64 description: Página size: type: integer format: int64 description: Tamanho da página responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os processos da base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: q description: Filtra pelo nome in: query type: string – name: page description: Página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/searchProcessVariables: post: description: Busca as variáveis de um determinado processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Filtra pelo nome page: type: integer format: int64 description: Página size: type: integer format: int64 description: Tamanho da página process_task: type: array items: type: integer format: int64 description: Id do processo process_request: type: array items: type: integer format: int64 description: Id do processo process_pool: type: array items: type: integer format: int64 description: Id do processo process_management: type: array items: type: integer format: int64 description: Id do processo responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de variáveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as variáveis de um determinado processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: q description: Filtra pelo nome in: query type: string – name: page description: Página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: process_task description: Id do processo in: query type: array items: type: integer format: int64 – name: process_request description: Id do processo in: query type: array items: type: integer format: int64 – name: process_pool description: Id do processo in: query type: array items: type: integer format: int64 – name: process_management description: Id do processo in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de variáveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/searchProcessSteps: post: description: Busca as etapas de um determinado processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Filtra pelo nome page: type: integer format: int64 description: Página size: type: integer format: int64 description: Tamanho da página process_task: type: array items: type: integer format: int64 description: Id do processo process_request: type: array items: type: integer format: int64 description: Id do processo process_pool: type: array items: type: integer format: int64 description: Id do processo process_management: type: array items: type: integer format: int64 description: Id do processo responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de variáveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as etapas de um determinado processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: q description: Filtra pelo nome in: query type: string – name: page description: Página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 – name: process_task description: Id do processo in: query type: array items: type: integer format: int64 – name: process_request description: Id do processo in: query type: array items: type: integer format: int64 – name: process_pool description: Id do processo in: query type: array items: type: integer format: int64 – name: process_management description: Id do processo in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de variáveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/searchSubjects: post: description: Busca os usuários da base – deprecado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Filtra pelo nome page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de usuários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os usuários da base – deprecado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: q description: Filtra pelo nome in: query type: string – name: page description: Página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchResult minimum: 1 description: lista de usuários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/searchUsers: post: description: Busca os usuários da base tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: q: type: string description: Filtra pelo login e pelo nome requester_task_status: type: string allOf: – #/definitions/requesterTaskStatusEnum description: Filtra de acordo com status do usuário selecionado page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Tamanho da página default: 50 onlyActive: type: boolean description: Considerar somente usuários que não estão bloqueados default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchUserResult minimum: 1 description: lista de usuários totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/searchUsersAndRoles: post: description: Busca os usuários e os papéis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: string description: Filtra pelo usuário (username, fullname ou email) e pelo nome do papel requester_task_status: type: string allOf: – #/definitions/requesterTaskStatusEnum description: Filtra de acordo com status do usuário selecionado page: type: integer format: int64 description: Página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 onlyActive: type: boolean description: Considerar somente usuários que não estão bloqueados default: false responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/searchUsersAndRolesResult minimum: 1 description: Lista de usuários e papéis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listProcesses: post: description: Obtém a listagem de processos que o usuário logado tem permissão de edição tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Página de dados da coleção a ser obtida size: type: integer format: int64 description: Quantidade de itens por página minimum: 1 maximum: 40 default: 10 orders: type: array items: type: object allOf: – #/definitions/processOrder description: Ordenação filters: type: array items: type: object allOf: – #/definitions/apiFilter description: Filtros ratingFilters: type: array items: type: object allOf: – #/definitions/apiFilter description: Filtros responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/processListItem description: Lista de Processos totalPages: type: integer format: int64 description: Total de Páginas totalElements: type: integer format: int64 description: Total de Itens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listProcessesAuthors: post: description: Lista todos os autores dos processos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: search: type: string description: Busca pelo nome pageSize: type: integer format: int64 description: Tamanho da página default: 10 pageNumber: type: integer format: int64 description: Número da página default: 0 responses: 200: description: Ok schema: type: object properties: authors: type: array items: type: object allOf: – #/definitions/ProcessAuthor description: Lista de autores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todos os autores dos processos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: search description: Busca pelo nome in: query type: string – name: pageSize description: Tamanho da página in: query type: integer format: int64 – name: pageNumber description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: authors: type: array items: type: object allOf: – #/definitions/ProcessAuthor description: Lista de autores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listTasks: post: description: Listar tarefas na nova central de tarefas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – kind – groupBy – start – limit – startTask – limitTask properties: kind: type: string allOf: – #/definitions/taskListItemType description: Tipo de item da central de tarefas groupBy: type: string allOf: – #/definitions/groupBy description: Agrupado por filters: type: array items: type: object allOf: – #/definitions/filter description: Filtros orders: type: array items: type: object allOf: – #/definitions/order description: Ordenação start: type: integer format: int64 description: Início limit: type: integer format: int64 description: Quantidade startTask: type: integer format: int64 description: Faixa inicial da consulta de tarefas limitTask: type: integer format: int64 description: Quantidade de tarefas da consulta group: type: string description: Filtrar por grupo periodOfDate: type: string allOf: – #/definitions/periodOfDate description: Período de dados responses: 200: description: Ok schema: type: object required: – count properties: groups: type: array items: type: object allOf: – #/definitions/group description: Agrupamentos count: type: integer format: int64 description: Total de itens 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /workflow/queries/searchTasks: post: description: Listar tarefas na nova central de tarefas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/searchTasksFilter description: Filtros para pesquisa pagination: type: object allOf: – #/definitions/pagination description: Paginação orders: type: array items: type: object allOf: – #/definitions/order description: Ordenação responses: 200: description: Ok schema: type: object required: – tasks – total properties: tasks: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: Lista de tarefas total: type: integer format: int64 description: Total de registros 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /workflow/queries/getTasksTotalizer: post: description: Totalizadores tarefas na nova central de tarefas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – kind properties: kind: type: string allOf: – #/definitions/taskListItemType description: Tipo do item a exibir filters: type: array items: type: object allOf: – #/definitions/filter description: filtros periodOfDate: type: string allOf: – #/definitions/periodOfDate description: Período de dados responses: 200: description: Ok schema: type: object required: – pendingCount – expiresTodayCount – expiredCount – unreadedCount – treatedCount – tasksTotalCount – inProgressCount – canceledCount – completedCount – requestsTotalCount properties: pendingCount: type: integer format: int64 description: Tarefas Pendentes expiresTodayCount: type: integer format: int64 description: Tarefas que expiram em 24 horas expiredCount: type: integer format: int64 description: Tarefas que já estão expiradas unreadedCount: type: integer format: int64 description: Tarefas Não Lidas treatedCount: type: integer format: int64 description: Tarefas tratadas tasksTotalCount: type: integer format: int64 description: Todas as tarefas inProgressCount: type: integer format: int64 description: Solicitação em progresso canceledCount: type: integer format: int64 description: Solicitações Canceladas completedCount: type: integer format: int64 description: Solicitação encerradas requestsTotalCount: type: integer format: int64 description: Todas as solicitações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listPendencies: post: description: Obtém as pendências que foram atribuídas diretamente ao usuário logado\n e também as que foram atribuídas a um grupo ou papel relacionado ao mesmo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/pendencyRequestParameters description: Filtro para busca orders: type: array items: type: object allOf: – #/definitions/keyValueRecord description: Ordenação da listagem responses: 200: description: Ok schema: type: object required: – pendencies properties: pendencies: type: array items: type: object allOf: – #/definitions/summarizedPendency minimum: 1 description: Pendências encontradas total: type: integer format: int64 description: Quantidade total de pendências atribuídas ao usuário logado com base nos filtros informados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listPendenciesByRequest: post: description: Lista todas as pendências em andamento de uma solicitação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Identificador da instância de Processo responses: 200: description: Ok schema: type: object required: – pendencies properties: pendencies: type: array items: type: object allOf: – #/definitions/summarizedPendency minimum: 1 description: Pendências encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todas as pendências em andamento de uma solicitação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceId description: Identificador da instância de Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – pendencies properties: pendencies: type: array items: type: object allOf: – #/definitions/summarizedPendency minimum: 1 description: Pendências encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getMyRequests: post: description: Obtém as solicitações do usuário logado conforme o tipo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: processInstanceRequestParameters: type: object allOf: – #/definitions/processInstanceRequestParameters description: Parametrização de Filtros da Instancia de Processo responses: 200: description: Ok schema: type: object properties: processInstances: type: array items: type: object allOf: – #/definitions/processInstance description: Lista de Instancia de Processos total: type: integer format: int64 description: Número Total de Instancia de Procesos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getMyRequestsResume: post: description: Obtem o resumo das solicitações tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: myRequestResumeParameters: type: object allOf: – #/definitions/myRequestResumeParameters description: Filtros para solicitações responses: 200: description: Ok schema: type: object properties: myRequestsResume: type: array items: type: object allOf: – #/definitions/myRequestsResume description: Lista com resumo das solicitações total: type: integer format: int64 description: Número Total de Instancia de Procesos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getRequestsResume: post: description: Obtem o resumo das solicitações tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: start: type: integer format: int64 description: Faixa inicial da consulta limit: type: integer format: int64 description: Quantidade de linhas da consulta filterProcess: type: array items: type: integer format: int64 description: Filtro com lista de processos separado por virgula filterValue: type: string description: Filtro para buscar pelo nome da pendência ou valor das variáveis do processo filter: type: array items: type: string allOf: – #/definitions/myRequestKind description: Filtro por status orders: type: array items: type: object allOf: – #/definitions/keyOrderDirectionAndValue description: Ordenação situation: type: string allOf: – #/definitions/reportTaskExpirationStatus description: Status responses: 200: description: Ok schema: type: object properties: requestsResume: type: array items: type: object allOf: – #/definitions/myRequestsResume description: Lista com resumo das solicitações total: type: integer format: int64 description: Número Total de Instancia de Procesos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getPendency: post: description: Obtém os dados de uma pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Identificador de uma pendência. responses: 200: description: Ok schema: type: object required: – pendency properties: pendency: type: object allOf: – #/definitions/pendency description: Objeto que presenta uma pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getPendencyAccessUrl: post: description: Obtém a url de acesso de uma pendência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – flowToken properties: flowToken: type: object allOf: – #/definitions/flowToken description: Identificador de uma pendência. responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url de acesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessInstance: post: description: Obtém os as informações de uma instância de processo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processInstance properties: processInstance: type: integer format: int64 description: Identificador da instaância de Processo responses: 200: description: Ok schema: type: object required: – processInstance properties: processInstance: type: object allOf: – #/definitions/processInstance description: Objeto que representa uma instancia de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os as informações de uma instância de processo tags: – Queries x-senior-visibility: PUBLIC parameters: – name: processInstance description: Identificador da instaância de Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – processInstance properties: processInstance: type: object allOf: – #/definitions/processInstance description: Objeto que representa uma instancia de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getAllProcessInstances: post: description: Obtém as informações de todas as instâncias de processos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – order properties: page: type: integer format: int64 description: Página a ser consultada default: 0 pageSize: type: integer format: int64 description: Quantidade de itens na página default: 10 order: type: string allOf: – #/definitions/orderDirection description: Ordenação responses: 200: description: Ok schema: type: object required: – processInstances properties: processInstances: type: array items: type: object allOf: – #/definitions/processInstance minimum: 1 description: instancias de processo totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessInstanceHistory: post: description: Obtém o histórico de uma pendência. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstance properties: processInstance: type: integer format: int64 description: Identificador da instância de Processo responses: 200: description: Ok schema: type: object required: – processInstanceHistory properties: processInstanceHistory: type: string description: Histórico da instância de processo em um formato JSON 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o histórico de uma pendência. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstance description: Identificador da instância de Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – processInstanceHistory properties: processInstanceHistory: type: string description: Histórico da instância de processo em um formato JSON 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getRequestHistoryResume: post: description: Obtém o extrato de um solicitação. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceID properties: processInstanceID: type: integer format: int64 description: Identificador da instância de Processo responses: 200: description: Ok schema: type: object allOf: – #/definitions/requestHistoryResume 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o extrato de um solicitação. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceID description: Identificador da instância de Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/requestHistoryResume 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getAllRequestHistory: post: description: Obtém o histórico de todas as solicitações paginado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – pageSize properties: page: type: integer format: int64 description: Página ser consultada pageSize: type: integer format: int64 description: Quantidade de itens na página filter: type: object allOf: – #/definitions/requestHistoryEntry description: Filtro responses: 200: description: Ok schema: type: object required: – content properties: totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas content: type: array items: type: object allOf: – #/definitions/requestHistoryEntry minimum: 1 description: Histórico das solicitações 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getRequestHistoryTimeline: post: description: Obtém uma linha do tempo com o registro de ações e observações de uma solicitação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processInstanceID properties: processInstanceID: type: integer format: int64 description: Identificador da instância de Processo responses: 200: description: Ok schema: type: object required: – processName – timeline properties: processName: type: string description: Nome do processo timeline: type: array items: type: object allOf: – #/definitions/requestHistoryTimelineEntry minimum: 1 description: Representação da linha do tempo da solicitação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém uma linha do tempo com o registro de ações e observações de uma solicitação tags: – Queries x-senior-visibility: PUBLIC parameters: – name: processInstanceID description: Identificador da instância de Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – processName – timeline properties: processName: type: string description: Nome do processo timeline: type: array items: type: object allOf: – #/definitions/requestHistoryTimelineEntry minimum: 1 description: Representação da linha do tempo da solicitação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getNextSubject: post: description: Obtém um ou mais responsáveis possíveis da próxima tarefa. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken – sequenceName properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Token com informações da etapa do fluxo em andamento sequenceName: type: string description: Nome da Sequencia do Processo Modealdor authorization: type: string description: Token de autenticação da G7 responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: type: array items: type: object allOf: – #/definitions/serviceSubject minimum: 1 description: sujeitos que podem receber a atribuição dependsOnNextStep: type: boolean description: Depende da execução do próxima etapa para identificar a atribuição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getNextSubjectFromInitialTask: post: description: Obtém um ou mais responsáveis possíveis da próxima tarefa em relação a tarefa inicial do processo. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processId – sequenceName properties: processId: type: integer format: int64 description: Identificador do Processo processVersion: type: integer format: int64 description: Versão do Processo sequenceName: type: string description: Nome da Sequencia do Processo Modealdor customParams: type: array items: type: object allOf: – #/definitions/keyValueRecord description: Parametros para Mecanismo Customizado authorization: type: string description: Token de autenticação da G7 requester: type: string description: Usuário solicitante responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: type: array items: type: object allOf: – #/definitions/serviceSubject minimum: 1 description: sujeitos que podem receber a atribuição dependsOnNextStep: type: boolean description: Depende da execução do próxima etapa para identificar a atribuição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getNextAssignment: post: description: Obtém responsáveis pelo mecanismo de atribuição. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type – value properties: type: type: string allOf: – #/definitions/assignmentType description: Tipo do Mecanismo de Associação value: type: string description: Valor de acordo com o tipo de Mecanismo de atribuição combination: type: array items: type: object allOf: – #/definitions/assignmentItem description: Parametros para mecanismo de atribuição por associação customParams: type: array items: type: object allOf: – #/definitions/keyValueRecord description: Parametros para mecanismo de atribuição customizado subjectKind: type: string allOf: – #/definitions/subjectKind description: Tipo do sujeito para variable de processos processInstanceId: type: integer format: int64 description: Identificador de uma instância do processo para carregamento de dados do fluxo responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: type: array items: type: object allOf: – #/definitions/serviceSubject minimum: 1 description: Sujeitos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getNextAssignmentCustom: post: description: Interface para Mecanismo de Atribuição Customizado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: customParams: type: array items: type: object allOf: – #/definitions/keyValueRecord description: Lisa de Parametros em formato chave-valor responses: 200: description: Ok schema: type: object required: – assignUsers properties: assignUsers: type: array items: type: string minimum: 1 description: Lista de Usuários obtido pelo Mecanismo de Atribuição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getNextAssignmentCustomG5: post: description: Interface para Mecanismo de Atribuição Customizado G5. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: customParams: type: array items: type: object allOf: – #/definitions/keyValueRecord description: Lisa de Parametros em formato chave-valor responses: 200: description: Ok schema: type: object required: – assignUsers properties: assignUsers: type: array items: type: string minimum: 1 description: Lista de Usuários obtido pelo Mecanismo de Atribuição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getPendencyProcessActions: post: description: Obtém as opções disponíveis para execução de uma pendência. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: FlowToken responses: 200: description: Ok schema: type: object required: – pendencyProcessAction properties: pendencyProcessAction: type: array items: type: object allOf: – #/definitions/processAction minimum: 1 description: Ações da pendência do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getPendencyProcessActionsFromInitialTask: post: description: Obtém as opções disponíveis para execução de uma pendência a partir da tarefa inicial do processo. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: ID Processo processVersion: type: integer format: int64 description: Versão do Processo responses: 200: description: Ok schema: type: object required: – pendencyProcessAction properties: pendencyProcessAction: type: array items: type: object allOf: – #/definitions/processAction minimum: 1 description: Ações do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém as opções disponíveis para execução de uma pendência a partir da tarefa inicial do processo. tags: – Queries x-senior-visibility: PUBLIC parameters: – name: processId description: ID Processo in: query required: true type: integer format: int64 – name: processVersion description: Versão do Processo in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – pendencyProcessAction properties: pendencyProcessAction: type: array items: type: object allOf: – #/definitions/processAction minimum: 1 description: Ações do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getFormAccessProperties: post: description: Obtém as informações de acesso de um formulário necessárias para iniciar ou responder um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processState properties: processState: type: string allOf: – #/definitions/processState description: Estado do processo serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Identificação da pendência processId: type: integer format: int64 description: Id do processo authorization: type: string description: String de autorização para integrações bpmSqsToken: type: string description: UUID do contexto do SQS responses: 200: description: Ok schema: type: object properties: accessPropertiesResponse: type: object allOf: – #/definitions/accessPropertiesResponse description: informações de acesso do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getPendenciesExpirationStatusReport: post: description: Obtém estatísticas da situação atual das tarefas (em dia, vencendo hoje e em atraso) tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – volumes properties: volumes: type: array items: type: object allOf: – #/definitions/reportPendencyExpirationStatusVolume minimum: 1 description: Situação atual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém estatísticas da situação atual das tarefas (em dia, vencendo hoje e em atraso) tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – volumes properties: volumes: type: array items: type: object allOf: – #/definitions/reportPendencyExpirationStatusVolume minimum: 1 description: Situação atual 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessStepsVolumeByPeriodReport: post: description: Obtém estatísticas sobre o volume de movimentos dos processos em um período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: start: type: string format: date-time description: Data início end: type: string format: date-time description: Data fim limit: type: integer format: int64 description: Limite de itens responses: 200: description: Ok schema: type: object required: – start – end – processes properties: start: type: string format: date-time description: Data início end: type: string format: date-time description: Data fim processes: type: array items: type: object allOf: – #/definitions/reportProcessMovementsVolume minimum: 1 description: Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém estatísticas sobre o volume de movimentos dos processos em um período tags: – Queries x-senior-visibility: PRIVATE parameters: – name: start description: Data início in: query type: string format: date-time – name: end description: Data fim in: query type: string format: date-time – name: limit description: Limite de itens in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – start – end – processes properties: start: type: string format: date-time description: Data início end: type: string format: date-time description: Data fim processes: type: array items: type: object allOf: – #/definitions/reportProcessMovementsVolume minimum: 1 description: Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getTasksByStepsAndProcess: post: description: Obtém estatísticas sobre o volume de tarefas em cada etapa de acordo com o processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: ID Processo start: type: string format: date-time description: Data início variable: type: string description: Variáveis variableValue: type: string description: Valor variáveis limit: type: integer format: int64 description: Limite itens responses: 200: description: Ok schema: type: object required: – prcNam – volumes properties: prcNam: type: string description: Nome do Processo volumes: type: array items: type: object allOf: – #/definitions/reportTasksByStepsAndProcess minimum: 1 description: Tarefas do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém estatísticas sobre o volume de tarefas em cada etapa de acordo com o processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: ID Processo in: query required: true type: integer format: int64 – name: start description: Data início in: query type: string format: date-time – name: variable description: Variáveis in: query type: string – name: variableValue description: Valor variáveis in: query type: string – name: limit description: Limite itens in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – prcNam – volumes properties: prcNam: type: string description: Nome do Processo volumes: type: array items: type: object allOf: – #/definitions/reportTasksByStepsAndProcess minimum: 1 description: Tarefas do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessExpirationVolumeReport: post: description: Obtém estatísticas sobre o volume de atrasos dos processos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – start – end – volumes properties: start: type: string format: date-time description: Data início end: type: string format: date-time description: Data fim volumes: type: array items: type: object allOf: – #/definitions/reportProcessExpirationVolume minimum: 1 description: Estatísticas de atrasos de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém estatísticas sobre o volume de atrasos dos processos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – start – end – volumes properties: start: type: string format: date-time description: Data início end: type: string format: date-time description: Data fim volumes: type: array items: type: object allOf: – #/definitions/reportProcessExpirationVolume minimum: 1 description: Estatísticas de atrasos de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessVolumeReport: post: description: Obtém estatísticas sobre o volume dos processos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – start – end – volumes properties: start: type: string format: date-time description: Data início end: type: string format: date-time description: Data fim volumes: type: array items: type: object allOf: – #/definitions/reportProcessVolume minimum: 1 description: Volume de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém estatísticas sobre o volume dos processos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – start – end – volumes properties: start: type: string format: date-time description: Data início end: type: string format: date-time description: Data fim volumes: type: array items: type: object allOf: – #/definitions/reportProcessVolume minimum: 1 description: Volume de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessActivitiesReport: post: description: Obtém estatísticas sobre o volume dos atividades tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – volumes properties: volumes: type: array items: type: object allOf: – #/definitions/reportProcessActivities minimum: 1 description: Atividades de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém estatísticas sobre o volume dos atividades tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – volumes properties: volumes: type: array items: type: object allOf: – #/definitions/reportProcessActivities minimum: 1 description: Atividades de processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessActivityExpirationReport: post: description: Obtém estatísticas sobre expiração das atividades tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – volumes properties: volumes: type: array items: type: object allOf: – #/definitions/reportProcessExpirationActivity minimum: 1 description: Volume de atividades com expiração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém estatísticas sobre expiração das atividades tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – volumes properties: volumes: type: array items: type: object allOf: – #/definitions/reportProcessExpirationActivity minimum: 1 description: Volume de atividades com expiração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getSubjects: post: description: Obtém ou usuários e grupos conforme o tipo (usuário ou grupo). tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – type properties: page: type: integer format: int64 description: Página ser consultada pageSize: type: integer format: int64 description: Quantidade de itens na página nameFilter: type: string description: filtro pelo nome type: type: string allOf: – #/definitions/subjectKind description: Filtro por tipo includeRemoved: type: boolean description: Incluir usuários removidos default: false responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: type: array items: type: object allOf: – #/definitions/serviceSubject minimum: 1 description: Lista de Sujeitos totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getCockpitUrl: post: description: Obtém a URL do cockpit tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: path: type: string description: Endereço opcional para concatenar na URL embeddedUrl: type: boolean description: Indicador se a URL retornada irá abrir em um iFrame default: false responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url do cockpit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL do cockpit tags: – Queries x-senior-visibility: PRIVATE parameters: – name: path description: Endereço opcional para concatenar na URL in: query type: string – name: embeddedUrl description: Indicador se a URL retornada irá abrir em um iFrame in: query type: boolean responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url do cockpit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getEcmFormUrl: post: description: Obtém a URL do ECM Form tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url do ecm-form 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL do ECM Form tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url do ecm-form 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessEditorURL: post: description: Obtém a URL do editor de processos tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – url – simple properties: url: type: string description: Url do editor BPM simple: type: string description: Url do editor simplificado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL do editor de processos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – url – simple properties: url: type: string description: Url do editor BPM simple: type: string description: Url do editor simplificado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getPlatformURL: post: description: Obtém a URL da plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url da plataforma 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL da plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url da plataforma 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getECMExecutorURL: post: description: Obtém a URL do executor de formulários do ECM tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url do ecm-frontend 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL do executor de formulários do ECM tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Url do ecm-frontend 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getUserWorkGroup: post: description: Obtém o grupo de trabalho de um usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userId properties: userId: type: integer format: int64 description: Id usuário responses: 200: description: Ok schema: type: object required: – workGroup properties: workGroup: type: object allOf: – #/definitions/serviceSubject description: Grupo do usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o grupo de trabalho de um usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: userId description: Id usuário in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – workGroup properties: workGroup: type: object allOf: – #/definitions/serviceSubject description: Grupo do usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getUsersWorkGroup: post: description: Grupos de trabalho do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Pagina a ser consultada pageSize: type: integer format: int64 description: Quantidade de itens na página nameFilter: type: string description: filtro pelo nome responses: 200: description: Ok schema: type: object required: – usersWorkGroup properties: usersWorkGroup: type: array items: type: object allOf: – #/definitions/userWorkGroup minimum: 1 description: Grupo do usuário totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Número de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Grupos de trabalho do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Pagina a ser consultada in: query type: integer format: int64 – name: pageSize description: Quantidade de itens na página in: query type: integer format: int64 – name: nameFilter description: filtro pelo nome in: query type: string responses: 200: description: Ok schema: type: object required: – usersWorkGroup properties: usersWorkGroup: type: array items: type: object allOf: – #/definitions/userWorkGroup minimum: 1 description: Grupo do usuário totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Número de páginas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getNextProcessInstanceId: post: description: Obtém o próximo identificador de instância de processo disponível. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – processInstanceID properties: processInstanceID: type: integer format: int64 description: Id instância do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o próximo identificador de instância de processo disponível. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – processInstanceID properties: processInstanceID: type: integer format: int64 description: Id instância do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listProcessesErrors: post: description: Lista os registros de erros de execução de processo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Pagina a ser consultada default: 0 pageSize: type: integer format: int64 description: Quantidade de itens na página default: 10 responses: 200: description: Ok schema: type: object required: – errors properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas errors: type: array items: type: object allOf: – #/definitions/processError minimum: 1 description: Erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os registros de erros de execução de processo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Pagina a ser consultada in: query type: integer format: int64 – name: pageSize description: Quantidade de itens na página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – errors properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas errors: type: array items: type: object allOf: – #/definitions/processError minimum: 1 description: Erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listRecoveredProcesses: post: description: Lista os erros de execução de processo recuperados. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: page: type: integer format: int64 description: Pagina a ser consultada default: 0 pageSize: type: integer format: int64 description: Quantidade de itens na página default: 10 responses: 200: description: Ok schema: type: object required: – processes properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas processes: type: array items: type: object allOf: – #/definitions/recoveredProcess minimum: 1 description: Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os erros de execução de processo recuperados. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Pagina a ser consultada in: query type: integer format: int64 – name: pageSize description: Quantidade de itens na página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – processes properties: totalElements: type: integer format: int64 description: Total de elementos totalPages: type: integer format: int64 description: Total de páginas processes: type: array items: type: object allOf: – #/definitions/recoveredProcess minimum: 1 description: Processos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getContextVariableByProcess: post: description: Obtem as Variaveis de Contexto do Processo para exibição no Cockpit tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Número do Processo responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/contextVariable minimum: 1 description: Lista de Variaveis de Contexto do Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem as Variaveis de Contexto do Processo para exibição no Cockpit tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Número do Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/contextVariable minimum: 1 description: Lista de Variaveis de Contexto do Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getInfoFromProcessVariables: post: description: Obtem informções das variaveis de processo da instancia de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Instancia do Processo responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/keyValueTypeRecord minimum: 1 description: Lista de Variaveis de Contexto do Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem informções das variaveis de processo da instancia de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceId description: Instancia do Processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/keyValueTypeRecord minimum: 1 description: Lista de Variaveis de Contexto do Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/listProcessTemplate: post: description: Lista os templates do workflow para processos simples tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/processTemplate minimum: 1 description: Lista de Templates 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os templates do workflow para processos simples tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/processTemplate minimum: 1 description: Lista de Templates 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getTagsByProcess: post: description: Retorna lista de categorias associa aos processos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: processes: type: array items: type: integer format: int64 description: Lista com os identificados dos processos responses: 200: description: Ok schema: type: object properties: tags: type: array items: type: object allOf: – #/definitions/tagResume description: Lista de categorias agrupadas por processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de categorias associa aos processos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processes description: Lista com os identificados dos processos in: query type: array items: type: integer format: int64 responses: 200: description: Ok schema: type: object properties: tags: type: array items: type: object allOf: – #/definitions/tagResume description: Lista de categorias agrupadas por processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getUserGrantedTags: post: description: Retorna lista de tags dos processos que o usuário possui permissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: onlyActiveProcesses: type: boolean description: Filtrar apenas processos ativos default: true responses: 200: description: Ok schema: type: object required: – processCount – processWithoutTagCount – tags properties: processCount: type: integer format: int64 description: Total de processos processWithoutTagCount: type: integer format: int64 description: Quantidade de processos sem tag tags: type: array items: type: object allOf: – #/definitions/tagResume minimum: 1 description: Tags 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna lista de tags dos processos que o usuário possui permissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: onlyActiveProcesses description: Filtrar apenas processos ativos in: query type: boolean responses: 200: description: Ok schema: type: object required: – processCount – processWithoutTagCount – tags properties: processCount: type: integer format: int64 description: Total de processos processWithoutTagCount: type: integer format: int64 description: Quantidade de processos sem tag tags: type: array items: type: object allOf: – #/definitions/tagResume minimum: 1 description: Tags 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/hasUnsynchronisedAttachments: post: description: Informa se existem documentos não sincronizados com o GED tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Identificador da instância de processo a qual o arquivo pertence. responses: 200: description: Ok schema: type: object required: – hasUnsynchronisedAttachments properties: hasUnsynchronisedAttachments: type: boolean description: Informa se existem documentos não sincronizados com o GED 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Informa se existem documentos não sincronizados com o GED tags: – Queries x-senior-visibility: PUBLIC parameters: – name: processInstanceId description: Identificador da instância de processo a qual o arquivo pertence. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – hasUnsynchronisedAttachments properties: hasUnsynchronisedAttachments: type: boolean description: Informa se existem documentos não sincronizados com o GED 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/hasProcessUnsynchronisedAttachments: post: description: Informa se existem documentos não sincronizados com o GED tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do processo a qual os arquivos pertence. responses: 200: description: Ok schema: type: object required: – hasUnsynchronisedAttachments properties: hasUnsynchronisedAttachments: type: boolean description: Informa se existem documentos não sincronizados com o GED 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Informa se existem documentos não sincronizados com o GED tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do processo a qual os arquivos pertence. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – hasUnsynchronisedAttachments properties: hasUnsynchronisedAttachments: type: boolean description: Informa se existem documentos não sincronizados com o GED 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessChanges: post: description: Lista as alterações de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do processo page: type: integer format: int64 description: Página ser consultada default: 0 pageSize: type: integer format: int64 description: Quantidade de itens na página default: 10 responses: 200: description: Ok schema: type: object required: – processChanges properties: totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas processChanges: type: array items: type: object allOf: – #/definitions/processChanges minimum: 1 description: Lista de alterações do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as alterações de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do processo in: query required: true type: integer format: int64 – name: page description: Página ser consultada in: query type: integer format: int64 – name: pageSize description: Quantidade de itens na página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – processChanges properties: totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas processChanges: type: array items: type: object allOf: – #/definitions/processChanges minimum: 1 description: Lista de alterações do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getDashboardUserProcess: post: description: Obtem um Dashboard do Usuário com dados dos processos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – publishedProcess – pendingRequest – tasks – expiredTasks properties: publishedProcess: type: integer format: int64 description: Número de processos publicados pendingRequest: type: integer format: int64 description: Número requisições pendentes tasks: type: integer format: int64 description: Número tarefas expiredTasks: type: integer format: int64 description: Número tarefas expiradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem um Dashboard do Usuário com dados dos processos tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – publishedProcess – pendingRequest – tasks – expiredTasks properties: publishedProcess: type: integer format: int64 description: Número de processos publicados pendingRequest: type: integer format: int64 description: Número requisições pendentes tasks: type: integer format: int64 description: Número tarefas expiredTasks: type: integer format: int64 description: Número tarefas expiradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getAttachments: post: description: Recupera todos os anexos de uma instância de processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstance properties: processInstance: type: integer format: int64 description: Id da instância do processo responses: 200: description: Ok schema: type: object required: – attachments properties: attachments: type: array items: type: object allOf: – #/definitions/serviceAttachment minimum: 1 description: Lista de anexos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera todos os anexos de uma instância de processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstance description: Id da instância do processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – attachments properties: attachments: type: array items: type: object allOf: – #/definitions/serviceAttachment minimum: 1 description: Lista de anexos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/requestAttachmentAccess: post: description: Requisita acesso a um determinado arquivo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do arquivo responses: 200: description: Ok schema: type: object required: – accessUrl properties: accessUrl: type: string description: URL de acesso ao arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Requisita acesso a um determinado arquivo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id do arquivo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – accessUrl properties: accessUrl: type: string description: URL de acesso ao arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/requestAttachmentsNameSize: post: description: Retorna nome e tamanho dos anexos de acordo com a lista de id passado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: string minimum: 1 description: Identificadores dos anexos a serem consultados. responses: 200: description: Ok schema: type: object required: – attachments properties: attachments: type: array items: type: object allOf: – #/definitions/serviceAttachment minimum: 1 description: Lista de arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna nome e tamanho dos anexos de acordo com a lista de id passado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ids description: Identificadores dos anexos a serem consultados. in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – attachments properties: attachments: type: array items: type: object allOf: – #/definitions/serviceAttachment minimum: 1 description: Lista de arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getComments: post: description: Obtem os comentários de um instância de processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceID properties: processInstanceID: type: integer format: int64 description: Id da instância do processo responses: 200: description: Ok schema: type: object required: – comments properties: comments: type: array items: type: object allOf: – #/definitions/comment minimum: 1 description: Comentários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem os comentários de um instância de processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceID description: Id da instância do processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – comments properties: comments: type: array items: type: object allOf: – #/definitions/comment minimum: 1 description: Comentários 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/loadFromProcessTemplate: post: description: Ler informações para montagem de um processo do workflow a partir da uri de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – templateId properties: templateId: type: integer format: int64 description: Número do Processo Template responses: 200: description: Ok schema: type: object required: – processModel – processMetadata properties: processModel: type: string description: Dados da modelagem do processo processMetadata: type: string description: Metadata do processo e componente associados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Ler informações para montagem de um processo do workflow a partir da uri de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: templateId description: Número do Processo Template in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – processModel – processMetadata properties: processModel: type: string description: Dados da modelagem do processo processMetadata: type: string description: Metadata do processo e componente associados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessDetailConfig: post: description: Pega a configuração do processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Id da instância do processo responses: 200: description: Ok schema: type: object required: – processType – config – fields properties: processType: type: string allOf: – #/definitions/processExecutionType description: Tipo do processo config: type: string description: Configuração para exibição dos dados do processo fields: type: string description: Visibilidade dos campos com base nas Variaveis de Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pega a configuração do processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceId description: Id da instância do processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – processType – config – fields properties: processType: type: string allOf: – #/definitions/processExecutionType description: Tipo do processo config: type: string description: Configuração para exibição dos dados do processo fields: type: string description: Visibilidade dos campos com base nas Variaveis de Processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getFieldsPermission: post: description: Permissões Campos da Solicitação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Id da instância do processo responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: string format: byte description: Permissão dos Campos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Permissões Campos da Solicitação tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceId description: Id da instância do processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: string format: byte description: Permissão dos Campos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/hasProcessPermission: post: description: Validar Permissão de um processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – type properties: processId: type: integer format: int64 description: Número do Processo type: type: string allOf: – #/definitions/processPermissionType description: Tipo de Permissão responses: 200: description: Ok schema: type: object required: – hasPermission properties: hasPermission: type: boolean description: Indica se tem permissão no processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/hasPermissionViewCompletedProcess: post: description: Verifica se o usuário atual tem permissão para visualizar uma pendência\n – Se for cordenador do processo = true\n – Se for o usuário que iniciou o processo = true\n – Se for o usuário foi envolvido em alguma etapa do processo = true\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Identificador de uma pendência. responses: 200: description: Ok schema: type: object required: – hasPermission properties: hasPermission: type: boolean description: Indica se tem permissão para visualizar o processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o usuário atual tem permissão para visualizar uma pendência\n – Se for cordenador do processo = true\n – Se for o usuário que iniciou o processo = true\n – Se for o usuário foi envolvido em alguma etapa do processo = true\n tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceId description: Identificador de uma pendência. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – hasPermission properties: hasPermission: type: boolean description: Indica se tem permissão para visualizar o processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getDailyNotification: post: description: Retorna a configuração de notificações agrupadas por processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Código do processo responses: 200: description: Ok schema: type: object required: – dailyNotification properties: dailyNotification: type: object allOf: – #/definitions/dailyNotification description: Lista de papéis de usuários para enviar notificação agrupada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a configuração de notificações agrupadas por processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Código do processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – dailyNotification properties: dailyNotification: type: object allOf: – #/definitions/dailyNotification description: Lista de papéis de usuários para enviar notificação agrupada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getIntegrationEvents: post: description: Retorna os eventos de integração com outros serviços tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do processo onlyErrors: type: boolean description: Exibir somente registro de erros default: false type: type: string allOf: – #/definitions/integrationEventType description: Tipo da integração page: type: integer format: int64 description: Página a ser consultada default: 0 pageSize: type: integer format: int64 description: Quantidade de itens na página default: 10 startDate: type: string format: date-time description: Data inicio endDate: type: string format: date-time description: Data final processInstanceId: type: integer format: int64 description: Identificador da instância do processo responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas integrationEvents: type: array items: type: object allOf: – #/definitions/integrationEvent description: Lista de eventos de integração 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getServiceIntegrationByConector: post: description: Retorna o serviço externo com base no conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – conectorId properties: conectorId: type: string description: Id do conector conectorConfigurationId: type: string description: Id da configuração do conector responses: 200: description: Ok schema: type: object required: – serviceId properties: serviceId: type: string description: Serviço externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o serviço externo com base no conector tags: – Queries x-senior-visibility: PRIVATE parameters: – name: conectorId description: Id do conector in: query required: true type: string – name: conectorConfigurationId description: Id da configuração do conector in: query type: string responses: 200: description: Ok schema: type: object required: – serviceId properties: serviceId: type: string description: Serviço externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getServiceIntegrationByName: post: description: Retorna o serviço externo com base no nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Id do conector responses: 200: description: Ok schema: type: object required: – serviceId properties: serviceId: type: string description: Serviço externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o serviço externo com base no nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Id do conector in: query required: true type: string responses: 200: description: Ok schema: type: object required: – serviceId properties: serviceId: type: string description: Serviço externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getServiceIntegrationEvent: post: description: Retorna os eventos logados de serviços externos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – type properties: processId: type: integer format: int64 description: Código do processo type: type: array items: type: string allOf: – #/definitions/IntegrationServiceEventType minimum: 1 description: tipo de evento page: type: integer format: int64 description: Página ser consultada default: 0 pageSize: type: integer format: int64 description: Quantidade de itens na página default: 10 responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas serviceIntegrationEvent: type: array items: type: object allOf: – #/definitions/serviceIntegrationEvent description: Lista de eventos logados de serviços eternos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/isConectorConfigured: post: description: Retorna quais conectores informados via parâmetro estão devidamente configurados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – conectorId properties: conectorId: type: array items: type: string minimum: 1 description: ID do conector responses: 200: description: Ok schema: type: object required: – conectorConfigureds properties: conectorConfigureds: type: array items: type: object allOf: – #/definitions/conectorConfigured minimum: 1 description: Conectores configurados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna quais conectores informados via parâmetro estão devidamente configurados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: conectorId description: ID do conector in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – conectorConfigureds properties: conectorConfigureds: type: array items: type: object allOf: – #/definitions/conectorConfigured minimum: 1 description: Conectores configurados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/loadUserNotificationPreferences: post: description: Retorna a lista de preferências de notificação do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – platformPreferences – emailPreferences properties: platformPreferences: type: object allOf: – #/definitions/notificationPreferences description: Preferência de notificações da Plataforma Senior X emailPreferences: type: object allOf: – #/definitions/notificationPreferences description: Preferência de notificações via Email 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de preferências de notificação do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – platformPreferences – emailPreferences properties: platformPreferences: type: object allOf: – #/definitions/notificationPreferences description: Preferência de notificações da Plataforma Senior X emailPreferences: type: object allOf: – #/definitions/notificationPreferences description: Preferência de notificações via Email 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/loadProcessNotificationPreferences: post: description: Retorna a lista de preferências de notificação por processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Id do processo responses: 200: description: Ok schema: type: object required: – platformPreferences – emailPreferences properties: platformPreferences: type: object allOf: – #/definitions/notificationPreferences description: Preferência de notificações da Plataforma Senior X emailPreferences: type: object allOf: – #/definitions/notificationPreferences description: Preferência de notificações via Email 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de preferências de notificação por processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Id do processo in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – platformPreferences – emailPreferences properties: platformPreferences: type: object allOf: – #/definitions/notificationPreferences description: Preferência de notificações da Plataforma Senior X emailPreferences: type: object allOf: – #/definitions/notificationPreferences description: Preferência de notificações via Email 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getDefaultRoles: post: description: Obtém os papéis padrões tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: defaultRoles: type: array items: type: object allOf: – #/definitions/defaultRole description: Papéis padrões criados no Workflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os papéis padrões tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: defaultRoles: type: array items: type: object allOf: – #/definitions/defaultRole description: Papéis padrões criados no Workflow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getSubject: post: description: Obtém um subject tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – subjectId properties: subjectId: type: integer format: int64 description: Id do subject responses: 200: description: Ok schema: type: object allOf: – #/definitions/serviceSubject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém um subject tags: – Queries x-senior-visibility: PRIVATE parameters: – name: subjectId description: Id do subject in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/serviceSubject 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/requestFileUpload: post: description: Requisita as URLs para upload no blob service tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – fileName properties: id: type: string description: Identificador do Arquivo fileName: type: string description: Nome do Arquivo responses: 200: description: Ok schema: type: object required: – fileUpload properties: fileUpload: type: object allOf: – #/definitions/fileToUpload description: Modelo do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Requisita as URLs para upload no blob service tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do Arquivo in: query required: true type: string – name: fileName description: Nome do Arquivo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fileUpload properties: fileUpload: type: object allOf: – #/definitions/fileToUpload description: Modelo do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/requestFileAccess: post: description: Requisita Url de acesso ao arquivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – fileName – version properties: id: type: string description: identificador Arquivo fileName: type: string description: Nome do Arquivo type: string description: Versão do arquivo availableTime: type: integer format: int64 description: Tempo que o arquivo tera o acesso disponivel em milissegundos default: 30000 responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: url para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Requisita Url de acesso ao arquivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: identificador Arquivo in: query required: true type: string – name: fileName description: Nome do Arquivo in: query required: true type: string – name: version description: Versão do arquivo in: query required: true type: string – name: availableTime description: Tempo que o arquivo tera o acesso disponivel em milissegundos in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: url para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getWorkflowFeatureToggle: post: description: Retorna o status do Feature Toggle passado por parametro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – featureToggle properties: featureToggle: type: string description: Nome do Feature Toggle responses: 200: description: Ok schema: type: object required: – isEnabled properties: isEnabled: type: boolean description: Status do Feature Toggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o status do Feature Toggle passado por parametro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: featureToggle description: Nome do Feature Toggle in: query required: true type: string responses: 200: description: Ok schema: type: object required: – isEnabled properties: isEnabled: type: boolean description: Status do Feature Toggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessHistory: post: description: Consulta alterações no processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do proceso a ser consultado offset: type: integer format: int64 description: Página a ser consultada default: 0 size: type: integer format: int64 description: Quantidade de itens na página default: 10 responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas contents: type: array items: type: object allOf: – #/definitions/processHistoryDTO description: Lista de alterações no processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta alterações no processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do proceso a ser consultado in: query required: true type: integer format: int64 – name: offset description: Página a ser consultada in: query type: integer format: int64 – name: size description: Quantidade de itens na página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: totalElements: type: integer format: int64 description: Total de Itens totalPages: type: integer format: int64 description: Total de Paginas contents: type: array items: type: object allOf: – #/definitions/processHistoryDTO description: Lista de alterações no processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getPdlValue: post: description: Retorna o valor da PDL enviada por parametro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pdl properties: pdl: type: string description: Pdl a ter o valor retornado responses: 200: description: Ok schema: type: object required: – pdlValue properties: pdlValue: type: string description: Retorna o valor da PDL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o valor da PDL enviada por parametro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: pdl description: Pdl a ter o valor retornado in: query required: true type: string responses: 200: description: Ok schema: type: object required: – pdlValue properties: pdlValue: type: string description: Retorna o valor da PDL 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getProcessByEntityName: post: description: Busca os processos pelo nome do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName properties: entityName: type: string description: Nome da entidade (Formulário) responses: 200: description: Ok schema: type: object required: – processByEntityNameRecord properties: processByEntityNameRecord: type: array items: type: object allOf: – #/definitions/processByEntityNameRecord minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os processos pelo nome do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade (Formulário) in: query required: true type: string responses: 200: description: Ok schema: type: object required: – processByEntityNameRecord properties: processByEntityNameRecord: type: array items: type: object allOf: – #/definitions/processByEntityNameRecord minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getAllTasks: post: description: Lista todas as tarefas em aberto e fechadas a partir da data da última consulta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – tasks properties: tasks: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: Lista de tarefas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todas as tarefas em aberto e fechadas a partir da data da última consulta tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – tasks properties: tasks: type: array items: type: object allOf: – #/definitions/task minimum: 1 description: Lista de tarefas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getCustomTabs: post: description: Retorna uma lista de abas com base no processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Processo que a aba deve ser incluida responses: 200: description: Ok schema: type: object required: – tabs properties: tabs: type: array items: type: object allOf: – #/definitions/customTab minimum: 1 description: Abas com base na instância processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de abas com base no processo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processInstanceId description: Processo que a aba deve ser incluida in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tabs properties: tabs: type: array items: type: object allOf: – #/definitions/customTab minimum: 1 description: Abas com base na instância processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/findProcessByName: post: description: Busca um processo pelo nome do mesmo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processName properties: processName: type: string description: Nome do processo para buscar responses: 200: description: Ok schema: type: object required: – processId – processVersion properties: processId: type: integer format: int64 description: ID do processo processVersion: type: integer format: int64 description: Ultima versão do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca um processo pelo nome do mesmo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processName description: Nome do processo para buscar in: query required: true type: string responses: 200: description: Ok schema: type: object required: – processId – processVersion properties: processId: type: integer format: int64 description: ID do processo processVersion: type: integer format: int64 description: Ultima versão do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getHookEvents: post: description: Obter eventos de hook tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – hooks properties: hooks: type: array items: type: object allOf: – #/definitions/hookEventRecord minimum: 1 description: Lista de eventos de hook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obter eventos de hook tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – hooks properties: hooks: type: array items: type: object allOf: – #/definitions/hookEventRecord minimum: 1 description: Lista de eventos de hook 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/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 /workflow/queries/exportCustomAssignment: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportProcessEcm: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportGeneralProcessConfig: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportContextVariable: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportContextVariableData: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportContextDetail: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportRequestHistory: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportCalendar: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportHoliday: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportNotificationPreferences: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportTag: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportProcessConfig: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportProcessReportStatus: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportActivity: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportFeatureToggle: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportProcessThumbnail: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportProcessDocumentConfig: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportPublishedDocumentControl: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportRating: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportProcessSignConfig: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportEnvelope: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/exportEnvelopeDocument: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/startRequest: post: description: Inicia uma requisição no bpm tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processId – businessData properties: processId: type: integer format: int64 description: Identificador do processo businessData: type: string format: byte description: Objeto com as variáveis de Negócio do Processo, ex: businessData: { campo1: valor1, campo2: 2 } actionToExecute: type: string description: Nome da ação a ser tomada dentro do fluxo, obrigatório caso possua mais de uma ação possível nextSubject: type: string description: Responsável que vai receber a próxima ação, obrigatório caso o mecanismo de atribuição retorne mais de um responsável userInCopy: type: integer format: int64 description: Responsável em cópia que vai receber a próxima ação, obrigatório caso o mecanismo de atribuição retorne mais de um responsável externalServiceAuthorization: type: string description: Token de autorização para integração com Serviços Externos, caso necessário type: string description: Título opcional da solicitação requester: type: string description: Usuário solicitante, caso a solicitação esteja sendo feita em nome de outro usuário responses: 200: description: Ok schema: type: object required: – processInstanceID properties: processInstanceID: type: integer format: int64 description: Instância de Processo criada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente. 401: description: Usuário ou senha inválido. default: description: Error response schema: #/definitions/genericError /workflow/actions/treatTask: post: description: Response uma tarefa no bpm tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceID – step – activityId – businessData properties: processInstanceID: type: integer format: int64 description: Identificador da Instância do Proceso step: type: integer format: int64 description: Identificador da Etapa do Processo activityId: type: integer format: int64 description: Identificador da Atividade businessData: type: string format: byte description: Objeto com as variáveis de Negócio do Processo, ex: businessData: { campo1: valor1, campo2: 2 } actionToExecute: type: string description: Nome da ação a ser tomada dentro do fluxo, obrigatório caso possua mais de uma ação possível nextSubject: type: string description: Usuário que pode receber a próxima ação, obrigatório caso o mecanismo de atribuição retorne mais de um responsável userInCopy: type: integer format: int64 description: Usuário em cópia que pode receber a próxima ação, obrigatório caso o mecanismo de atribuição retorne mais de um responsável comment: type: string description: Comentário a ser adicionado no histórico da solicitação externalServiceAuthorization: type: string description: Token de autorização para integração com Serviços Externos, caso necessário responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente. 401: description: Usuário ou senha inválido. 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /workflow/actions/retrySyncDocument: post: description: Tenta sincronizar documento com o GED novamente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentId properties: documentId: type: string description: Id do documento a ser enviado responses: 200: description: Ok schema: type: object required: – documentSent properties: documentSent: type: boolean description: Caso o documento tenha sido enviado para o ged para iniciar a sincronização 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/processRating: post: description: Avalia um processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – rate properties: processId: type: integer format: int64 description: Id do processo rate: type: integer format: int64 description: Nota da avaliação comment: type: string description: Comentário da avaliação type: integer format: int64 description: Versão do processo activity: type: string description: Nome da atividade avaliada responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/changeProcessToNewForm: post: description: Altera o processo para utilizar o novo formulário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveProcessModel__2: post: description: Salva uma versão do processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – processModel properties: processId: type: integer format: int64 description: Número do Processo Publicado se existente processModel: type: object allOf: – #/definitions/uploadedFile description: Modelo do Processo Publicado migrateFromSimple: type: boolean description: Indica se deve migrar de um processo simples responses: 200: description: Ok schema: type: object required: – success – processId properties: success: type: boolean description: Indicador de sucesso na gravação processId: type: integer format: int64 description: Número do Processo Publicado se existente errors: type: array items: type: string description: Erros que impedem o salvamento do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/publishProcessModel__2: post: description: Publica uma versão do processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – processModel – processSvg properties: processId: type: integer format: int64 description: Número do Processo Publicado se existente processModel: type: object allOf: – #/definitions/uploadedFile description: Modelo do Processo Publicado processSvg: type: object allOf: – #/definitions/uploadedFile description: Modelo Visual do Processo thumbnail: type: object allOf: – #/definitions/uploadedFile description: Miniatura do Processo embedded: type: boolean description: Indica se o processo é embarcado migrateFromSimple: type: boolean description: Indica se deve migrar de um processo simples responses: 200: description: Ok schema: type: object required: – published properties: published: type: boolean description: se o processo foi publicado ou não processId: type: integer format: int64 description: Número do Processo processVersion: type: integer format: int64 description: Versão do Processo errors: type: array items: type: string description: Erros que impedem a publicação do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/excludeProcess: post: description: Excluir o processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Id do processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/updateViewGenerationConfig: post: description: Atualiza as informações sobre a geração de views tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – generateView properties: processId: type: integer format: int64 description: Id do processo generateView: type: boolean description: Caso verdadeiro gera a view imediatamente, caso falso remove a view viewName: type: string description: Nome da view a ser gerada processKey: type: string description: Nome da Chave do Processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/markPendencyAsReaded: post: description: Marcar a pendência como lida/não lida tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – readed – task properties: readed: type: boolean description: Lida task: type: object allOf: – #/definitions/serviceFlowToken description: Tarefa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/runProcessResumeReport: post: description: Executa o relatório de extrato do processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Instância do processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveProcessContextVariables: post: description: Salva as variáveis de processso/contexto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Id do processo variables: type: array items: type: object allOf: – #/definitions/contextVariable description: Lista de variáveis responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/cancelProcessExecution: post: description: Cancela uma lista de processos. – Deprecated tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ids – user – reason properties: ids: type: array items: type: integer format: int64 minimum: 1 description: Identificadores das instâncias de processo a serem canceladas. user: type: string description: Usuário responsável pelo cancelamento. reason: type: string description: Motivo do cancelamento. responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Mensagem de sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/cancelProcessInstance: post: description: Cancela uma lista de processos. tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ids – reason properties: ids: type: array items: type: integer format: int64 minimum: 1 description: Identificadores das instâncias de processo a serem canceladas. user: type: string description: Usuário responsável pelo cancelamento, deve ser informado quando for uma aplicação, quando não for aplicação esse campo é ignorado reason: type: string description: Motivo do cancelamento. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/ceaseProcessExecution: post: description: Conclui um processo em execução tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ids – user properties: ids: type: array items: type: integer format: int64 minimum: 1 description: Identificadores das instâncias de processo a serem canceladas user: type: string description: Usuário responsável pelo cancelamento responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de execução cancelada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/retryProcessExecution: post: description: Repete a execução de um processo. Utilizado em situações onde ocorreu um erro em uma das etapas de execução do processo (e.g. respondendo uma pendência) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tokens properties: tokens: type: array items: type: object allOf: – #/definitions/serviceFlowToken minimum: 1 description: Fluxo do processo responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/resolveProcessExecution: post: description: Retoma a execução de um processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: integer format: int64 minimum: 1 description: Ids de processos responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/assumePendency: post: description: Asume uma pendencia de um grupo ou papel para um para o usuário logado. Todas as pendências devem estar atribuídas a grupos. Não é permitido assumir pendências atribuídas a usuários tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Fluxo processo a ser assumido responses: 200: description: Ok schema: type: object required: – serviceFlowToken properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Fluxo assumido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/changePendencyUser: post: description: Atribui a pendência para outro usuário tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – serviceFlowTokens – subject properties: serviceFlowTokens: type: array items: type: object allOf: – #/definitions/serviceFlowToken minimum: 1 description: Lista dos identificadores da tarefas subject: type: object allOf: – #/definitions/serviceSubject description: Usuário, grupo ou papel alterar o responsável responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/changeTaskRequester: post: description: Altera solicitante da tarefa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userCode – processInstanceID properties: userCode: type: integer format: int64 description: Código do usuário processInstanceID: type: integer format: int64 description: Id da instância do processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/changeExpirationDate: post: description: Altera a data de expiração de uma lista de pendências. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – serviceFlowTokens properties: serviceFlowTokens: type: array items: type: object allOf: – #/definitions/serviceFlowToken minimum: 1 description: Lista de flow tokens para ajustar expirationDate: type: string format: date-time description: Informa a data de expiração ou null para deixar sem expirar responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/viewPendency: post: description: Retorna os parâmetros para visualização de uma pendência. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Fluxo do processo responses: 200: description: Ok schema: type: object required: – openNewWindow – formAction properties: openNewWindow: type: boolean description: Abrir em nova página formAction: type: string description: Ações do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/startProcess: post: description: Inicia um processo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processId – businessData – flowExecutionData properties: processInstanceID: type: integer format: int64 description: Quando o usuário quer definir o número da instância do processo. generateRecord: type: boolean description: Caso seja passado o processInstanceId, indica que a geração do record deve ser feita pelo BPM e não foi gerenciada externamente. default: false processId: type: integer format: int64 description: Número do processo processVersion: type: integer format: int64 description: Versão do Processo businessData: type: string description: Variáveis de Negócio do Processo flowExecutionData: type: object allOf: – #/definitions/flowExecutionData description: Informação para Fluxo de Execução do Processo authorization: type: string description: String de autorização executados da tarefas do workflow type: string description: Título opcional da solicitação requester: type: string description: Usuário solicitante externalServiceOverrideBusinessData: type: boolean description: Se existir um serviço externo antes da primeira etapa, o mesmo deve sobrescrever as variáveis enviadas no businessData default: true bpmSqsToken: type: string description: UUID do contexto do SQS responses: 200: description: Ok schema: type: object required: – processInstanceID properties: processInstanceID: type: integer format: int64 description: Instância de Processo criada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente. 401: description: Usuário ou senha inválido. default: description: Error response schema: #/definitions/genericError /workflow/actions/responsePendency: post: description: Responde uma pendência tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Token do Processo responseData: type: object allOf: – #/definitions/responseData description: Dados de uma ação de resposta de pendência authorization: type: string description: String de autorização executada da tarefa do workflow comment: type: string description: Comentário para solicitação bpmSqsToken: type: string description: UUID do contexto do SQS responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente. 401: description: Usuário ou senha inválido. 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /workflow/actions/batchPendenciesResponse: post: description: Responde pendências em lote tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – flowTokens – authorization properties: flowTokens: type: array items: type: object allOf: – #/definitions/flowToken minimum: 1 description: Tokens das pendências actionToExecute: type: string description: Ação a ser executada authorization: type: string description: Token de autenticação responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/enableProcess: post: description: Habilita ou desabilita uma lista de processos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processIds – enable properties: processIds: type: array items: type: integer format: int64 minimum: 1 description: Lista de ids de processos enable: type: boolean description: Habilita ou Desabilita responses: 200: description: Ok schema: type: object required: – modifiedProcess properties: modifiedProcess: type: integer format: int64 description: Número de processo modificados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveProcess: post: description: Salva um processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type – owner properties: type: type: string allOf: – #/definitions/processType description: Tipo do processo processId: type: integer format: int64 description: Identificador do processo name: type: string description: Nome do processo description: type: string description: Descrição owner: type: string description: dono do processo tag: type: string description: Categoria executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formUrl: type: string description: Url do formulário WEB formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado icon: type: string description: Icone do Processo taskVisibleAfterTreated: type: boolean description: Tarefa é visível após ser tratada enableRating: type: boolean description: Habilita avaliação para o processo attachTabVisibility: type: boolean description: Mostra ou oculta a tela de abas da solicitação thirdPartyPermission: type: boolean description: Define a permissão de edição do processo por terceiros que importam o processo enableUserInCopyConfig: type: boolean description: Habilita a funcionaidade Usuário em cópia requestSubjectMandatory: type: boolean description: Define se o campo de assunto da solicitação será obrigatório ou opcional responses: 200: description: Ok schema: type: object required: – processId – processVersion – success properties: processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo success: type: boolean description: Sucesso errors: type: array items: type: string description: Lista de erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveProcess__2: post: description: Salva um processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – type – owner properties: type: type: string allOf: – #/definitions/processType description: Tipo do processo processId: type: integer format: int64 description: Identificador do processo name: type: string description: Nome do processo description: type: string description: Descrição owner: type: string description: dono do processo tag: type: string description: Categoria executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formUrl: type: string description: Url do formulário WEB formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado icon: type: string description: Icone do Processo variableVisibility: type: string allOf: – #/definitions/variableVisibility description: Tarefa é visível após ser tratada enableRating: type: boolean description: Habilita avaliação para o processo attachTabVisibility: type: boolean description: Mostra ou oculta a tela de abas da solicitação thirdPartyPermission: type: boolean description: Define a permissão de edição do processo por terceiros que importam o processo enableUserInCopyConfig: type: boolean description: Habilita a funcionaidade Usuário em cópia requestSubjectMandatory: type: boolean description: Define se o campo de assunto da solicitação será obrigatório ou opcional responses: 200: description: Ok schema: type: object required: – processId – processVersion – success properties: processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo success: type: boolean description: Sucesso errors: type: array items: type: string description: Lista de erros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/generateView: post: description: Gera a visão de um processo e atualiza base relatórios. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Número do Proceosos responses: 200: description: Ok schema: type: object required: – ddl properties: ddl: type: string description: DDL da view gerada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveAndPublishSimpleProcessModel: post: description: Salva e publica uma vers�o do editor simplificado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processModel properties: processId: type: integer format: int64 description: id do processo processModel: type: string description: Modelo do processo processSvg: type: string description: svg com os dados do processo publish: type: boolean description: decide se o processo sera publicado default: true responses: 200: description: Ok schema: type: object required: – published – success properties: published: type: boolean description: se o processo foi publicado ou não processId: type: integer format: int64 description: id do processo processVersion: type: integer format: int64 description: vers�o do processo success: type: boolean description: Indicador de sucesso na gravação errors: type: array items: type: string description: Erros que impedem a publicação/salvamento do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveProcessModel: post: description: Salva uma versão do processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processModel properties: processId: type: integer format: int64 description: Número do Processo Publicado se existente processModel: type: string description: Modelo do Processo Publicado migrateFromSimple: type: boolean description: Indica se deve migrar de um processo simples responses: 200: description: Ok schema: type: object required: – success – processId properties: success: type: boolean description: Indicador de sucesso na gravação processId: type: integer format: int64 description: Número do Processo Publicado se existente errors: type: array items: type: string description: Erros que impedem o salvamento do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/publishProcessModel: post: description: Publica uma versão do processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processModel properties: processId: type: integer format: int64 description: Número do Processo Publicado se existente processModel: type: string description: Modelo do Processo Publicado processSvg: type: string description: Modelo Visual do Processo embedded: type: boolean description: Indica se o processo é embarcado migrateFromSimple: type: boolean description: Indica se deve migrar de um processo simples responses: 200: description: Ok schema: type: object required: – published properties: published: type: boolean description: se o processo foi publicado ou não processId: type: integer format: int64 description: Número do Processo processVersion: type: integer format: int64 description: Versão do Processo errors: type: array items: type: string description: Erros que impedem a publicação do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/setUsersWorkGroup: post: description: Adiciona novo grupo a usuários tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – usersIds – groupId properties: usersIds: type: array items: type: integer format: int64 minimum: 1 description: Lista de ids do usuários groupId: type: integer format: int64 description: Id do grupo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/newAttachment: post: description: Cria uma nova representação de um anexo do Workflow tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do arquivo a ser anexado size: type: integer format: int64 description: Tamanho do arquivo a ser anexado responses: 200: description: Ok schema: type: object required: – attachment – uploadUrl properties: attachment: type: object allOf: – #/definitions/serviceAttachment description: Anexo uploadUrl: type: string description: URL para o anexo 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido default: description: Error response schema: #/definitions/genericError /workflow/actions/commitAttachment: post: description: Faz commit de um anexo movendo ele da área temporária para permanente tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do anexo responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 404: description: Objeto não encontrado default: description: Error response schema: #/definitions/genericError /workflow/actions/linkAttachments: post: description: Liga determinados anexos a uma instância de processo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – ids – processInstance properties: ids: type: array items: type: string minimum: 1 description: Identificadores de anexo processInstance: type: integer format: int64 description: Identificador da instância de processo a qual o arquivo pertence. responsibleName: type: string description: Nome do responsavel caso seja um usuário de aplicação responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido default: description: Error response schema: #/definitions/genericError /workflow/actions/retryUnsynchronisedAttachments: post: description: Reenvia anexo não sincronizados com o GED tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Identificador da instância de processo a qual o arquivo pertence. responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido default: description: Error response schema: #/definitions/genericError /workflow/actions/retryProcessInstanceUnsynchronisedAttachments: post: description: Reenvia anexo não sincronizados com o GED tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processIntanceId properties: processIntanceId: type: integer format: int64 description: Identificador da solicitação a qual deve retentar enviar ao GED. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/deleteAttachment: post: description: Exclui um arquivo da base e do BlobService tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do anexo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/addComment: post: description: Adiciona um comentário em um processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – comment properties: comment: type: string description: Comentário processInstanceID: type: integer format: int64 description: Id da instância do processo created: type: string format: date-time description: Data de criação responses: 200: description: Ok schema: type: object allOf: – #/definitions/comment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/deleteComment: post: description: Remove um comentário em um processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Id responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/updateComment: post: description: Atualiza um comentário em um processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – comment properties: id: type: integer format: int64 description: Id do comentário comment: type: string description: Comentário processInstanceID: type: integer format: int64 description: Id da instância do processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/acceptTermsOfUse: post: description: Aceita os termos de uso do workflow tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/createFromProcessTemplate: post: description: Cria um processo a partir de um template BPM tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – templateId properties: templateId: type: integer format: int64 description: Número do Processo Template processName: type: string description: Nome do Novo Processo icon: type: string description: Ícone do processo responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: integer format: int64 description: ID do processo criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveUserNotificationPreferences: post: description: Salva as preferências de notificação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – platformPreferences – emailPreferences properties: platformPreferences: type: object allOf: – #/definitions/notificationPreferenceInput description: Preferência de notificações da Plataforma Senior X emailPreferences: type: object allOf: – #/definitions/notificationPreferenceInput description: Preferência de notificações via Email responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveProcessNotificationPreferences: post: description: Salva as preferências de notificação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – platformPreferences – emailPreferences properties: platformPreferences: type: object allOf: – #/definitions/notificationPreferenceInput description: Preferência de notificações da Plataforma Senior X emailPreferences: type: object allOf: – #/definitions/notificationPreferenceInput description: Preferência de notificações via Email responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/saveDailyNotification: post: description: Salva as configurações das notificações agrupadas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dailyNotification properties: dailyNotification: type: object allOf: – #/definitions/dailyNotification description: Lista de papéis de usuários para enviar notificação agrupada responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/createDefaultRoles: post: description: Cria papéis padrões do workflow com suas respectivas permissões. Papéis que já são existentes serão ignorados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/validateProcessMetadata: post: description: Verica se existem inconsistências entre os metadados de um processo e o tenant em que estes estejam sendo importados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – meta properties: meta: type: string description: Metadados do processo responses: 200: description: Ok schema: type: object required: – conflicts properties: conflicts: type: array items: type: object allOf: – #/definitions/conflict minimum: 1 description: Inconsistências encontradas nos metadados do processo em relação ao tenant (e.g. serviços, formulários ou fontes de dados com nomes conflitantes). 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/setEmbeddedProcess: post: description: Seta o processo como embarcado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – processVersion properties: processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorna se o valor foi alterado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importBusinessProcess: post: description: DEPRECADO – Importa um processo de negócio (usar importProcess) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processModel – processMetadata properties: processModel: type: string description: JSON com os dados da modelagem do processo processMetadata: type: string description: JSON contendo os metadados do processo processSvg: type: string description: SVG contendo a representação visual do processo conflicts: type: array items: type: object allOf: – #/definitions/handledConflict description: Decisões tomadas em relação aos conflitos entre os metadados do processo e o tenant em que a importação será realizada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se a importação foi realizada com sucesso message: type: string description: Mensagem descrevendo o resultado da importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importProcess: post: description: Importa um processo BPM a partir de uma url tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – url properties: url: type: string description: Url do zip do processo conflicts: type: array items: type: object allOf: – #/definitions/handledConflict description: Decisões tomadas em relação aos conflitos entre os metadados do processo e o tenant em que a importação será realizada objectVersionId: type: string description: Seta um campo sequencial quando o valor informado vem do template responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se a importação foi realizada com sucesso message: type: string description: Mensagem descrevendo o resultado da importação messageAsList: type: array items: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/enableFeatureToggle: post: description: Permite habilitar ou desabilitar o featureToggle sem acionar o time de SRE tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – feature – enable – pass properties: feature: type: string description: Name da feature que quer habilitar enable: type: boolean description: Indica se a funcionalidade esta habilitada pass: type: string description: Senha para permitir habilitar uma feature responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /workflow/actions/generatePcyDat: post: description: Atualiza o PCYDAT da instância do processo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId – step – activity – tenant properties: processInstanceId: type: integer format: int64 description: ID da instância do processo step: type: integer format: int64 description: Este da solicitação activity: type: integer format: int64 description: Este da solicitação tenant: type: string description: Tenant a ser executado responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /workflow/actions/updateTaskData: post: description: Atualiza os dados de uma tarefa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fields properties: fields: type: array items: type: object allOf: – #/definitions/taskDataFieldToUpdate minimum: 1 description: Campos a serem atualizados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/deleteTask: post: description: Deleta/inativa uma tarefa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Instancia de Processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/deleteTasksBatch: post: description: Deleta/inativa uma lista de tarefas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstancesId properties: processInstancesId: type: array items: type: integer format: int64 minimum: 1 description: Instancia de Processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/deleteTreatedTask: post: description: Deleta uma tarefa tratada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: integer format: int64 description: Instância do Processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/deleteTreatedTasksBatch: post: description: Deleta uma lista de tarefas tratada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId properties: processInstanceId: type: array items: type: integer format: int64 minimum: 1 description: Instâncias do Processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/setTasksDone: post: description: Atualiza o status das tarefas/solicitações para encerrada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstancesId properties: processInstancesId: type: array items: type: integer format: int64 minimum: 1 description: Instancias dos Processos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/createCustomTab: post: description: Cria aba personalizada na solicitação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processInstanceId – tabName – url properties: processInstanceId: type: integer format: int64 description: Processo que a aba deve ser incluida tabName: type: string description: Título da aba url: type: string description: Url a ser exibida na aba responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificado da aba 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/deleteCustomTab: post: description: Remove aba personalizada na solicitação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da aba responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/addHookEvent: post: description: Adiciona um evento de hook tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – eventUrl – eventType properties: eventUrl: type: string description: Url eventType: type: string description: Tipo do evento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/removeHookEvent: post: description: Remove um evento de hook tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importCustomAssignment: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importProcessEcm: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importGeneralProcessConfig: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importContextVariable: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importContextVariableData: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importContextDetail: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importRequestHistory: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importCalendar: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importHoliday: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importNotificationPreferences: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importTag: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importProcessConfig: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importProcessReportStatus: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importActivity: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importFeatureToggle: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importProcessThumbnail: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importProcessDocumentConfig: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importPublishedDocumentControl: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importRating: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importProcessSignConfig: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importEnvelope: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/actions/importEnvelopeDocument: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/signals/syncSubjects: post: description: Primitiva para sincronizar os dados quando algum problema ocorrer, atualmente sincroniza apenas usuários tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /workflow/signals/retryAllProcessUnsynchronisedAttachments: post: description: Reenvia anexo não sincronizados com o GED tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do processo a qual deve retentar enviar ao GED. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /workflow/signals/sendGroupedDailyNotification: post: description: Primitiva que dispara o envio de notificação agrupada com base nos grupos de usuários configurados tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: forProcesses: type: array items: type: integer format: int64 description: Enviar apenas para alguns processos específicos. Caso informado anula o excludeProcesses excludeProcesses: type: array items: type: integer format: int64 description: Enviar para todos, menos para estes processos force: type: boolean description: Força o envio da notificação para todos os usuários indiferente se já foi enviado no dia default: false sendCopyTo: type: string description: Permite enviar um e-mail para receber uma cópia do e-mail principal responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /workflow/signals/taskExpired: post: description: Evento de tratamento de tarefas expiradas. Apenas para uso interno. Ao chamar esta primitiva externamente nenhuma ação será executada tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/serviceFlowToken responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /workflow/signals/taskBeforeExpires: post: description: Evento de tratamento de tarefas antes de expirar. Apenas para uso interno. Ao chamar esta primitiva externamente nenhuma ação será executada tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/serviceFlowToken responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /workflow/signals/updateProcessEntityVersion: post: description: Atualiza a versão do formulário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – entityVersion – processIds properties: entityVersion: type: integer format: int64 description: Versão do formulário para qual será atualizada processIds: type: array items: type: integer format: int64 minimum: 1 description: IDs dos processos que serão atualizados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /workflow/signals/archiveData: post: description: Arquiva dados da base para o S3 tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenant – archiveDatatype properties: tenant: type: array items: type: string minimum: 1 description: tenant name archiveDatatype: type: string allOf: – #/definitions/archiveDataType description: Tipo de dados a ser arquivado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /workflow/signals/removeEnvironmentFromSubjectsName: post: description: Remove G5 ou G7 do nome do subject na base tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tenants properties: tenants: type: array items: type: string minimum: 1 description: Nomes dos tenants que devem ser atualizados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /workflow/entities/customAssignment: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customAssignment responses: 200: description: The created resource schema: #/definitions/customAssignment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/customAssignment responses: 200: description: The created resource schema: #/definitions/customAssignment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/customAssignment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/customAssignment/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customAssignment responses: 200: description: Ok schema: #/definitions/customAssignment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customAssignment responses: 200: description: Ok schema: #/definitions/customAssignment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/customAssignment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/customAssignment/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customAssignment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processEcm: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processEcm responses: 200: description: The created resource schema: #/definitions/processEcm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processEcm responses: 200: description: The created resource schema: #/definitions/processEcm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/processEcm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processEcm/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processEcm responses: 200: description: Ok schema: #/definitions/processEcm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processEcm responses: 200: description: Ok schema: #/definitions/processEcm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/processEcm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processEcm/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/processEcm responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/generalProcessConfig: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalProcessConfig responses: 200: description: The created resource schema: #/definitions/generalProcessConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/generalProcessConfig responses: 200: description: The created resource schema: #/definitions/generalProcessConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/generalProcessConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/generalProcessConfig/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/generalProcessConfig responses: 200: description: Ok schema: #/definitions/generalProcessConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/generalProcessConfig responses: 200: description: Ok schema: #/definitions/generalProcessConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/generalProcessConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/generalProcessConfig/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/generalProcessConfig responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/serviceIntegration: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/serviceIntegration responses: 200: description: The created resource schema: #/definitions/serviceIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/serviceIntegration responses: 200: description: The created resource schema: #/definitions/serviceIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/serviceIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/serviceIntegration/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/serviceIntegration responses: 200: description: Ok schema: #/definitions/serviceIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/serviceIntegration responses: 200: description: Ok schema: #/definitions/serviceIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/serviceIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/serviceIntegration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/serviceIntegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/paramService: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paramService responses: 200: description: The created resource schema: #/definitions/paramService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paramService responses: 200: description: The created resource schema: #/definitions/paramService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/paramService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/paramService/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paramService responses: 200: description: Ok schema: #/definitions/paramService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paramService responses: 200: description: Ok schema: #/definitions/paramService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paramService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/paramService/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paramService responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextVariable: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contextVariable responses: 200: description: The created resource schema: #/definitions/contextVariable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contextVariable responses: 200: description: The created resource schema: #/definitions/contextVariable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/contextVariable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextVariable/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contextVariable responses: 200: description: Ok schema: #/definitions/contextVariable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contextVariable responses: 200: description: Ok schema: #/definitions/contextVariable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contextVariable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextVariable/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contextVariable responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextVariableData: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contextVariableData responses: 200: description: The created resource schema: #/definitions/contextVariableData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contextVariableData responses: 200: description: The created resource schema: #/definitions/contextVariableData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/contextVariableData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextVariableData/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contextVariableData responses: 200: description: Ok schema: #/definitions/contextVariableData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contextVariableData responses: 200: description: Ok schema: #/definitions/contextVariableData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contextVariableData 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextVariableData/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contextVariableData responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextDetail: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contextDetail responses: 200: description: The created resource schema: #/definitions/contextDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contextDetail responses: 200: description: The created resource schema: #/definitions/contextDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/contextDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextDetail/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contextDetail responses: 200: description: Ok schema: #/definitions/contextDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contextDetail responses: 200: description: Ok schema: #/definitions/contextDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contextDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/contextDetail/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contextDetail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/requestHistory: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/requestHistory responses: 200: description: The created resource schema: #/definitions/requestHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/requestHistory responses: 200: description: The created resource schema: #/definitions/requestHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/requestHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/requestHistory/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/requestHistory responses: 200: description: Ok schema: #/definitions/requestHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/requestHistory responses: 200: description: Ok schema: #/definitions/requestHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/requestHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/requestHistory/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/requestHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/formValueHistory: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/formValueHistory responses: 200: description: The created resource schema: #/definitions/formValueHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/formValueHistory responses: 200: description: The created resource schema: #/definitions/formValueHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/formValueHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/formValueHistory/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/formValueHistory responses: 200: description: Ok schema: #/definitions/formValueHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/formValueHistory responses: 200: description: Ok schema: #/definitions/formValueHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/formValueHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/formValueHistory/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/formValueHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/calendar: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/calendar responses: 200: description: The created resource schema: #/definitions/calendar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/calendar responses: 200: description: The created resource schema: #/definitions/calendar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/calendar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/calendar/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calendar responses: 200: description: Ok schema: #/definitions/calendar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/calendar responses: 200: description: Ok schema: #/definitions/calendar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/calendar 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/calendar/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/calendar responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/holiday: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/holiday responses: 200: description: The created resource schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/holiday responses: 200: description: The created resource schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/holiday/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/holiday responses: 200: description: Ok schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/holiday responses: 200: description: Ok schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/holiday/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/holiday responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/notificationPreferences: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/notificationPreferences responses: 200: description: The created resource schema: #/definitions/notificationPreferences 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/notificationPreferences responses: 200: description: The created resource schema: #/definitions/notificationPreferences 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/notificationPreferences 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/notificationPreferences/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/notificationPreferences responses: 200: description: Ok schema: #/definitions/notificationPreferences 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/notificationPreferences responses: 200: description: Ok schema: #/definitions/notificationPreferences 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/notificationPreferences 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/notificationPreferences/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notificationPreferences responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/tag: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tag responses: 200: description: The created resource schema: #/definitions/tag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tag responses: 200: description: The created resource schema: #/definitions/tag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/tag/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tag responses: 200: description: Ok schema: #/definitions/tag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tag responses: 200: description: Ok schema: #/definitions/tag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tag 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/tag/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tag responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processConfig: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processConfig responses: 200: description: The created resource schema: #/definitions/processConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processConfig responses: 200: description: The created resource schema: #/definitions/processConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/processConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processConfig/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processConfig responses: 200: description: Ok schema: #/definitions/processConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processConfig responses: 200: description: Ok schema: #/definitions/processConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/processConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processConfig/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/processConfig responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processReportStatus: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processReportStatus responses: 200: description: The created resource schema: #/definitions/processReportStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processReportStatus responses: 200: description: The created resource schema: #/definitions/processReportStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/processReportStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processReportStatus/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processReportStatus responses: 200: description: Ok schema: #/definitions/processReportStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processReportStatus responses: 200: description: Ok schema: #/definitions/processReportStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/processReportStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processReportStatus/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/processReportStatus responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/activity: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/activity responses: 200: description: The created resource schema: #/definitions/activity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/activity responses: 200: description: The created resource schema: #/definitions/activity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/activity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/activity/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/activity responses: 200: description: Ok schema: #/definitions/activity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/activity responses: 200: description: Ok schema: #/definitions/activity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/activity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/activity/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activity responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/featureToggle: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/featureToggle responses: 200: description: The created resource schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/featureToggle responses: 200: description: The created resource schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/featureToggle/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/featureToggle responses: 200: description: Ok schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/featureToggle responses: 200: description: Ok schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/featureToggle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/featureToggle/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/featureToggle responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processThumbnail: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processThumbnail responses: 200: description: The created resource schema: #/definitions/processThumbnail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processThumbnail responses: 200: description: The created resource schema: #/definitions/processThumbnail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/processThumbnail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processThumbnail/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processThumbnail responses: 200: description: Ok schema: #/definitions/processThumbnail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processThumbnail responses: 200: description: Ok schema: #/definitions/processThumbnail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/processThumbnail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processThumbnail/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/processThumbnail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processDocumentConfig: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processDocumentConfig responses: 200: description: The created resource schema: #/definitions/processDocumentConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processDocumentConfig responses: 200: description: The created resource schema: #/definitions/processDocumentConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/processDocumentConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processDocumentConfig/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processDocumentConfig responses: 200: description: Ok schema: #/definitions/processDocumentConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processDocumentConfig responses: 200: description: Ok schema: #/definitions/processDocumentConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/processDocumentConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processDocumentConfig/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/processDocumentConfig responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/publishedDocumentControl: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/publishedDocumentControl responses: 200: description: The created resource schema: #/definitions/publishedDocumentControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/publishedDocumentControl responses: 200: description: The created resource schema: #/definitions/publishedDocumentControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/publishedDocumentControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/publishedDocumentControl/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/publishedDocumentControl responses: 200: description: Ok schema: #/definitions/publishedDocumentControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/publishedDocumentControl responses: 200: description: Ok schema: #/definitions/publishedDocumentControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/publishedDocumentControl 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/publishedDocumentControl/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/publishedDocumentControl responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/rating: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/rating responses: 200: description: The created resource schema: #/definitions/rating 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/rating responses: 200: description: The created resource schema: #/definitions/rating 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/rating 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/rating/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rating responses: 200: description: Ok schema: #/definitions/rating 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rating responses: 200: description: Ok schema: #/definitions/rating 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/rating 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/rating/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/rating responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/integrationEvent: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integrationEvent responses: 200: description: The created resource schema: #/definitions/integrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/integrationEvent responses: 200: description: The created resource schema: #/definitions/integrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/integrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/integrationEvent/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/integrationEvent responses: 200: description: Ok schema: #/definitions/integrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/integrationEvent responses: 200: description: Ok schema: #/definitions/integrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/integrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/integrationEvent/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integrationEvent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/serviceIntegrationEvent: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/serviceIntegrationEvent responses: 200: description: The created resource schema: #/definitions/serviceIntegrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/serviceIntegrationEvent responses: 200: description: The created resource schema: #/definitions/serviceIntegrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/serviceIntegrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/serviceIntegrationEvent/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/serviceIntegrationEvent responses: 200: description: Ok schema: #/definitions/serviceIntegrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/serviceIntegrationEvent responses: 200: description: Ok schema: #/definitions/serviceIntegrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/serviceIntegrationEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/serviceIntegrationEvent/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/serviceIntegrationEvent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processSignConfig: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processSignConfig responses: 200: description: The created resource schema: #/definitions/processSignConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/processSignConfig responses: 200: description: The created resource schema: #/definitions/processSignConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/processSignConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processSignConfig/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processSignConfig responses: 200: description: Ok schema: #/definitions/processSignConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/processSignConfig responses: 200: description: Ok schema: #/definitions/processSignConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/processSignConfig 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/processSignConfig/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/processSignConfig responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/envelope: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelope responses: 200: description: The created resource schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelope responses: 200: description: The created resource schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/envelope/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: Ok schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelope responses: 200: description: Ok schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelope 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/envelope/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelope responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/envelopeDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDocument responses: 200: description: The created resource schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/envelopeDocument responses: 200: description: The created resource schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/envelopeDocument/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeDocument responses: 200: description: Ok schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/envelopeDocument responses: 200: description: Ok schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/envelopeDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /workflow/entities/envelopeDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/envelopeDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: periodOfDate: description: Período de dados para filtro na central de tarefas type: string enum: – LAST_90_DAYS – LAST_180_DAYS – LAST_365_DAYS – ALL integrationStatus: description: Estado do upload do documento type: string enum: – IN_PROGRESS – SUCCESS – ERROR requesterTaskStatusEnum: description: Enumeração do filtro requester_task_status type: string enum: – BOTH – ACTIVE pendencyAssumedStatus: description: Status da pendência em lote type: string enum: – ASSUMED_BY_ME – ASSUMED_BY_OTHER_USER – NOT_ASSUMED – NOT_FOUND expirationStatus: description: Status da expiração da tarefa type: string enum: – MORE_THAN_24_HOURS – LESS_THAN_24_HOURS – EXPIRED IntegrationServiceEventType: description: Tipos de retorno de serviços externos type: string enum: – CONNECTION_TIMEOUT – CONNECTION_ERROR – SERVICE_RESPONSE_READ_ERROR – SERVICE_ERROR – INVALID_SERVICE_RESPONSE – SUCCESS – EXECUTION_ERROR pendencyResponseStatus: description: Estado da pendência type: string enum: – WAITING – EXECUTING – ERROR processAccessLevel: description: Nível de acesso ao processo type: string enum: – EDIT_AND_START – START – EDIT – NONE taskStatus: description: Status da tarefa type: string enum: – UNREADED – READED – PENDING – TREATED orderDirection: description: Ordenação type: string enum: – ASC – DESC filterType: description: Tipo de filtro type: string enum: – PROCESS_INSTANCE_ID – REQUESTER – RESPONSIBLE – STATUS – START_DATE – END_DATE – EXPIRATION_DATE – EXPIRATION_DATE_GT – EXPIRATION_DATE_LT – PROCESS – PROCESS_STEP – TASK_NAME – REQUEST_TITLE – FIELD – CATEGORY – PERIOD operators: description: Operadores de comparação de filtro type: string enum: – EQ – NE – LT – GT – LOE – GOE – CONTAINS apiFilterOperators: description: Operadores de comparação de filtro type: string enum: – EQ – NE – LT – GT – LOE – GOE – CONTAINS – IN orderField: description: Tipo de ordenação type: string enum: – REQUESTER – RESPONSIBLE – STATUS – START_DATE – END_DATE – EXPIRATION_DATE – PROCESS_NAME groupBy: description: Tipo de agrupamento type: string enum: – PROCESS – CATEGORY – REQUESTER – RESPONSIBLE – START_DATE – END_DATE – EXPIRATION_DATE taskListItemType: description: Tipo de item da central de tarefas type: string enum: – TASK – POOL – REQUESTS – MANAGER – USERINCOPY conflictDecision: description: Decisão tomada a respeito de um conflito na importação do processo type: string enum: – Ignore – Override conflictType: description: Tipos de conflitos possíveis type: string enum: – Process – ExternalService – Form – DataSource – CustomAssignment – Entity – ConectorExternalService – ConectorDataSource – FormHosted subjectKind: description: Representa o tipo de um usuário (usuário/grupo). type: string enum: – User – Group – Role – UserApp processState: description: Representa o tipo de processo (new/started). type: string enum: – New – Started myRequestKind: description: Tipo de requisição type: string enum: – InProgress – Completed – Canceled myEnvolvedPendencyKind: description: Tipo de pendencia envolvida type: string enum: – InProgress – Completed – Canceled – All adminPendencyKind: description: Tipo de pendencia administrador type: string enum: – InProgress – WillExpire – Expired – Completed – Canceled – All processPublicationStatus: description: Representa o status de publicação do processo (saved/active) type: string enum: – Saved – Published reportTaskExpirationStatus: description: Status de tarefa expirada type: string enum: – InProgress – WillExpire – Expired pendencyType: description: Tipo de pendência type: string enum: – Pending – Treated – All serviceType: description: Representa qual tipo de retorno o serviço terá type: string enum: – UserGrantedProcesses – UserGrantedCordinateProcesses – AllProcesses – UserGrantedOrEditProcesses assignmentType: description: Tipos para Mecanismo de Atribuição de Usuários type: string enum: – Users – UsersOfGroup – UsersOfRole – GroupPool – RolePool – Combination – UserRequester – DefaultRequesterGroup – ProcessVariable – Custom – UserApplication processFilterType: description: Tipo do processo type: string enum: – Embedded – NotEmbedded – All licenseEventType: description: Marcos que definem eventos de licença type: string enum: – StartUsing – BeforeExperimentMark – ExperimentMark – BeforeLimitedMark – LimitedMark servieExecutionType: description: Tipo de execução de serviço type: string enum: – TASK – ASSIGNMENT serviceProtocolType: description: Protocolos type: string enum: – PLATAFORM – REST httpMethodType: description: Metodos aceitos type: string enum: – GET – POST – PUT – DELETE – PATCH paramServiceType: description: Tipo de parâmetro de serviço type: string enum: – Boolean – Integer – String – Double – Date – Array – Enum – Object processExecutionType: description: Tipo de execução do processo type: string enum: – Ecm – InterfaceWeb requestHistoryType: description: Tipo de entrada no histórico de um solicitação type: string enum: – STARTED – COMMENT – COMMENT_REMOVED – ATTACHMENT_ADDED – ATTACHMENT_REMOVED – CHANGE_RESPONSIBLE – CHANGE_REQUESTER – CANCEL_PENDENCY – RESPONSE_PENDENCY – FINISHED – TASK_DELETED processPermissionType: description: Tipo de Permissão por Processo type: string enum: – INIT – COORDINATOR – REQUEST_HISTORY – CANCEL – EDIT – DELETE notificationKind: description: Tipo de notificação type: string enum: – EMAIL – PLATFORM notificationEvent: description: Tipo de notificação type: string enum: – NEWREQUEST – ENDPROCESS – CANCELPROCESS – TASKEXPIRATION – NEWTASK processType: description: Tipos de processos type: string enum: – PROCESS – PROCESSMODEL bpmIntegrationStatus: description: Representa o status da integração type: string enum: – CREATED – PENDING – FINISHED – CANCELED upDown: description: Up or down type: string enum: – UP – DOWN variableVisibility: description: Tipo de visibilidade das variáveis para consulta type: string enum: – RESTRICT – ONLY_PARTICIPATED – ALWAYS documentPublicationType: description: Tipo de publicação Documento type: string enum: – TASK – REQUEST – CONDITION documentSetting: description: Tipo de Configuração do Documento type: string enum: – CURRENT_USER – REQUESTER – INPUT – FOLDER integrationEventType: description: Tipos de eventos de integração type: string enum: – PUBLISHED_DOCUMENT_CONTROL – SERVICE_INTEGRATION_EVENT reportGenerationStatus: description: Status de geração do formulario type: string enum: – RUNNING – DONE – ERROR geolocationSetting: description: Definição da geolocalização durante a assinatura do documento type: string enum: – DONT_ASK_LOCATION – ASK_LOCATION – REQUIRED_LOCATION envelopeManagementSetting: description: Tipo de responsável pela gestão de um envelope type: string enum: – REQUESTER – USER – ROLE envelopeStatus: description: Status do envelope type: string enum: – WAITING_DOCUMENTS – WAITING_SIGNATURE – COMPLETED_ENVELOPE documentUploadStatus: description: Status do documento do envelope type: string enum: – UPLOAD_IN_PROGRESS – UPLOAD_DONE archiveDataType: description: Tipo da arquivação de dados type: string enum: – INTEGRATION_SERVICE – FORM_HISTORY_VALUE userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR hookEventRecord: description: type: object required: – id – eventUrl – eventType properties: id: type: string description: Identificador eventUrl: type: string description: Url eventType: type: string description: Tipo do evento customTab: description: Aba customizada type: object required: – id – processInstanceId – tabName – url properties: id: type: string description: Identificador da tab processInstanceId: type: integer format: int64 description: Processo que a aba deve ser incluida tabName: type: string description: Título da aba url: type: string description: Url a ser exibida na aba processRatingSummary: description: Avaliação de um proceso type: object required: – rate – date properties: rate: type: integer format: int64 description: Nota da avaliação comment: type: string description: Comentário da avaliação date: type: string format: date description: Data de avaliação activity: type: string description: Atiidade do processo username: type: string description: Nome do usuário type: string description: Versão do processo processHistoryDTO: description: Objeto DTO histórico de processo type: object required: – id – historyType – historyDate – userName – processId properties: id: type: integer format: int64 description: Identificador historyType: type: string description: Tipo de entrada alteração do processo historyDate: type: string format: date-time description: Data da ação userName: type: string description: Usuário responsável userIpAddress: type: string description: Endereço IP do usuário processId: type: integer format: int64 description: Identificador do Proceso fileToUpload: description: Arquivo de upload type: object required: – url – version – fileName properties: url: type: string description: Url para upload type: string description: versão do upload fileName: type: string description: Nome do arquivo uploadedFile: description: Upload de um arquivo type: object required: – version – fileName properties: type: string description: versão do upload fileName: type: string description: Nome do arquivo requestProgress: description: Progresso de uma solicitação type: object required: – processInstanceId – processName – currentProgress – previousProgress – activityName – step – activityId properties: processInstanceId: type: integer format: int64 description: Id da solicitação processName: type: string description: Nome do processo currentProgress: type: integer format: int64 description: Percentual atual de progresso da solicitação previousProgress: type: integer format: int64 description: Percentual anterior de progresso da solicitação activityName: type: string description: Nome da atividade atual step: type: integer format: int64 description: Passo atual da solicitação activityId: type: integer format: int64 description: Id da atividade corrente expirationCount: description: type: object required: – status – count properties: status: type: string allOf: – #/definitions/expirationStatus description: status count: type: integer format: int64 description: count searchUserResult: description: Resultado da busca type: object required: – id – name – fullName – displayName properties: id: type: integer format: int64 description: Código do usuário name: type: string description: Login do usuário fullName: type: string description: Nome completo displayName: type: string description: Nome para exibição searchUsersAndRolesResult: description: Resultado da busca de usuários e papéis type: object required: – name – displayName properties: name: type: string description: Nome do usuário ou do papel displayName: type: string description: Nome para exibição searchResult: description: Resultado da busca type: object required: – id – value properties: id: type: string description: Id value: type: string description: valor type: type: string description: Tipo filter: description: Filtro type: object required: – type properties: type: type: string allOf: – #/definitions/filterType description: Campo a ser filtrado stringValue: type: string format: byte description: Valor como string dateValue: type: string format: date-time description: Valor como data field: type: object allOf: – #/definitions/filterField description: Valor do filtro por campo apiFilter: description: Filtro por campo type: object required: – field – operator – fieldValue properties: field: type: string description: Campo a ser filtrado operator: type: string allOf: – #/definitions/apiFilterOperators description: Operador de comparação fieldValue: type: string format: byte description: Valor do campo filterField: description: Filtro por campo type: object required: – name – operator – value properties: name: type: string description: Nome do campo operator: type: string allOf: – #/definitions/operators description: Operador de comparação value: type: string description: Valor variableType: type: string description: Tipo order: description: Ordenação type: object required: – field – direction properties: field: type: string allOf: – #/definitions/orderField description: Campo a ser ordenado direction: type: string allOf: – #/definitions/orderDirection description: Direção da ordenação processOrder: description: Ordenação da listagem de processos type: object required: – field – direction properties: field: type: string description: Campo a ser ordenado direction: type: string allOf: – #/definitions/orderDirection description: Direção batch: description: Lote de tarefas type: object required: – processId – processName – name – total – actions properties: processId: type: integer format: int64 description: Id do processo processName: type: string description: Nome do processo name: type: string description: Nome da atividade tasks: type: array items: type: object allOf: – #/definitions/task description: Lista de tarefas do lote total: type: integer format: int64 description: Total de ítens actions: type: array items: type: string minimum: 1 description: Ações disponíveis pra esse lote group: description: Agrupamento type: object required: – name – total properties: name: type: string format: byte description: Nome do agrupamento tasks: type: array items: type: object allOf: – #/definitions/task description: Lista de tarefas/solicitações do agrupamento total: type: integer format: int64 description: Total de ítens searchTasksFilter: description: Filtro de tarefas type: object properties: requesters: type: array items: type: string description: Filtrar pelo solicitante requests: type: array items: type: string description: Filtrar pelo identificador da solicitação processes: type: array items: type: string description: Filtrar pelo identificador do processo statuses: type: array items: type: string description: Filtrar pelo status task: description: Tarefa type: object required: – processId – processInstanceId – activity – creationDate – startDate – requesterName – activityId – step – pendencyCount – responseStatus – userInCopyName – detailHashmap properties: processId: type: integer format: int64 description: Id do processo processName: type: string description: Nome do processo processInstanceId: type: integer format: int64 description: Id da instância do processo activity: type: string description: Atividade detail: type: string description: Detalhes do processo creationDate: type: string format: date-time description: Data de criação do processo startDate: type: string format: date-time description: Data de início da tarefa/processo endDate: type: string format: date-time description: Data de fim da tarefa/processo expirationDate: type: string format: date-time description: Data de expiração da tarefa/processo responsableName: type: string description: Nome do responsável pela tarefa responsableFullName: type: string description: Nome e sobrenome do responsável pela tarefa requesterName: type: string description: Nome do solicitante requesterFullName: type: string description: Nome e sobrenome do solicitante taskStatus: type: string allOf: – #/definitions/taskStatus description: Status da tarefa requestStatus: type: string allOf: – #/definitions/myRequestKind description: Status da solicitação type: string description: Título da Solicitação activityId: type: integer format: int64 description: Id da atividade step: type: integer format: int64 description: Passo pendencyCount: type: integer format: int64 description: Número de pendências de uma solicitação responseStatus: type: string allOf: – #/definitions/pendencyResponseStatus description: Estado da pendência em lote userInCopyName: type: string description: Nome do usuário em cópia pela tarefa detailHashmap: type: array items: type: object allOf: – #/definitions/taskDetailMap minimum: 1 description: Detalhes do processo hashMap taskDetailMap: description: type: object required: – key – value properties: key: type: string description: value: type: string description: notificationPreferenceInput: description: Entrada de dados de preferências de notificação type: object required: – id – type – newRequest – endProcess – cancelProcess – taskExpiration – newTask – newComment properties: id: type: string description: Identificador type: type: string allOf: – #/definitions/notificationKind description: Tipo da notificação userName: type: string description: Nome do usuario processId: type: integer format: int64 description: Identificador do processo newRequest: type: boolean description: Nova solicitação endProcess: type: boolean description: Solicitação encerrada cancelProcess: type: boolean description: Solicitação cancelada taskExpiration: type: boolean description: Prazo de Expiração da tarefa newTask: type: boolean description: Nova tarefa newComment: type: boolean description: Novo comentário userGroupNotification: description: Grupo de usuários que serão notificados na notificação agrupada type: object required: – groupId – pendencyNotify – daysBeforeExpires – daysAfterExpires properties: groupId: type: string maxLength: 36 description: Código do grupo de usuários pendencyNotify: type: boolean description: Notifica apenas quando tem pendentes daysBeforeExpires: type: integer format: int64 description: Notificar com quantos dias antes da expiração daysAfterExpires: type: integer format: int64 description: Quantos dias deve notificar após uma tarefa expirar dailyNotification: description: Configuração para notificações diarias agrupadas type: object required: – processId properties: processId: type: integer format: int64 description: Identificador do processo description: type: string description: Texto a ser adicionado sob o nome do processo userGroups: type: array items: type: object allOf: – #/definitions/userGroupNotification description: Lista com os grupos de usuário a serem notificados myRequestResumeParameters: description: Parametros de entrada para busca do resumo da solicitação type: object properties: start: type: integer format: int64 description: Faixa inicial da consulta limit: type: integer format: int64 description: Quantidade de linhas da consulta filterValue: type: string description: Filtro para buscar pelo nome da pendencia ou valor das variáveis do processo filter: type: array items: type: string allOf: – #/definitions/myRequestKind description: Filtro por status processFilterType: type: string allOf: – #/definitions/processFilterType description: Filtro do tipo de processo (embarcado ou não) myRequestsResume: description: Resumo das Solicitações type: object required: – processInstanceId – processName – startDate – endDate – status – activityName – taskUser – expirationDate – processId – processVersion – embedded – detail properties: processInstanceId: type: integer format: int64 description: Instancia de Processo processName: type: string description: Nome do Processo startDate: type: string format: date-time description: Criação da Soliciatção endDate: type: string format: date-time description: Enceramento da Solicitação status: type: string description: Status activityName: type: string description: Nome da Atividade Atual taskUser: type: string description: Usuário Atual da Tarefa expirationDate: type: string format: date-time description: Data de Expiração processId: type: integer format: int64 description: Identificador do Processo processVersion: type: integer format: int64 description: Versão do Processo embedded: type: boolean description: Indica se o processo desta solicitação é embarcado detail: type: string description: Detalhes da Solicitação flowToken: type: array items: type: object allOf: – #/definitions/serviceFlowToken description: Identificador de uma pendência. serviceProcess: description: Representa um processo de workflow. type: object required: – processId – currentVersion – publishedVersion – processName – processRawName – changed – fileName – status – description – creationDate properties: processId: type: integer format: int64 description: Identificador do Processo currentVersion: type: integer format: int64 description: Versão Atual do Processo publishedVersion: type: integer format: int64 description: Versão Publicada do Processo processName: type: string description: Nome do Processo processRawName: type: string description: Nome do processo assim como se encontra no banco de dados changed: type: boolean description: Se o processo está modificado fileName: type: string description: Nome do Arquivo do Processo status: type: string allOf: – #/definitions/processPublicationStatus description: Se o processo esta publicado ou apenas salvo description: type: string description: Descrição do processo creationDate: type: string format: date-time description: Data de criação do processo active: type: boolean description: Se o processo está ativo embedded: type: boolean description: Se o processo é embarcado simple: type: boolean description: Se o prcesso é simples tag: type: string description: Tag agrupador de Processos accessLevel: type: string allOf: – #/definitions/processAccessLevel description: Indica o nível de acesso do usuário ao processo icon: type: string description: Ícone do processo serviceEventQtyByType: type: array items: type: object allOf: – #/definitions/serviceEventQtyByType description: Listagem dos tipos e quantidade de eventos de serviço externo ProcessAuthor: description: Representa o autor do processo type: object required: – author properties: fullName: type: string description: Nome completo do autor author: type: string description: Nome de usuário do autor do processo authorEmail: type: string description: E-mail do autor do processo processListItem: description: Representa um processo de workflow. type: object required: – id – currentVersion – name – description – lastUpdateDate – author properties: id: type: integer format: int64 description: Identificador do Processo currentVersion: type: integer format: int64 description: Versão atual do Processo name: type: string description: Nome do Processo description: type: string description: Descrição do processo lastUpdateDate: type: string format: date-time description: Data da última alteração do processo author: type: string description: Nome de usuário do autor do processo authorEmail: type: string description: E-mail do autor do processo active: type: integer format: int64 description: Se o processo está ativo simple: type: integer format: int64 description: Se o processo é simples category: type: string description: Categoria do processo icon: type: string description: Ícone do processo countIntegrationErrorsLastWeek: type: integer format: int64 description: Se o processo teve erros de integração nos últimos 7 dias thumbnail: type: string description: URL da thumbnail do processo rating: type: number format: double description: Avaliação média do processo ratingCount: type: integer format: int64 description: Quantidade de avaliações enableRating: type: boolean description: Habilita avaliação para o processo serviceEventQtyByType: description: Quantidade de eventos de serviços externos por tipos type: object required: – type – quantity properties: type: type: string allOf: – #/definitions/integrationStatus description: tipo do evento quantity: type: integer format: int64 description: quantidade de eventos processRanking: description: Ranking de Processos mais usados pelo usuário type: object required: – processId – currentVersion – processName – requests properties: processId: type: integer format: int64 description: Identificador do Processo currentVersion: type: integer format: int64 description: Versão Atual do Processo processName: type: string description: Nome do Processo tag: type: string description: Tag agrupador de Processos icon: type: string description: Ícone do processo description: type: string description: Descrição do processo requests: type: integer format: int64 description: Número de solicitações processError: description: Representa erro do processo discriminator: _discriminator type: object required: – actionName – processInstanceId – errorDate – name – activity – requester – user – type – message – step – activityId – _discriminator properties: actionName: type: string description: Nome da ação processInstanceId: type: integer format: int64 description: Id da instância do processo errorDate: type: string format: date-time description: Data do erro name: type: string description: Nome activity: type: string description: Atividade requester: type: string description: Solicitante user: type: string description: Usuário type: type: string description: Tipo message: type: string description: Mensagem step: type: integer format: int64 description: Etapa activityId: type: integer format: int64 description: Id da atividade _discriminator: type: string description: recoveredProcess: description: Representa recuperação do processo allOf: – #/definitions/processError – type: object required: – recoveryDate – status properties: recoveryDate: type: string format: date-time description: Data da recuperação status: type: string description: Status da recuperação pendency: description: Representa uma pendência de um processo type: object required: – serviceFlowToken – description – hint – currentSubject – delegatorSubject – startDate – lastUpdateDate – expirationDate – performerId – processInstance – type – pool – signatureVerificationEnabled – currentUserInCopy properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Fluxo do processo description: type: string description: Descrição hint: type: string description: Dica currentSubject: type: object allOf: – #/definitions/serviceSubject description: Usuário atual delegatorSubject: type: object allOf: – #/definitions/serviceSubject description: Usuário delegado startDate: type: string format: date-time description: Data início lastUpdateDate: type: string format: date-time description: Data da última alteração expirationDate: type: string format: date-time description: Data de expiração performerId: type: string description: Id processInstance: type: object allOf: – #/definitions/processInstance description: Id da instância do processo type: type: string allOf: – #/definitions/pendencyType description: Tipo de pendência pool: type: boolean description: Pendência type: string description: Titulo da pendência signatureVerificationEnabled: type: boolean description: Especifica se a pendência é dependente da assinatura de um envelope currentUserInCopy: type: object allOf: – #/definitions/serviceSubject description: Usuário em cópia summarizedPendency: description: Representa uma pendência de um processo type: object required: – serviceFlowToken – startDate – processName – description – hint – type – currentSubject – requester – expirationDate – lastUpdateDate – pool – detail properties: serviceFlowToken: type: object allOf: – #/definitions/serviceFlowToken description: Fluxo do processo startDate: type: string format: date-time description: Data de início processName: type: string description: Nome do processo description: type: string description: Descrição hint: type: string description: Dica type: type: string allOf: – #/definitions/pendencyType description: Tipo de pendencia currentSubject: type: string description: Usuário atual requester: type: string description: Solicitante do processo expirationDate: type: string format: date-time description: Data de expiração lastUpdateDate: type: string format: date-time description: Ultima data de atualização pool: type: boolean description: Pendência detail: type: string description: Datalhes da pendência comment: description: Representa um comentário de uma instacia de processo type: object required: – id – username – created – updated – comment – processInstanceID properties: id: type: integer format: int64 description: Id comentário username: type: string description: Username do usuário created: type: string format: date-time description: Data criação updated: type: string format: date-time description: Data de atualização comment: type: string maxLength: 500 description: Comentário processInstanceID: type: integer format: int64 description: Id da instância do processo processInstance: description: Representa uma instancia de processo type: object required: – id – process – startedSubject – cancelSubject – startDate – lastUptadeDate – endDate – flowExecutionStatus – endMessage – description – flowToken – taskExpiration properties: id: type: integer format: int64 description: Id instancia process: type: object allOf: – #/definitions/serviceProcess description: Processo startedSubject: type: object allOf: – #/definitions/serviceSubject description: Usuário que iniciou cancelSubject: type: object allOf: – #/definitions/serviceSubject description: Usuário que cancelou startDate: type: string format: date-time description: Data de início lastUptadeDate: type: string format: date-time description: Ultima data de alteração endDate: type: string format: date-time description: Data de finalização flowExecutionStatus: type: string description: Status da execução do fluxo endMessage: type: string description: Mensagem description: type: string description: Descrição flowToken: type: array items: type: object allOf: – #/definitions/serviceFlowToken minimum: 1 description: Fluxo do processo taskExpiration: type: string format: date-time description: Data de expiração taskTitle: type: string description: Título da tarefa serviceFlowToken: description: Representa a chave de uma pendência de um processo. – Deprecado type: object required: – processInstanceID – step – activityId properties: processInstanceID: type: integer format: int64 description: Identificador da Instância do Proceso step: type: integer format: int64 description: Identificador da Etapa do Processo activityId: type: integer format: int64 description: Identificador da Atividade flowToken: description: Assinatura corrigindo o processInstanceID presente em serviceFlowToken type: object required: – processInstanceId – step – activityId properties: processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso step: type: integer format: int64 description: Identificador da Etapa do Processo activityId: type: integer format: int64 description: Identificador da Atividade userWorkGroup: description: Grupo de usuário type: object required: – user properties: user: type: object allOf: – #/definitions/serviceSubject description: Usuário workGroup: type: object allOf: – #/definitions/serviceSubject description: Grupo serviceSubject: description: Representa um usuário ou grupo. type: object required: – userCode – name – subjectKind properties: userCode: type: integer format: int64 description: Código usuário name: type: string description: Nome usuário subjectKind: type: string allOf: – #/definitions/subjectKind description: Tipo de usuário pendencyRequestParameters: description: Representa um objeto usado de parametro de entrada de alguns serviços. type: object properties: start: type: integer format: int64 description: Faixa inicial da consulta limit: type: integer format: int64 description: Quantidade de linhas da consulta type: type: string allOf: – #/definitions/pendencyType description: Tipo da pendencia filterValue: type: string description: Filtro para buscar pelo nome da pendencia ou valor das variáveis do processo processFilterType: type: string allOf: – #/definitions/processFilterType description: Filtro do tipo de processo (embarcado ou não) servicePendencyFilter: description: Representa filtro de pendência type: object required: – pagination properties: pagination: type: object allOf: – #/definitions/pagination description: Paginação pendencyName: type: string description: Filtro para buscar pelo nome da pendencia pagination: description: Representa paginação type: object properties: start: type: integer format: int64 description: Faixa inicial da consulta limit: type: integer format: int64 description: Quantidade de linhas da consulta processInstanceRequestParameters: description: Representa um objeto usado de parametro de entrada de alguns serviços. type: object properties: start: type: integer format: int64 description: Faixa inicial da consulta limit: type: integer format: int64 description: Quantidade de linhas da consulta filter: type: array items: type: string allOf: – #/definitions/myRequestKind description: Filtro processFilterType: type: string allOf: – #/definitions/processFilterType description: Filtro do tipo de processo (embarcado ou não) responseData: description: Representa a entrada de dados de uma ação de resposta de pendência type: object properties: businessData: type: string description: Dados de Negócio do Processo flowExecutionData: type: object allOf: – #/definitions/flowExecutionData description: Informação para Fluxo de Execução do Processo flowExecutionData: description: Dados para a execução do fluxo type: object required: – actionToExecute properties: actionToExecute: type: string description: Nome da ação a ser tomada dentro do fluxo nextSubject: type: string description: Usuário que pode receber a próxima ação userInCopy: type: integer format: int64 description: Usuário em cópia que pode receber a próxima ação pendencyProcessAction: description: Representa uma ação para execução de uma pendência do processo. type: object required: – executeAction properties: executeAction: type: string description: Ação a ser executada. nextSubjects: type: array items: type: object allOf: – #/definitions/serviceSubject description: próximo executor da pendência. accessPropertiesResponse: description: Resposta de propriedade de acesso type: object required: – performerURI – performerData properties: performerURI: type: string description: URI performerData: type: string description: Dados attachTabVisibility: type: boolean description: Mostra ou oculta a tela de abas da solicitação reportProcessReference: description: Referência do processo type: object required: – id – name properties: id: type: integer format: int64 description: ID name: type: string description: Nome reportPendencyExpirationStatusVolume: description: Volume de pendências expiradas com status type: object required: – status – count properties: status: type: string allOf: – #/definitions/reportTaskExpirationStatus description: Status count: type: integer format: int64 description: Quantidade de itens reportProcessMovementsVolume: description: Volume de processos movimentados type: object required: – process – volumes properties: process: type: object allOf: – #/definitions/reportProcessReference description: Processos volumes: type: array items: type: object allOf: – #/definitions/reportPeriodMovementsVolume minimum: 1 description: Volume de processos reportPeriodMovementsVolume: description: Periodo de movimentações de um volume processos type: object required: – period – movementsCount properties: period: type: string format: date description: Período movementsCount: type: integer format: int64 description: Quantidade de movimentações reportProcessExpirationVolume: description: Volume de processos com tarefas expirados type: object required: – process – activePendenciesCount – finishedPendenciesCount properties: process: type: object allOf: – #/definitions/reportProcessReference description: Processos activePendenciesCount: type: integer format: int64 description: Quantidade de pendências em aberto finishedPendenciesCount: type: integer format: int64 description: Quantidade de pendências fechadas reportTasksByStepsAndProcess: description: Tarefas por etapas com processos type: object required: – quantity – step – status properties: quantity: type: integer format: int64 description: Quantidade step: type: string description: Etapa status: type: integer format: int64 description: Status reportProcessVolume: description: Volume de processos type: object required: – process – volume properties: process: type: object allOf: – #/definitions/reportProcessReference description: Processos volume: type: integer format: int64 description: Quantidade de itens reportProcessActivities: description: Atividades por processos type: object required: – month – volume properties: month: type: string description: Mês volume: type: integer format: int64 description: Quantidade processAction: description: Ações por processos type: object required: – name – label – finish – connectsWithAutomaticGateway – isAppUser properties: name: type: string description: Nome label: type: string description: Descrição finish: type: boolean description: Encerrada (Sim ou Não) connectsWithAutomaticGateway: type: boolean description: Conexão com gateway isAppUser: type: boolean description: Realizada por usuário de aplicação reportProcessExpirationActivity: description: Atividades de processos expiradas type: object required: – processId – processName – activityName – expireOneDayCount – expireFiveDaysCount – expireMoreDaysCount – expireDaysAverage properties: processId: type: integer format: int64 description: Id do processo processName: type: string description: Nome do processo activityName: type: string description: Atividade do processo expireOneDayCount: type: integer format: int64 description: Primeiro dia de expiração expireFiveDaysCount: type: integer format: int64 description: Quinto dia de expiração expireMoreDaysCount: type: integer format: int64 description: Expira em X dias expireDaysAverage: type: integer format: int64 description: Média em dias de expiração assignmentItem: description: Parâmetros do Mecanismo de Atribuição type: object required: – type – value properties: type: type: string allOf: – #/definitions/assignmentType description: Tipo do Mecanismo de Associação value: type: string description: Valor que representa o responsável associado serviceAttachment: description: Representação de um anexo no BlobService type: object required: – id – name – size – uploadDate – addedBy – hasIntegrateError – integrateErrorMessage properties: id: type: string description: Identificador do anexo name: type: string description: Nome do arquivo anexado size: type: integer format: int64 description: Tamanho do arquivo anexado uploadDate: type: string format: date-time description: Data do envio addedBy: type: string description: Responsável pelo anexo hasIntegrateError: type: boolean description: Se ocorreu erro na integrção BPM X GED integrateErrorMessage: type: string description: Mensagem de erro na integrção BPM X GED keyValueRecord: description: Registro Genérico para Chave Valor type: object required: – key – value properties: key: type: string description: Nome da Chave value: type: string description: Valor conectorConfigured: description: Record para informar se o conector está configurado type: object required: – conectorId – configured properties: conectorId: type: string description: ID do conector configured: type: boolean description: Se está configurado keyValueTypeRecord: description: Registro Genérico para Chave Valor Tipo type: object required: – key – value – type properties: key: type: string description: Chave value: type: string description: valor type: type: string allOf: – #/definitions/paramServiceType description: Tipo activityHistory: description: Histórico de um atividade type: object required: – name – start – end – duration properties: name: type: string description: nome da atividade start: type: string format: date-time description: inicio da atividade end: type: string format: date-time description: fim da atividade duration: type: integer format: int64 description: Duaração da atividade em milisegundos requestHistoryResume: description: Registro com extrato de um solicitação type: object required: – processName – items – comments – attachments – variables properties: processName: type: string description: Nome do Processo items: type: array items: type: object allOf: – #/definitions/requestHistory minimum: 1 description: Items do histórico desta solicitação comments: type: array items: type: object allOf: – #/definitions/comment minimum: 1 description: Comentários desta solicitação attachments: type: array items: type: object allOf: – #/definitions/serviceAttachment minimum: 1 description: Anexos da solicitação variables: type: array items: type: object allOf: – #/definitions/keyValueRecord minimum: 1 description: Variavies da solicitação requestHistoryTimelineEntry: description: Linha do tempo com o registro de ações e observações de uma solicitação type: object required: – processInstanceId – historyType – historyDate – userName – fullName – oldResponsible – newResponsible properties: processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso historyType: type: string allOf: – #/definitions/requestHistoryType description: Tipo de Entrada Histórico historyDate: type: string format: date-time description: Data do Histórico userName: type: string description: Usuário responsável fullName: type: string description: Nome completo do usuário responsável impersonatedUserName: type: string description: Ação executada em nome do usuário taskName: type: string description: Nome da Tarefa actionName: type: string description: Nome ação Executada userIpAddress: type: string description: Endereço IP do usuário comment: type: string description: Comentário realizado na etapa do processo commentId: type: integer format: int64 description: Identificador do comentario commentUpdated: type: string format: date-time description: Data de atualização do comentario commentDisabled: type: boolean description: Identificador de comentario deletado attachmentName: type: string description: Anexo oldResponsible: type: string description: Responsável anterior newResponsible: type: string description: Novo responsável cancelReason: type: string description: Razão do cancelamento requestHistoryEntry: description: Histórico de requisições type: object properties: processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso taskName: type: string description: Nome da Tarefa historyType: type: string allOf: – #/definitions/requestHistoryType description: Tipo de Entrada Histórico historyDate: type: string format: date-time description: Data do Histórico userName: type: string description: Usuário responsável userIpAddres: type: string description: Endereço IP do usuário que fez a ação defaultRole: description: Papel padrão do BPM type: object required: – id – name properties: id: type: string description: Identificador do papel name: type: string description: Nome do papel processTemplate: description: Template de Processos Workflow type: object required: – id – name – description – kind – icon properties: id: type: integer format: int64 description: identificação unica do processo que representa o template do processo name: type: string description: Nome do Modelo description: type: string description: Descrição explicando o modelo kind: type: string description: Indica se é um processo simple ou BPM icon: type: string description: representação do icone downloadUrl: type: string description: URL para download do template conflict: description: Representa um conflito entre os metadados de um processo e o tenant corrente discriminator: _discriminator type: object required: – name – type – _discriminator properties: name: type: string description: Nome do conflito type: type: string allOf: – #/definitions/conflictType description: Tipo do conflito _discriminator: type: string description: handledConflict: description: Representa um conflito de importação de processo resolvido allOf: – #/definitions/conflict – type: object required: – decision properties: decision: type: string allOf: – #/definitions/conflictDecision description: Decisão tomada em relação ao conflito thirdpartyRequestResume: description: Resumo das Solicitações com Integração Terceira type: object required: – flowToken – processData properties: flowToken: type: object allOf: – #/definitions/serviceFlowToken description: Identificador da pendência thirdpartyId: type: string description: Identificador da aplicação terceira processData: type: string format: byte description: Dados das variáveis do processo tagResume: description: Representa um conflito entre os metadados de um processo e o tenant corrente type: object required: – name – processCount properties: name: type: string description: Nome da Categoria processCount: type: integer format: int64 description: Número de Processos Associados checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck taskDataFieldToUpdate: description: Dados do campo a ser atualizado type: object required: – name – value – processInstanceId properties: name: type: string description: Nome do campo a ser atualizado value: type: string description: Novo valor a ser definido processInstanceId: type: integer format: int64 description: Identificador do processo processByEntityNameRecord: description: Processos pelo nome do formulário type: object required: – processId – processName – icon – entityVersion properties: processId: type: integer format: int64 description: ID do Processo processName: type: string description: Nome do processo icon: type: string description: Icone do processo entityVersion: type: integer format: int64 description: Versão do formulário keyOrderDirectionAndValue: description: Objeto chave e valor sendo o valor um enum de order direction (asc, desc) type: object required: – key – value properties: key: type: string description: Tipo de ordenaçao value: type: string allOf: – #/definitions/orderDirection description: Valor processChanges: description: Dados com alterações do processo type: object required: – user – changeDate – version – json properties: user: type: string description: Usuário que fez alteração changeDate: type: string format: date-time description: Data da alteração type: integer format: int64 description: Versão da alteração json: type: string description: Json alterado customAssignment: description: Representa as configuração de um endPoint para um mecanimos de atribuição customizado type: object required: – id – description – platform – primitiveName properties: id: type: string description: Identificador do Mecanismo de Atribuição Customizado description: type: string description: Descrição do Mecanismo Customizado platform: type: boolean description: Indica se o mecanismo é implementado na plataforma ou serviço externo domainName: type: string description: Nome do dominio do serviço Customizado serviceName: type: string description: Nome do Serviço Customizado primitiveName: type: string description: Nome da Primiva Customizado processEcm: description: Relaciona Processo do Workflow com entidade do ECM type: object required: – processId – entityName – formVersion properties: processId: type: integer format: int64 description: Indentificador do Process entityName: type: string description: Nome da Entidade do Formulário formVersion: type: integer format: int64 description: Versão do Formulário generalProcessConfig: description: Configurações adicionais relacionadas ao processo em geral type: object required: – id – processId – processVersion – executionConfig properties: id: type: string description: Identificador da configuração processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo executionConfig: type: string description: Configuração do processo quando uma instância ecm for detalhada serviceIntegration: description: Serviço de Integraçao type: object required: – id – name – execution – protocol – method – url properties: id: type: string description: Identificador name: type: string description: Nome do Serviço que aparece no workflow execution: type: string allOf: – #/definitions/servieExecutionType description: Tipo da Execução do Serviço protocol: type: string allOf: – #/definitions/serviceProtocolType description: Protocolo para invocar o serviço method: type: string allOf: – #/definitions/httpMethodType description: Metodo HTTP para chamada REST url: type: string maxLength: 255 description: EndPoint do Serviços params: type: array items: type: object allOf: – #/definitions/paramService description: Parametros do Serviço conectorId: type: string format: uuid description: Id do conector conectorVersionId: type: string format: uuid description: Id da versão do conector conectorConfigurationId: type: string format: uuid description: Id da configuração do conector paramService: description: Parametros do Serviço type: object required: – id – name – input – paramType properties: id: type: string description: Identificador do Parametro name: type: string description: Nome do Parametro input: type: boolean description: Indica se o parametro é de entrada ou saida paramType: type: string allOf: – #/definitions/paramServiceType description: Tipo do Parametro defaultValue: type: string description: Valor default contextVariable: description: Definição das Variaveis de Contexto para Consulta em Processos type: object required: – id – processId – processVersion – name – label – variableType – visible – orderField – visibleForRequester – deprecated – visibleForDecisionCenter properties: id: type: string description: Identificador processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do Processo quando a definição foi atualizada name: type: string description: Nome do Campo label: type: string description: Título para Campo variableType: type: string allOf: – #/definitions/paramServiceType description: Tipo de Variavel visible: type: boolean description: Indicar se mostra na tela de tarefas e solicitação orderField: type: integer format: int64 description: Odernação dos campos visibleForRequester: type: boolean description: Indicar se o campo é visivel para o solicitante deprecated: type: boolean description: Indica que o campo não é mais usado no processo visibleForDecisionCenter: type: boolean description: Indica que o campo não é visivel no Aplicativo Decision Center dateFormat: type: string maxLength: 26 description: Formato da data a ser enviado no payload do formulário (caso o campo seja do tipo data) contextVariableData: description: Definição das Variáveis de Contexto para Consulta em Processos type: object required: – id – processInstanceId – contextVariable properties: id: type: string description: Identificador processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso contextVariable: type: object allOf: – #/definitions/contextVariable description: Variavel de Conexto de um Processo contextValue: type: string description: Valor da Variavels contextDetail: description: Tabela para otimziar pesquisa dos detalhes do processo type: object required: – id – processInstanceId – detail properties: id: type: string description: Identificador processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso detail: type: string description: Variaveis que representam os detalhes do Processo requestHistory: description: Histórico da Solicitação type: object required: – id – processInstanceId – historyType – historyDate – userName properties: id: type: string description: Identificador processInstanceId: type: integer format: int64 description: Identificador da Instancia do Proceso historyType: type: string allOf: – #/definitions/requestHistoryType description: Tipo de Entrada Histórico historyDate: type: string format: date-time description: Data do Histórico userName: type: string description: Usuário responsável impersonatedUserName: type: string description: Ação executada em nome do usuário taskName: type: string description: Nome da Tarefa actionName: type: string description: Nome ação Executada commentId: type: integer format: int64 description: Identificador do Comentário attachment: type: string description: Identificador do Anexo Incluido userIpAddress: type: string description: Endereço IP do usuário responsibleOld: type: string description: Responsável anterior da tarefa responsibleNew: type: string description: Responsável novo da tarefa cancelReason: type: string description: Motivo Cancelamento Solicitação formValueHistoryId: type: integer format: int64 description: Identificador do histórico de valores do formulário formValueHistory: description: Valor do histórico do formulário type: object required: – id – value properties: id: type: integer format: int64 description: Identificador value: type: string format: byte description: JSON dos valores do formulário vinculados à etapa calendar: description: Calendário de Processos BPM type: object required: – id – name – workMon – workTue – workWed – workThu – workFri – workSat – workSun properties: id: type: string description: Identificador name: type: string description: Nome do Calendário startTime: type: integer format: int64 description: Inicio do Trabalho em Minutos default: 0 endTime: type: integer format: int64 description: Fim do Trabalho em Minutoso default: 1440 workMon: type: boolean description: Considerar Segunda-Feira workTue: type: boolean description: Considerar Terça-Feira workWed: type: boolean description: Considerar Quarta-Feira workThu: type: boolean description: Considerar Quinta-Feira workFri: type: boolean description: Considerar Sexta-Feira workSat: type: boolean description: Considerar Sábado workSun: type: boolean description: Considerar Domingo holiday: description: Dias de Feriado type: object required: – id – day – name properties: id: type: string description: Identificador day: type: string format: date description: Dia do Feriado name: type: string description: Nome do Feriado notificationPreferences: description: Preferencias de notificação type: object required: – id – type – newRequest – endProcess – cancelProcess – taskExpiration – newTask – newComment properties: id: type: string description: Identificador userName: type: string description: Nome do usuario processId: type: integer format: int64 description: Identificador do processo type: type: string allOf: – #/definitions/notificationKind description: Tipo da notificação newRequest: type: boolean description: Nova solicitação endProcess: type: boolean description: Solicitação encerrada cancelProcess: type: boolean description: Solicitação cancelada taskExpiration: type: boolean description: Prazo de Expiração da tarefa newTask: type: boolean description: Nova tarefa newComment: type: boolean description: Novo comentário tag: description: Tags Categoria para os Processo type: object required: – id – name properties: id: type: string description: Identificador name: type: string description: Nome da Tag processConfig: description: Configurações do Processo type: object required: – processId – ownerID – icon properties: processId: type: integer format: int64 description: Identificador do processo name: type: string description: Nome do processo description: type: string description: Descrição ownerID: type: integer format: int64 description: ID do subject dono do processo tag: type: object allOf: – #/definitions/tag description: Categoria executionType: type: string allOf: – #/definitions/processExecutionType description: Tipo de execução entityName: type: string description: Nome da entidade ECM entityVersion: type: integer format: int64 description: Versão da entidade ECM formHostedName: type: string description: Nome do formulário externo hospedado formHostedVersion: type: string description: Id da versão do formulário externo hospedado formUrl: type: string description: Url do formulário WEB icon: type: string description: Ícone do Processo taskVisibleAfterTreated: type: boolean description: DEPRECADO – Se a tarefa estará visível após ser tratada variableVisibility: type: string allOf: – #/definitions/variableVisibility description: Tipo de visibilidade das variáveis para consulta generateView: type: boolean description: Define se irá gerar a view para o visões dinâmicas viewName: type: string description: Nome da view para visões dinâmicas exclusionUser: type: string description: Usuário que excluiu exclusionDate: type: string format: date description: Data de exclusão processKey: type: string description: Identificador Chave do Processo resourceURI: type: string description: URI do recurso do processo enableRating: type: boolean description: Habilita avaliação para o processo attachTabVisibility: type: boolean description: Mostra ou oculta a tela de abas da solicitação thirdPartyPermission: type: boolean description: Define a permissão de edição do processo por terceiros que importam o processo tenantOwner: type: string description: Tenant dono do processo templateUniqCode: type: integer format: int64 description: Campo sequencial do template enableUserInCopyConfig: type: boolean description: Habilita usuário em cópia para o processo requestSubjectMandatory: type: boolean description: Define se o campo de assunto da solicitação será obrigatório ou opcional useNewForm: type: boolean description: Habilita o uso do novo formulário processReportStatus: description: Processo de Geração do formulario type: object required: – processInstanceId – reportId – userName – status properties: id: type: string format: uuid description: Identificador do log processInstanceId: type: integer format: int64 description: Identificador do processo reportId: type: string description: Identificador do formulario a ser gerado userName: type: string description: Identificador do usuario status: type: string allOf: – #/definitions/reportGenerationStatus description: Status da geração activity: description: Atividade do fluxo type: object required: – id – processId – processVersion – activityId – activityName – distanceToFinish properties: id: type: string description: Identificador gguid da atividade processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo activityId: type: integer format: int64 description: Id da atividade no fluxo activityName: type: string description: Nome da atividade distanceToFinish: type: integer format: int64 description: Distância para o fim do processo mais distante featureToggle: description: Configurações do sistema que permitem type: object required: – id – feature – enable properties: id: type: string description: Identificador feature: type: string description: Nome da Funcionalidade enable: type: boolean description: Indica se a funcionalidade esta habilitada processThumbnail: description: Miniatura do processo type: object required: – id – processId – processVersion – uri – lastModifiedDate properties: id: type: string description: Identificador da miniatura processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo uri: type: string description: URI para download lastModifiedDate: type: string format: date-time description: Ultima modificação miniatura processDocumentConfig: description: Configuraçao para integração com Gestão de Documentos type: object required: – id – processId – processVersion – folder – publishedKind – author – permission properties: id: type: string description: Identificador processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo folder: type: string description: Pasta de Destino dos Documentos subjectName: type: string maxLength: 100 description: Nome do Assunto do Documento publishedKind: type: string allOf: – #/definitions/documentPublicationType description: Tipo de Publicação publishedCondition: type: string maxLength: 255 description: Condição para publicação de documentos author: type: string allOf: – #/definitions/documentSetting description: Configuração para obter o autor do documento no GED authorUserName: type: string maxLength: 255 description: Nome do Autor quando opta-se por informar o valor usuário permission: type: string allOf: – #/definitions/documentSetting description: Configuração de Permissão de visualizar o documento no GED permissionRoleName: type: string maxLength: 255 description: Nome do Papel quando opta-se por informar o valor publishedDocumentControl: description: Tabela para controle de documentos publicados type: object required: – id – processId – processInstanceId – targetObjectId – fileName – version – fileSize – origin – fileUrl – input – created – createdBy – status properties: id: type: string description: Identificador processId: type: integer format: int64 description: Indentificador do process processInstanceId: type: integer format: int64 description: Identificador da Instância do Proceso targetObjectId: type: string description: Identificador do Arquivo Origem fileName: type: string description: Nome do Arquivo type: string description: Versão do Arquivo fileSize: type: integer format: int64 description: Tamanho Arquivo origin: type: string description: Origem Arquivo BPM ou ECM variableName: type: string description: Nome da variavel associada ao documento fileUrl: type: string description: URL do arquivo quando feito o upload input: type: string maxLength: 1024 description: Entrada de Dados da solicitação ticketId: type: string description: Ticket de solicitação para publicação documento documentId: type: string description: Identificador Documento published: type: boolean description: Documento publicado no GED created: type: string format: date-time description: Data da Execução createdBy: type: string maxLength: 255 description: Usuario que executou a requisicao status: type: string allOf: – #/definitions/integrationStatus description: Estado de upload do documento log: type: string maxLength: 2048 description: Mensagem de erro rating: description: Tabela com os dados de rating do workflow type: object required: – appKey properties: appKey: type: string description: AppKey gerado pelo rating integrationEvent: description: Eventos de integrações do processo type: object required: – id – processId – processInstanceId – created – createdBy – status – type – ticketId – data – notified properties: id: type: string description: Identificador processId: type: integer format: int64 description: Identificador do processo processInstanceId: type: integer format: int64 description: Identificador da instância do processo created: type: string format: date-time description: Data da Execução createdBy: type: string maxLength: 255 description: Usuario que executou a requisicao status: type: string allOf: – #/definitions/integrationStatus description: Estado do evento de integração type: type: string allOf: – #/definitions/integrationEventType description: Tipo do evento de integração ticketId: type: string description: Identificador do ticket data: type: string format: byte description: Dados da integração no formato PublishedDocumentControl ou ServiceIntegrationEvent notified: type: boolean description: Se o resultado dessa integração gerou uma notificação serviceIntegrationEvent: description: Eventos de integrações do processo type: object required: – id – name – created – createdBy – statusCode – requestTime – requestUrl properties: id: type: string description: Identificador name: type: string description: Nome do Serviço created: type: string format: date-time description: Data da Execução createdBy: type: string maxLength: 255 description: Usuario que executou a requisicao statusCode: type: integer format: int64 description: Status Http requestTime: type: integer format: int64 description: Tempo da Execução em milisegundos requestUrl: type: string maxLength: 512 description: URL da requisição log: type: string maxLength: 2048 description: Log da Execucao processId: type: integer format: int64 description: Identificação Processo processInstanceId: type: integer format: int64 description: Identificação da Solicitação type: type: string allOf: – #/definitions/IntegrationServiceEventType description: Tipos de retorno do serviço externo inputParams: type: string description: Parâmetros de entrada da requisição responseContent: type: string description: Resposta do serviço processSignConfig: description: Configuração para integração com o Sign type: object required: – id – processId – processVersion – envelopeName – geolocation – envelopeManagement properties: id: type: string description: Identificador processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo envelopeName: type: string maxLength: 180 description: Nome do envelope geolocation: type: string allOf: – #/definitions/geolocationSetting description: Solicitar geolocalização daysToExpire: type: integer format: int64 description: Prazo para expiração do envelope minimum: 1 maximum: 120 default: 120 daysToNotify: type: integer format: int64 description: Quantidade de dias para notificar caso a assinatura esteja pendente instructionsToSigner: type: string maxLength: 1000 description: Texto com instruções para o assinante envelopeManagement: type: string allOf: – #/definitions/envelopeManagementSetting description: Responsável pela gestão do envelope subjectId: type: integer format: int64 description: Id do subject quando opta-se por informar um usuário ou papel como responsável pela gestão do envelope subjectName: type: string description: Nome do subject quando opta-se por informar um usuário ou papel como responsável pela gestão do envelope envelope: description: Dados do envelope type: object required: – id – processId – processVersion – processInstanceId – processStep – envelopeStatus – envelopeManagement – envelopeSigner properties: id: type: string description: Identificador processId: type: integer format: int64 description: Id do processo processVersion: type: integer format: int64 description: Versão do processo processInstanceId: type: integer format: int64 description: Instância de processo criada processStep: type: integer format: int64 description: Etapa do processo em que o envelope será criado envelopeId: type: string description: Id do envelope criado no SIGN envelopeStatus: type: string allOf: – #/definitions/envelopeStatus description: Status do envelope envelopeManagement: type: string description: Informa o responsável pela gestão do envelope quando o modelo escolhido for do tipo solicitante envelopeSigner: type: string description: Responsável pela assinatura do envelope envelopeDocument: description: Dados do documento do envelope type: object required: – id – envelopeId – ticketId – documentUploadStatus – eventIntegrationId properties: id: type: string description: Identificador envelopeId: type: string description: ticketId: type: string description: Ticket do documento integrado com o GED documentId: type: string description: Id do documento integrado com o GED documentVersionId: type: string description: Id de versão do documento integrado com o GED documentUploadStatus: type: string allOf: – #/definitions/documentUploadStatus description: Status do upload do arquivo realizado pelo GED eventIntegrationId: type: string description: Id do evento de integração notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação