Workflow (workflow)

Workflow (workflow)

71 views 01/10/2020 21/11/2020 integrador 0

2.0info: 5.27.7 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: api.senior.com.br /platform/workflow/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /actions/linkAttachments: post: description: Liga determinados anexos a uma instância de processo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – ids – processInstance properties: ids: type: array items: type: string description: Identificadores de anexo processInstance: type: integer description: Identificador da instância de processo a qual o arquivo pertence. responses: 200: description: Ok 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/startProcess: post: description: Inicia um processo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – processId – businessData – flowExecutionData properties: processInstanceID: type: integer 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. processId: type: integer description: Número do processo processVersion: type: integer description: Versão do Processo businessData: type: string description: Variáveis de Negócio do Processo flowExecutionData: #/definitions/flowExecutionData 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 responses: 200: description: Ok schema: type: object required: – processInstanceID properties: processInstanceID: type: integer 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 /actions/cancelProcessInstance: post: description: Cancela uma lista de processos. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – ids – reason properties: ids: type: array items: type: integer description: Identificadores das instâncias de processo a serem canceladas. reason: type: string description: Motivo do cancelamento. responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /queries/getSubjects: post: description: Obtém ou usuários e grupos conforme o tipo (usuário ou grupo). x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – type properties: page: type: integer description: Página ser consultada pageSize: type: integer description: Quantidade de itens na página nameFilter: type: string description: filtro pelo nome type: #/definitions/subjectKind includeRemoved: type: boolean description: Incluir usuários removidos responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: #/definitions/serviceSubject totalElements: type: integer description: Total de Itens totalPages: type: integer description: Total de Paginas default: description: Error response schema: #/definitions/genericError /actions/responsePendency: post: description: Responde uma pendência x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken properties: serviceFlowToken: #/definitions/serviceFlowToken responseData: #/definitions/responseData authorization: type: string description: String de autorização executada da tarefa do workflow comment: type: string description: Comentário para solicitação responses: 200: description: Ok 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 /queries/getNextSubject: post: description: Obtém um ou mais responsáveis possíveis da próxima tarefa. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken – sequenceName properties: serviceFlowToken: #/definitions/serviceFlowToken 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: #/definitions/serviceSubject dependsOnNextStep: type: boolean description: Depende da execução do próxima etapa para identificar a atribuição default: description: Error response schema: #/definitions/genericError /actions/changePendencyUser: post: description: Atribui a pendência para outro usuário x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – serviceFlowTokens – subject properties: serviceFlowTokens: type: array items: #/definitions/serviceFlowToken description: Lista dos identificadores da tarefas subject: #/definitions/serviceSubject responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /queries/getRequestHistoryTimeline: post: description: Obtém uma linha do tempo com o registro de ações e observações de uma solicitação x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – processInstanceID properties: processInstanceID: type: integer 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: #/definitions/requestHistoryTimelineEntry default: description: Error response schema: #/definitions/genericError /queries/findProcess: post: description: Retorna um processo do workflow x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer description: Filtra pelo id responses: 200: description: Ok schema: type: object required: – process properties: process: #/definitions/serviceProcess default: description: Error response schema: #/definitions/genericError /queries/getProcessesList: post: description: Obtém os processos ativos que o usuário logado tem algum tipo de permissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – serviceAction properties: serviceAction: #/definitions/serviceType processFilterType: #/definitions/processFilterType tagFilter: type: string description: Tag para filtro onlyActiveProcesses: type: boolean description: Apenas retorna processos ativos serviceEventStartDate: type: string description: A partir de qual data buscar eventos de serviços externos responses: 200: description: Ok schema: type: object properties: processes: #/definitions/serviceProcess default: description: Error response schema: #/definitions/genericError /queries/getProcessInstance: post: description: Obtém os as informações de uma instância de processo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – processInstance properties: processInstance: type: integer description: Identificador da instaância de Processo responses: 200: description: Ok schema: type: object required: – processInstance properties: processInstance: #/definitions/processInstance default: description: Error response schema: #/definitions/genericError /actions/batchPendenciesResponse: post: description: Responde pendências em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – flowTokens – authorization properties: flowTokens: type: array items: #/definitions/flowToken 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 default: description: Error response schema: #/definitions/genericError /queries/getPendencyProcessActions: post: description: Obtém as opções disponíveis para execução de uma pendência. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – serviceFlowToken properties: serviceFlowToken: #/definitions/serviceFlowToken responses: 200: description: Ok schema: type: object required: – pendencyProcessAction properties: pendencyProcessAction: #/definitions/processAction default: description: Error response schema: #/definitions/genericError /actions/newAttachment: post: description: Cria uma nova representação de um anexo do Workflow x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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 description: Tamanho do arquivo a ser anexado responses: 200: description: Ok schema: type: object required: – attachment – uploadUrl properties: attachment: #/definitions/serviceAttachment uploadUrl: type: string description: URL para o anexo 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getThirdPartyRequestByStatus: post: description: Lista as solicitações de Aplicações Terceiras por Status x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – processKey – status properties: processKey: type: string description: Nome da Chave do Processo status: #/definitions/pendencyType responses: 200: description: Ok schema: type: object required: – requests properties: requests: #/definitions/thirdpartyRequestResume default: description: Error response schema: #/definitions/genericError /actions/commitAttachment: post: description: Faz commit de um anexo movendo ele da área temporária para permanente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do anexo responses: 200: description: Ok 404: description: Objeto não encontrado 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getMyPendencies: post: description: DEPRECADO – Obtém as pendências do usuário logado conforme o tipo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: pendencyRequestParameters: #/definitions/pendencyRequestParameters responses: 200: description: Ok schema: type: object required: – pendencies properties: pendencies: #/definitions/pendency total: type: integer description: . default: description: Error response schema: #/definitions/genericError /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. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – processId – processVersion – sequenceName properties: processId: type: integer description: Identificador do Processo processVersion: type: integer description: Versão do Processo sequenceName: type: string description: Nome da Sequencia do Processo Modealdor customParams: type: array items: #/definitions/keyValueRecord description: Parametros para Mecanismo Customizado authorization: type: string description: Token de autenticação da G7 responses: 200: description: Ok schema: type: object required: – subjects properties: subjects: #/definitions/serviceSubject dependsOnNextStep: type: boolean description: Depende da execução do próxima etapa para identificar a atribuição default: description: Error response schema: #/definitions/genericError /queries/getRequestsResume: post: description: Obtem o resumo das solicitações x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: start: type: integer description: Faixa inicial da consulta limit: type: integer description: Quantidade de linhas da consulta filterProcess: type: array items: type: integer description: Filtro com lista de processos separado por virgula filterValue: type: string description: Filtro para buscar pelo nome da pendencia ou valor das variáveis do processo filter: type: array items: #/definitions/myRequestKind description: Filtro por status orders: type: array items: #/definitions/keyValueRecord description: situation: #/definitions/reportTaskExpirationStatus responses: 200: description: Ok schema: type: object properties: requestsResume: #/definitions/myRequestsResume total: type: integer description: Número Total de Instancia de Procesos default: description: Error response schema: #/definitions/genericError /queries/getRankingProcesses: post: description: Lista os processos mais utilizados pelo usuário x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: start: type: string description: Data Inicial para processar o ranking, se não informada usa data hoje menos 6 meses end: type: string description: Data Final para processar o ranking, se não informado usa data hoje limit: type: integer description: Especifica o número de procesos para retornar responses: 200: description: Ok schema: type: object properties: processes: #/definitions/processRanking default: description: Error response schema: #/definitions/genericError /queries/searchTasks: post: description: Listar tarefas na nova central de tarefas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: filter: #/definitions/searchTasksFilter pagination: #/definitions/pagination orders: type: array items: #/definitions/order description: Ordenação responses: 200: description: Ok schema: type: object required: – tasks – total properties: tasks: #/definitions/task total: type: integer description: Total de registros 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: subjectKind: type: string enum: – User – Group – Role – UserApp myRequestKind: type: string enum: – InProgress – Completed – Canceled reportTaskExpirationStatus: type: string enum: – InProgress – WillExpire – Expired pendencyType: type: string enum: – Pending – Treated – All serviceType: type: string enum: – UserGrantedProcesses – UserGrantedCordinateProcesses – AllProcesses – UserGrantedOrEditProcesses processFilterType: type: string enum: – Embedded – NotEmbedded – All orderField: type: string enum: – REQUESTER – RESPONSIBLE – STATUS – START_DATE – END_DATE – EXPIRATION_DATE – PROCESS_NAME orderDirection: type: string enum: – ASC – DESC taskStatus: type: string enum: – UNREADED – READED – PENDING – TREATED pendencyResponseStatus: type: string enum: – WAITING – EXECUTING – ERROR processPublicationStatus: type: string enum: – Saved – Published processAccessLevel: type: string enum: – EDIT_AND_START – START – EDIT – NONE IntegrationServiceEventType: type: string enum: – CONNECTION_TIMEOUT – CONNECTION_ERROR – SERVICE_RESPONSE_READ_ERROR – SERVICE_ERROR – INVALID_SERVICE_RESPONSE – SUCCESS – EXECUTION_ERROR requestHistoryType: type: string enum: – STARTED – COMMENT – ATTACHMENT_ADDED – ATTACHMENT_REMOVED – CHANGE_RESPONSIBLE – CANCEL_PENDENCY – RESPONSE_PENDENCY – FINISHED order: type: object required: – field – direction properties: field: #/definitions/orderField direction: #/definitions/orderDirection searchTasksFilter: 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: type: object required: – processId – processInstanceId – activity – startDate – requesterName – activityId – step – pendencyCount – responseStatus properties: processId: type: integer description: Id do processo processName: type: string description: Nome do processo processInstanceId: type: integer description: Id da instância do processo activity: type: string description: Atividade detail: type: string description: Detalhes do processo startDate: type: string description: Data de início da tarefa/processo format: date-time endDate: type: string description: Data de fim da tarefa/processo format: date-time expirationDate: type: string description: Data de expiração da tarefa/processo format: date-time responsableName: type: string description: Nome do responsável pela tarefa requesterName: type: string description: Nome do solicitante taskStatus: #/definitions/taskStatus requestStatus: #/definitions/myRequestKind type: string description: Título da Solicitação activityId: type: integer description: Id da atividade step: type: integer description: Passo pendencyCount: type: integer description: Número de pendências de uma solicitação responseStatus: #/definitions/pendencyResponseStatus myRequestsResume: type: object required: – processInstanceId – processName – startDate – endDate – status – activityName – taskUser – expirationDate – processId – processVersion – embedded – detail properties: processInstanceId: type: integer description: Instancia de Processo processName: type: string description: Nome do Processo startDate: type: string description: Criação da Soliciatção format: date-time endDate: type: string description: Enceramento da Solicitação format: date-time 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 description: Data de Expiração format: date-time processId: type: integer description: Identificador do Processo processVersion: type: integer 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: #/definitions/serviceFlowToken description: Identificador de uma pendência. serviceFlowToken: type: object required: – processInstanceID – step – activityId properties: processInstanceID: type: integer description: Identificador da Instância do Proceso step: type: integer description: Identificador da Etapa do Processo activityId: type: integer description: Identificador da Atividade serviceProcess: type: object required: – processId – currentVersion – processName – processRawName – changed – fileName – status – description – creationDate properties: processId: type: integer description: Identificador do Processo currentVersion: type: integer description: Versão Atual 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: #/definitions/processPublicationStatus description: type: string description: Descrição do processo creationDate: type: string description: Data de criação do processo format: date-time 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: #/definitions/processAccessLevel icon: type: string description: Ícone do processo serviceEventQtyByType: type: array items: #/definitions/serviceEventQtyByType description: Listagem dos tipos e quantidade de eventos de serviço externo serviceEventQtyByType: type: object required: – type – quantity properties: type: #/definitions/IntegrationServiceEventType quantity: type: integer description: quantidade de eventos processRanking: type: object required: – processId – currentVersion – processName – requests properties: processId: type: integer description: Identificador do Processo currentVersion: type: integer 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 description: Número de solicitações pendency: type: object required: – serviceFlowToken – description – hint – currentSubject – delegatorSubject – startDate – lastUpdateDate – expirationDate – performerId – processInstance – type – pool properties: serviceFlowToken: #/definitions/serviceFlowToken description: type: string description: hint: type: string description: currentSubject: #/definitions/serviceSubject delegatorSubject: #/definitions/serviceSubject startDate: type: string description: format: date-time lastUpdateDate: type: string description: format: date-time expirationDate: type: string description: format: date-time performerId: type: string description: processInstance: #/definitions/processInstance type: #/definitions/pendencyType pool: type: boolean description: type: string description: serviceSubject: type: object required: – userCode – name – subjectKind properties: userCode: type: integer description: name: type: string description: subjectKind: #/definitions/subjectKind processInstance: type: object required: – id – process – startedSubject – cancelSubject – startDate – lastUptadeDate – endDate – flowExecutionStatus – endMessage – description – flowToken – taskExpiration properties: id: type: integer description: process: #/definitions/serviceProcess startedSubject: #/definitions/serviceSubject cancelSubject: #/definitions/serviceSubject startDate: type: string description: format: date-time lastUptadeDate: type: string description: format: date-time endDate: type: string description: format: date-time flowExecutionStatus: type: string description: endMessage: type: string description: description: type: string description: flowToken: type: array items: #/definitions/serviceFlowToken description: taskExpiration: type: string description: format: date-time flowToken: type: object required: – processInstanceId – step – activityId properties: processInstanceId: type: integer description: Identificador da Instancia do Proceso step: type: integer description: Identificador da Etapa do Processo activityId: type: integer description: Identificador da Atividade pendencyRequestParameters: type: object properties: start: type: integer description: Faixa inicial da consulta limit: type: integer description: Quantidade de linhas da consulta type: #/definitions/pendencyType filterValue: type: string description: Filtro para buscar pelo nome da pendencia ou valor das variáveis do processo processFilterType: #/definitions/processFilterType pagination: type: object properties: start: type: integer description: Faixa inicial da consulta limit: type: integer description: Quantidade de linhas da consulta responseData: type: object properties: businessData: type: string description: Dados de Negócio do Processo flowExecutionData: #/definitions/flowExecutionData flowExecutionData: 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 processAction: type: object required: – name – label – finish – connectsWithAutomaticGateway – isAppUser properties: name: type: string description: label: type: string description: finish: type: boolean description: connectsWithAutomaticGateway: type: boolean description: isAppUser: type: boolean description: serviceAttachment: type: object required: – id – name – size – uploadDate – addedBy properties: id: type: string description: Identificador do anexo name: type: string description: Nome do arquivo anexado size: type: integer description: Tamanho do arquivo anexado uploadDate: type: string description: Data do envio format: date-time addedBy: type: string description: Responsável pelo anexo keyValueRecord: type: object required: – key – value properties: key: type: string description: Nome da Chave value: type: string description: Valor requestHistoryTimelineEntry: type: object required: – processInstanceId – historyType – historyDate – userName – oldResponsible – newResponsible properties: processInstanceId: type: integer description: Identificador da Instancia do Proceso historyType: #/definitions/requestHistoryType historyDate: type: string description: Data do Histórico format: date-time 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 userIpAddress: type: string description: Endereço IP do usuário comment: type: string description: Comentário realizado na etapa do processo 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 thirdpartyRequestResume: type: object required: – flowToken – processData properties: flowToken: #/definitions/serviceFlowToken thirdpartyId: type: string description: Identificador da aplicação terceira processData: type: string description: Dados das variáveis do processo format: byte 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