2.0info: 1.3.2 backend x-senior-domain: ds x-senior-domain-path: ds x-senior-service-path: backend contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/dssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /backend/queries/dynamicDataTable: post: description: Inteface para pegar os Dados do Grid tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataTableModel properties: dataTableModel: type: object allOf: #/definitions/dataTableModel description: responses: 200: description: Ok schema: type: object required: – value – serviceError properties: value: type: object allOf: #/definitions/datatableout description: serviceError: type: object allOf: #/definitions/errorDataTableQuery description: default: description: Error response schema: #/definitions/genericError /backend/queries/dynamicDataTableDefinition: post: description: Inteface para pegar a definição do GRID tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataTableModel properties: dataTableModel: type: object allOf: #/definitions/dataTableModel description: responses: 200: description: Ok schema: type: object required: – value – serviceError properties: value: type: object allOf: #/definitions/dataTableModel description: serviceError: type: object allOf: #/definitions/errorDataTableQuery description: default: description: Error response schema: #/definitions/genericError /backend/queries/dynamicSearchField: post: description: Inteface para consulta campos DynamicSearchField tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – view – descrField – filter properties: view: type: string description: descrField: type: string description: filter: type: string description: queryFilter: type: array items: type: object allOf: #/definitions/dataTableFilter description: dynamicQueryFilters: type: array items: type: object allOf: #/definitions/dynamicSearchGridFilter description: responses: 200: description: Ok schema: type: object required: – value – serviceError properties: value: type: string description: serviceError: type: object allOf: #/definitions/errorDataTableQuery description: default: description: Error response schema: #/definitions/genericError /backend/queries/dynamicCountDataTable: post: description: Inteface para quantidade total de dados no grid Dados do Grid tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataTableModel properties: dataTableModel: type: object allOf: #/definitions/dataTableModel description: responses: 200: description: Ok schema: type: object required: – value – serviceError properties: value: type: integer format: int64 description: serviceError: type: object allOf: #/definitions/errorDataTableQuery description: default: description: Error response schema: #/definitions/genericError /backend/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/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 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/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: #/definitions/checkData minimum: 1 description: Verificações para assegurar o status default: description: Error response schema: #/definitions/genericError /backend/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: 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: default: description: Error response schema: #/definitions/genericError /backend/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 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 default: description: Error response schema: #/definitions/genericError definitions: serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN dataTableColumnType: description: type: string enum: – Integer – Decimal – String – Date – Boolean – YesNo – Enum comparisonType: description: type: string enum: – Equals – Different – LessThan – GreaterThen – Like – Between – In – NotIn 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/serviceHealthStatus description: Status do healthcheck dataTableModel: description: type: object required: – consulta – previousPage – page – length properties: consulta: type: string description: order: type: array items: type: object allOf: #/definitions/order description: previousPage: type: integer format: int64 description: page: type: integer format: int64 description: length: type: integer format: int64 description: exporting: type: boolean description: columnsModel: type: array items: type: object allOf: #/definitions/dataTableColumnData description: queryFilter: type: array items: type: object allOf: #/definitions/dataTableFilter description: dynamicQueryFilter: type: array items: type: object allOf: #/definitions/dataTableFilter description: predefinedFilters: type: array items: type: object allOf: #/definitions/predefinedFilters description: dynamicSearchGridFilters: type: array items: type: object allOf: #/definitions/dynamicSearchGridFilter description: dynamicSearchGridFilter: description: type: object required: – filterId – queryFilter properties: filterId: type: string description: queryFilter: type: object allOf: #/definitions/dataTableFilter description: predefinedFilterQueryFilter: description: type: object required: – title – queryFilter – isFiltering properties: type: string description: queryFilter: type: object allOf: #/definitions/dataTableFilter description: isFiltering: type: boolean description: predefinedFilters: description: type: object required: – title – columnType – multiSelection – predefinedFiltersQueryFilters properties: type: string description: columnType: type: string allOf: – #/definitions/dataTableColumnType description: multiSelection: type: boolean description: predefinedFiltersQueryFilters: type: array items: type: object allOf: #/definitions/predefinedFilterQueryFilter minimum: 1 description: dataTableColumnData: description: type: object required: – columnName – columnType properties: columnName: type: string description: columnType: type: string allOf: – #/definitions/dataTableColumnType description: enumValues: type: array items: type: string format: byte description: downloadData: description: type: object required: – domainName – serviceName – targetObjectId – version – token – fileName – areaSecret – location properties: domainName: type: string description: serviceName: type: string description: targetObjectId: type: string description: type: string description: token: type: string description: fileName: type: string description: areaSecret: type: string description: location: type: object allOf: #/definitions/downloadLocation description: downloadLocation: description: type: object required: – protocol – uri properties: protocol: type: string description: uri: type: string description: dataTableFilter: description: type: object required: – columnName – comparisonType – value – columnType properties: columnName: type: string description: comparisonType: type: string allOf: – #/definitions/comparisonType description: value: type: string format: byte description: columnType: type: string allOf: – #/definitions/dataTableColumnType description: datatableout: description: type: object required: – previousPage – currentPage – data – hasNextPage properties: previousPage: type: integer format: int64 description: currentPage: type: integer format: int64 description: data: type: string format: byte description: hasNextPage: type: boolean description: column: description: type: object required: – data – name – searchable – orderable properties: data: type: string description: name: type: string description: searchable: type: boolean description: orderable: type: boolean description: search: type: object allOf: #/definitions/search description: search: description: type: object required: – value – regex properties: value: type: string description: regex: type: boolean description: order: description: type: object required: – columnName – dir properties: columnName: type: string description: dir: type: string description: errorDataTableQuery: description: type: object required: – errorMsg – stackTrace properties: errorMsg: type: string description: stackTrace: type: string description: simpleEntity: description: type: object properties: id: type: integer format: int64 description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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