2.0info: 1.2.2 ged_bulk x-senior-domain: flow x-senior-domain-path: flow x-senior-service-path: ged_bulk contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/flowsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ged_bulk/queries/healthcheck: post: description: Endpoint para verificação da saúde 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/healthcheckStatus description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde 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/healthcheckStatus description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ged_bulk/queries/getDocumentDownloadZipUrl: post: description: Obtem Presigned Url para download de arquivos em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – downloadBulkId properties: downloadBulkId: type: string description: Identificador da requisição de download em massa responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Endereço para download 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem Presigned Url para download de arquivos em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: downloadBulkId description: Identificador da requisição de download em massa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: Endereço para download 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ged_bulk/queries/listDownloadTasks: post: description: Lista as tasks de download do tenant de forma paginada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – page – size properties: page: type: integer format: int64 description: Índice da página a ser retornada. Padrão 0. size: type: integer format: int64 description: Quantidade de itens que serão exibidos por página. responses: 200: description: Ok schema: type: object required: – totalTasks properties: tasks: type: array items: type: object allOf: – #/definitions/downloadTaskDTO description: Lista de tasks de download totalTasks: type: integer format: int64 description: Total de tasks encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as tasks de download do tenant de forma paginada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Índice da página a ser retornada. Padrão 0. in: query required: true type: integer format: int64 – name: size description: Quantidade de itens que serão exibidos por página. in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalTasks properties: tasks: type: array items: type: object allOf: – #/definitions/downloadTaskDTO description: Lista de tasks de download totalTasks: type: integer format: int64 description: Total de tasks encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ged_bulk/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 /ged_bulk/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ged_bulk/actions/requestDocumentDownloadZip: post: description: Solicita a geração de um zip para download baseado na versão publicada dos documentos informados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: documentIds: type: array items: type: string description: lista de identificadores dos documentos folderIds: type: array items: type: string description: lista de identificadores de pastas. As subpastas também serão baixadas. name: type: string description: Nome da solicitação de download para organização tags: type: array items: type: string description: Lista de tags para organizar os downloads responses: 200: description: Ok schema: type: object required: – downloadBulkId properties: downloadBulkId: type: string description: Identificador da requisição de download em massa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ged_bulk/actions/copyDocuments: post: description: Solicita a cópia de documentos e pastas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: copyProcessId: type: string description: Identificador do processo de requisição de cópia de documentos documentsToCopy: type: array items: type: object allOf: – #/definitions/documentsToCopyDTO description: lista de documentos a serem copiados responses: 200: description: Ok schema: type: object required: – copyProcessId properties: copyProcessId: type: string description: Identificador da requisição de cópia de documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ged_bulk/signals/generateReportExcel: post: description: Gerar um relatório de assinaturas em excel tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – reportId – reportType properties: reportId: type: string description: Identificador do relatório gerado no GED reportType: type: string allOf: – #/definitions/reportExcelType description: Tipo do relatório responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /ged_bulk/events/downloadZippedFolder: post: description: Evento disparado ao finalizar a compactação do arquivo de download. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – downloadUrl – downloadBulkId properties: downloadUrl: type: string description: Url disponível para download downloadBulkId: type: string description: Identificação do download responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: reportExcelType: type: string enum: – SIGNATURES – SIGNATURES_DOCUMENTS – ENVELOPES_COUNT_BY_REQUESTER description: Tipos de Relatório em Excel disponíveis: * `SIGNATURES` – Assinaturas * `SIGNATURES_DOCUMENTS` – Documentos * `ENVELOPES_COUNT_BY_REQUESTER` – Quantidade de Envelopes por Solicitante fileKind: type: string enum: – FOLDER – DOCUMENT description: Tipo de Arquivo: * `FOLDER` – Pasta * `DOCUMENT` – Documento healthcheckStatus: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Executando normalmente * `DOWN` – Com problemas userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text signatureDTO: description: Dados da assinatura type: object required: – envelopeId – signerId – documentVersionId – name – email – status – documentName – date – envelopeName – createdBy properties: envelopeId: type: string description: Identificador do envelope signerId: type: string description: Identificador do assinante documentVersionId: type: string description: Identificador do documento name: type: string description: Nome do assinante email: type: string description: Email do assinante status: type: string description: Status documentName: type: string description: Nome do documento date: type: string format: date-time description: Data da criação da assinatura envelopeName: type: string description: Nome do envelope signatureDate: type: string format: date-time description: Data da Assinatura folderName: type: string description: Nome da pasta onde está o documento documentStatus: type: string description: Status do documento createdBy: type: string description: Email do solicitante signerSubType: type: string description: Sub tipo da assinatura do usuário authenticationType: type: string description: Tipo da assinatura signerType: type: string description: Tipo do assinante readyToSign: type: boolean description: Apto para assinar dependendo do fluxo de assinatura declinedReason: type: string description: Motivo de recusa envelopesCountByRequesterDTO: description: Dados para o relatório de quantidade de envelopes por solicitante type: object required: – createdBy – created – inProcess – finished – expired properties: createdBy: type: string description: Solicitante e-mail created: type: integer format: int64 description: Envelopes criados inProcess: type: integer format: int64 description: Envelopes em processo finished: type: integer format: int64 description: Envelopes finalizados expired: type: integer format: int64 description: Envelopes expirados downloadTaskDTO: description: Dados da task de download type: object required: – id – downloadBulkId – createdAt – createdBy properties: id: type: string description: Identificador da task name: type: string description: Nome da solicitação de download tags: type: array items: type: string description: Lista de tags downloadBulkId: type: string description: Identificador do Download em Lote createdAt: type: string format: date-time description: Data de criação da task createdBy: type: string description: Nome do usuário que criou a task documentsToCopyDTO: description: Dados da task de copiar documentos e pastas type: object required: – originalUploadId – newUploadId – originalFileName properties: originalUploadId: type: string description: Id de upload do documento a ser copiado newUploadId: type: string description: Id de upload do documento que será criado como cópia originalFileName: type: string description: Nome original do documento healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde 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. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage