2.0info: 0.2.1 blob description: Serviço responsável pelas operações em relação ao serviço de blob(WMSX-Blob) x-senior-domain: WMSX x-senior-domain-path: wmsx x-senior-service-path: blob_service 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/wmsxsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /blob_service/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 /blob_service/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 /blob_service/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /blob_service/actions/requestUpload: post: description: Solicita o upload de um arquivo anexado ao objeto de destino fornecido. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/wmsxBlobRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/wmsxBlobDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /blob_service/actions/commitFile: post: description: Confirma o arquivo disponível no local de trabalho fornecido como um anexo permanente para um objeto de destino.\nQuando a operação realmente for concluída, um sinal fileCommitted será enviado.\nApenas o serviço que possui o próprio blob pode confirmar um arquivo. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/wmsxCommitFileInput responses: 200: description: Ok schema: type: object allOf: – #/definitions/wmsxCommitFileOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /blob_service/actions/requestAccess: post: description: Requests access to a blob. The blob will be available upon completion of this action. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/wmsxBlobRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/wmsxBlobDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /blob_service/actions/deleteFile: post: description: Exclui um arquivo permanentemente. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/wmsxDeleteFileInput responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: wmsxProtocol: description: When requesting a blob location, clients can specify the protocols they can work with.\nImplementation note: only HTTP is available at this time. type: string enum: – File – HTTP – S3 – DAV wmsxRequirement: description: When requesting access to a blob, clients can specify the desired location requirements.\nOpen: the location URI must be promptly accessible, without requiring additional credentials;\nExternal: the location URI must be accessible from the internet (as opposed to only accessible from the local network);\nTemporary: the location URI should be temporary (as opposed to fixed). type: string enum: – Open – External – Temporary wmsxFileType: description: All known file types. type: string enum: – Unknown – PDF – MsWord – MsExcel – MsPowerPoint – MsVisio – MsOutlook – MsPublisher – OoxmlWord – OoxmlExcel – OoxmlPowerPoint – OoxmlVisio – PlainText – Image – Video – Audio 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 healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN wmsxCredentials: description: A base type for types of credentials. discriminator: _discriminator type: object required: – _discriminator properties: _discriminator: type: string description: wmsxUsernameAndPassword: description: allOf: – #/definitions/wmsxCredentials – type: object required: – username – password properties: username: type: string description: password: type: string description: wmsxKey: description: allOf: – #/definitions/wmsxCredentials – type: object required: – value properties: value: type: string description: wmsxLocation: description: Location type: object required: – protocol – uri properties: protocol: type: string allOf: – #/definitions/wmsxProtocol description: uri: type: string description: credentials: type: object allOf: – #/definitions/wmsxCredentials description: wmsxBlobRequest: description: Representa os dados para solicitar operações de arquivo no serviço Blob. type: object required: – targetObjectId properties: targetObjectId: type: string description: Identificador único do arquivo. fileName: type: string description: O nome efetivo do arquivo. type: string description: Versão do arquivo token: type: string description: As versões podem ter tokens secretos para controlar o acesso requirements: type: array items: type: string allOf: – #/definitions/wmsxRequirement description: Requisitos de localização supportedProtocols: type: array items: type: string allOf: – #/definitions/wmsxProtocol description: Os protocolos de transferência de arquivos que o cliente pode suportar. style: type: string description: O tamanho/estilo/formato ex: 32×32#, 50×50 onde indicado para manter a proporção ttl: type: integer format: int64 description: Tempo de vida do arquivo em segundos minimum: 1 maximum: 31536000 wmsxBlobDetails: description: Representa a saída das operações de blob type: object required: – targetObjectId – location properties: targetObjectId: type: string description: Identificador único do arquivo type: string description: Qual a versão? token: type: string description: As versões podem ter tokens secretos para controlar o acesso location: type: object allOf: – #/definitions/wmsxLocation description: Localização do arquivo fileName: type: string description: O nome efetivo do arquivo wmsxCommitFileInput: description: Registro de entrada para confirmar o arquivo no serviço de armazenamento type: object required: – targetObject – version – release – fileName properties: targetObject: type: string description: Identificador único do arquivo type: string description: Versão do arquivo release: type: boolean description: Se a cópia de trabalho deve ser liberada após o commit fileName: type: string description: O nome efetivo do arquivo defaultStyle: type: string description: Tamanho default da imagem (substitui o arquivo original): 32×32#, 50×50 onde o indica que a proporção de tela será mantida styles: type: array items: type: string description: Tamanhos de imagens que deverão ser criadas: 32×32#, 50×50 onde o indica que a proporção de tela será mantida extractMetadata: type: boolean description: Retornar o metadata do arquivo de forma síncrona wmsxCommitFileOutput: description: Registro de saída do arquivo salvo no serviço de armazenamento type: object required: – targetObject – location properties: targetObject: type: string description: Identificador único do arquivo location: type: object allOf: – #/definitions/wmsxLocation description: Localização do arquivo name: type: string description: Nome do arquivo size: type: integer format: int64 description: Tamanho do arquivo type: type: string allOf: – #/definitions/wmsxFileType description: Tipo do arquivo type: string description: Título contentType: type: string description: Tipo de conteúdo (Mime type) thumbnailGenerationError: type: string description: Thumbnail generation error metadataExtractionError: type: string description: Metadata extraction error wmsxDeleteFileInput: description: Dados para excluir o arquivo. type: object required: – targetObject – fileName – failIfNotExists properties: targetObject: type: string description: Identificador único do arquivo. fileName: type: string description: O nome efetivo do arquivo. styles: type: array items: type: string description: Utilizado para apagar miniaturas de imagens. Ex: 32×32, 50×50. Indica qual a proporção da imagem que deve ser apagada. failIfNotExists: type: boolean description: Especifica se esta ação deve falhar se o arquivo fornecido não existir 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status 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