2.0info: 1.0.0-SNAPSHOT bpm_timeout description: x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: bpm_timeout contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /platform/bpm_timeoutsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /startProcess: post: description: Inicia um processo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – processId – businessData – flowExecutionData – ticketRequest 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 externalServiceOverrideBusinessData: type: boolean description: Se existir um serviço externo antes da primeira etapa, o mesmo deve sobrescrever as variáveis enviadas no businessData ticketRequest: type: string description: Ticket de espera para o frontend 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. default: description: Error response schema: #/definitions/genericError get: description: Inicia um processo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – processId – businessData – flowExecutionData – ticketRequest 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 externalServiceOverrideBusinessData: type: boolean description: Se existir um serviço externo antes da primeira etapa, o mesmo deve sobrescrever as variáveis enviadas no businessData ticketRequest: type: string description: Ticket de espera para o frontend 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. default: description: Error response schema: #/definitions/genericError /getFormAccessProperties: post: description: Obtém as informações de acesso de um formulário necessárias para iniciar ou responder um processo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – processState – ticketRequest properties: processState: #/definitions/processState serviceFlowToken: #/definitions/serviceFlowToken processId: type: integer description: Id do processo authorization: type: string description: String de autorização para integrações ticketRequest: type: string description: Ticket de espera para o frontend responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError get: description: Obtém as informações de acesso de um formulário necessárias para iniciar ou responder um processo x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – processState – ticketRequest properties: processState: #/definitions/processState serviceFlowToken: #/definitions/serviceFlowToken processId: type: integer description: Id do processo authorization: type: string description: String de autorização para integrações ticketRequest: type: string description: Ticket de espera para o frontend responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /getTicketResponse: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – ticketRequest properties: ticketRequest: type: string description: responses: 200: description: Ok schema: type: object required: – response properties: response: type: string description: default: description: Error response schema: #/definitions/genericError get: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – ticketRequest properties: ticketRequest: type: string description: responses: 200: description: Ok schema: type: object required: – response properties: response: type: string description: default: description: Error response schema: #/definitions/genericError /responsePendency: post: description: Responde uma pendência x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – serviceFlowToken – ticketRequest 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 ticketRequest: type: string description: Ticket de espera para o frontend 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 get: description: Responde uma pendência x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – serviceFlowToken – ticketRequest 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 ticketRequest: type: string description: Ticket de espera para o frontend 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/genericErrordefinitions: processState: type: string enum: – New – Started 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 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 userInCopy: type: integer description: Usuário em cópia que pode receber a próxima ação substituteUser: type: integer description: Usuário substituto que poderá receber a próxima ação 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