2.0info: 1.11.0 data_platform x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: data_platform 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/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /data_platform/queries/listProducts: post: description: Lista todos os produtos que o cliente possui, e que pode contratar.\n*resources*\n- res://senior.com.br/platform/data_platform/products\n tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – products properties: products: type: array items: type: object allOf: – #/definitions/dataProductDto minimum: 1 description: Lista de produtos 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError get: description: Lista todos os produtos que o cliente possui, e que pode contratar.\n*resources*\n- res://senior.com.br/platform/data_platform/products\n tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – products properties: products: type: array items: type: object allOf: – #/definitions/dataProductDto minimum: 1 description: Lista de produtos 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/queries/getAllProducts: post: description: tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – products properties: products: type: array items: type: object allOf: – #/definitions/productSimplify minimum: 1 description: Lista de produtos 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – products properties: products: type: array items: type: object allOf: – #/definitions/productSimplify minimum: 1 description: Lista de produtos 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/queries/getProduct: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId properties: productId: type: string description: responses: 200: description: Ok schema: type: object required: – product properties: product: type: object allOf: – #/definitions/product description: produtos 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: productId description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – product properties: product: type: object allOf: – #/definitions/product description: produtos 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/queries/listProductLine: post: description: tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – productLine properties: productLine: type: array items: type: object allOf: – #/definitions/productLine minimum: 1 description: 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – productLine properties: productLine: type: array items: type: object allOf: – #/definitions/productLine minimum: 1 description: 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/queries/listMasterDatas: post: description: Lista todos os master datas que o cliente possui, e que pode contratar\n*resources*\n- res://senior.com.br/platform/data_platform/master_datas\n tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – masterDatas properties: masterDatas: type: array items: type: object allOf: – #/definitions/masterDataSummaryDto minimum: 1 description: Lista de master datas. 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError get: description: Lista todos os master datas que o cliente possui, e que pode contratar\n*resources*\n- res://senior.com.br/platform/data_platform/master_datas\n tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – masterDatas properties: masterDatas: type: array items: type: object allOf: – #/definitions/masterDataSummaryDto minimum: 1 description: Lista de master datas. 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/queries/getMasterData: post: description: Lista as informações especificas do master data selecionado.\n*resources*\n- res://senior.com.br/platform/data_platform/master_datas\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: identificador de busca, titulo do master data. responses: 200: description: Ok schema: type: object required: – masterData properties: masterData: type: object allOf: – #/definitions/masterDataDto description: Master data com as suas informação . 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError get: description: Lista as informações especificas do master data selecionado.\n*resources*\n- res://senior.com.br/platform/data_platform/master_datas\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: identificador de busca, titulo do master data. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – masterData properties: masterData: type: object allOf: – #/definitions/masterDataDto description: Master data com as suas informação . 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/queries/getMasterDatasFields: post: description: Lista os campos do master data que foi selecionado.\n*resources*\n- res://senior.com.br/platform/data_platform/master_datas\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – masterDataId properties: masterDataId: type: string description: identificador de busca, titulo do master data. responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: object allOf: – #/definitions/masterDataDetailsDto description: 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError get: description: Lista os campos do master data que foi selecionado.\n*resources*\n- res://senior.com.br/platform/data_platform/master_datas\n tags: – Queries x-senior-visibility: PUBLIC parameters: – name: masterDataId description: identificador de busca, titulo do master data. in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fields properties: fields: type: object allOf: – #/definitions/masterDataDetailsDto description: 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/queries/listSeniorServices: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productGroupDescription properties: productGroupDescription: type: string description: descrição do produto no ERP pageRequest: type: object allOf: – #/definitions/pageRequest description: Parâmetros de paginação responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: object allOf: – #/definitions/seniorServiceDto minimum: 1 description: Lista de serviços da senior. 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/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 /data_platform/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 /data_platform/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 /data_platform/actions/saveProducts: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – products properties: products: type: object allOf: – #/definitions/product description: Lista de produtos responses: 200: description: Ok schema: type: object required: – products properties: products: type: object allOf: – #/definitions/product description: Lista de produtos 400: description: Parâmetros de inserção inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/actions/updateStatusProduct: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – status – productId properties: status: type: boolean description: productId: type: string description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Product status updated. 400: description: Parâmetros de inserção inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/actions/updatedDataProduct: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – products properties: products: type: array items: type: object allOf: – #/definitions/engDataProductDto minimum: 1 description: Informações do produto a ser atualizado. responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Produto atualizado. 400: description: Parâmetros de inserção inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/actions/updatedMasterData: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – masterDatas properties: masterDatas: type: array items: type: object allOf: – #/definitions/engMasterDataDto minimum: 1 description: Informações do master data a ser atualizado. responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Master data atualizado. 400: description: Parâmetros de inserção inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericError /data_platform/actions/linkSeniorServiceToProduct: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – productId – seniorService properties: productId: type: string description: seniorService: type: array items: type: object allOf: – #/definitions/seniorServiceDto minimum: 1 description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Serviço da senior vinculado ao produto. 400: description: Parâmetros de inserção inválidos 401: description: Token de autenticação inválido ou expirado 403: description: credenciais válidas mas sem permissão default: description: Error response schema: #/definitions/genericErrordefinitions: frequency: type: string enum: – HOURLY – DAILY – WEEKLY – MONTHLY – ANNUAL description: enum que vai conter a periodicidade de execução do master data.: * `HOURLY` – Hourly * `DAILY` – Daily * `WEEKLY` – Weekly * `MONTHLY` – Monthly * `ANNUAL` – Annual 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 healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim productLine: description: type: object required: – id – name – code properties: id: type: string description: name: type: string description: Nome da linha do produto. code: type: integer format: int64 description: Codigo do grupo product: description: type: object required: – id – name – description – status – productLine – iconUrl properties: id: type: string description: Identificador do produto. name: type: string description: Nome do produto. description: type: string description: Breve descrição do produto. status: type: boolean description: Status do produto, se está ativo ou inativo. productLine: type: object allOf: – #/definitions/productLine description: Linha do produto. iconUrl: type: string description: Url do ícone do produto. masterDatas: type: array items: type: object allOf: – #/definitions/masterDataSimplify description: Lista de master data vinculados ao produto. productSimplify: description: type: object required: – id – name – description – status – productLine properties: id: type: string description: Identificador do produto. name: type: string description: Nome do produto. description: type: string description: Breve descrição do produto. status: type: boolean description: Status do produto, se está ativo ou inativo. productLine: type: string description: Linha do produto. masterDataSimplify: description: type: object required: – id – name – tableName – status properties: id: type: string description: name: type: string description: Titulo apresentado para este master data. tableName: type: string description: Campo referente a tabela que deve ser utilizada dentro das consultas de master data description: type: string description: Breve descrição do master data. status: type: boolean description: Se está ativo ou inativo. engDataProductDto: description: Entidade transacional que vai representar as informações na persistencia de dados vindo da engenharia. type: object required: – id – name properties: id: type: string description: ID do produto da engenharia. name: type: string maxLength: 120 description: Nome do produto. description: type: string maxLength: 200 description: Breve descrição do produto. engMasterDataDto: description: type: object required: – productId – name – tableName – fields properties: id: type: string description: Identificador do master data. productId: type: string description: Identificador do produto relacionado a este master data. name: type: string description: Titulo apresentado para este master data. tableName: type: string description: Campo referente a tabela que deve ser utilizada dentro das consultas de master data fields: type: array items: type: object allOf: – #/definitions/fieldsDto minimum: 1 description: Lista de campos. dataProductDto: description: Entidade transacional que vai representar as informações nas telas de produto na jornada do cliente. type: object required: – id – name – iconUrl – contracted properties: id: type: string description: Identificador do produto. name: type: string maxLength: 255 description: Nome do produto. productLine: type: string maxLength: 100 description: Linha do produto. description: type: string maxLength: 200 description: Breve descrição do produto. iconUrl: type: string description: Url do ícone do produto. contracted: type: boolean description: Se o produto está contratado ou não. masterDataDto: description: Entidade transacional que vai representar as informações nas telas de master data na jornada do cliente. type: object required: – id – name – tableName – fields properties: id: type: string description: name: type: string description: Titulo apresentado para este master data. tableName: type: string description: Campo referente a tabela que deve ser utilizada dentro das consultas de master data description: type: string description: Breve descrição do master data. activationData: type: string format: date-time description: Data de atiação status: type: boolean description: Se está ativo ou inativo. productName: type: string description: Titulo do produto vincula. productLine: type: string description: subtitulo que o produto vinculado tem. fields: type: array items: type: object allOf: – #/definitions/fieldsDto minimum: 1 description: Lista de campos. plan: type: object allOf: – #/definitions/planDto description: Plano contratado para o master data. masterDataSummaryDto: description: type: object required: – id – name – tableName – status – productName – productLine – iconUrl properties: id: type: string description: name: type: string description: Titulo apresentado para este master data. tableName: type: string description: Campo referente a tabela que deve ser utilizada dentro das consultas de master data description: type: string description: Breve descrição do master data. status: type: boolean description: Se está ativo ou inativo. productName: type: string description: Titulo do produto vincula. productLine: type: string description: subtitulo que o produto vinculado tem. iconUrl: type: string description: Url do ícone do produto. masterDataDetailsDto: description: type: object required: – description – tableName – fields properties: description: type: string description: Descrição do master data. tableName: type: string description: Nome da tabela que o master data utiliza. fields: type: array items: type: object allOf: – #/definitions/fieldsDto minimum: 1 description: Lista de campos do master data. fieldsDto: description: Para representar os dados em tela na consulta dos campos do master data. type: object required: – name – type – description properties: id: type: string description: name: type: string description: Nome do campo. type: type: string description: Tipagem do campo. description: type: string description: Breve descrição que o campo tem. tagsDto: description: Entidade transacional das tags que um campo tem. Para as telas de mais informação\ndo master data. type: object required: – name properties: id: type: string description: name: type: string description: Nome apresentado na tag. planDto: description: type: object required: – id – name – frequency properties: id: type: string description: name: type: string description: Nome do plano. Ex: Diamond description: type: string description: Breve descrição do plano. frequency: type: integer format: int64 description: Frequência de execução do plano. seniorServiceDto: description: type: object required: – id – erpId – erpGroupId – name – description properties: id: type: string description: Id de identificação do serviço erpId: type: string description: id do produto no ERP erpGroupId: type: string description: id do grupo que o produto pertence no ERP name: type: string description: Nome do produto description: type: string description: Descrição do produto pageRequest: description: Pagination request (0-based page index). type: object properties: offset: type: integer format: int64 description: 0-based page index. size: type: integer format: int64 description: Page size (max 1000). 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 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