erpx

datacenter

4 views 12/03/2021 10/05/2021 integrador 0

2.0info: 1.4.0 datacenter description: ERP senior X serviço de datacenter x-senior-domain: erpx x-senior-domain-path: erpx x-senior-service-path: datacenter 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/erpxsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /datacenter/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 /datacenter/queries/getEntitiesMetadata: post: description: Retrieves the entities metadata registered in the Datalake service tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/recEntityMetadata description: The result list. Can be empty. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retrieves the entities metadata registered in the Datalake service tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: result: type: array items: type: object allOf: – #/definitions/recEntityMetadata description: The result list. Can be empty. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datacenter/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 /datacenter/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 /datacenter/actions/loadEntityData: post: description: Loads asynchronously entities data from the owner domains and services into the datacenter service.\n WARNING: first, all data (you can parameterize a period) in datacenter will be DELETED and after reloaded from owner domains and services. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – recLoadEntityDataParams properties: recLoadEntityDataParams: type: object allOf: – #/definitions/recLoadEntityDataParams description: Parameters to load entity data. responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: The ticket of the request. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /datacenter/events/loadEntityDataRequested: post: description: Internal event x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – recLoadEntityDataParams – ticket properties: recLoadEntityDataParams: type: object allOf: – #/definitions/recLoadEntityDataParams description: Parameters ticket: type: string description: Ticket of this work responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /datacenter/events/loadEntityDataFinished: post: description: Event published when loadEntityData action has finished its work x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – recLoadEntityDataParams – ticket properties: recLoadEntityDataParams: type: object allOf: – #/definitions/recLoadEntityDataParams description: Parameters ticket: type: string description: Ticket of the work responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN 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 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 recLoadEntityDataParams: description: Record for load entity data parameters type: object required: – domainName – serviceName – schemaName – entityNames properties: domainName: type: string description: Owner domain name of the entities, set * for all registered domains serviceName: type: string description: Owner service name of the entities, set * for all registered services schemaName: type: string description: The schema name of the owner domain and service entityNames: type: array items: type: string minimum: 1 description: Entities names. set * for all registered entities of the domain and service above ids: type: array items: type: string description: Specifics identifiers that should be loaded startCreationDate: type: string format: date description: Filter start creation date and time of the entities records endCreationDate: type: string format: date description: Filter end creation date and time of the entities records recEntityMetadata: description: Entity metadata structure type: object required: – domainName – serviceName – entityName – tableName properties: domainName: type: string description: Name of the domain that owns the entity. serviceName: type: string description: Name of the service that owns the entity. entityName: type: string description: Entity name tableName: type: string description: Database table name 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 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