2.0info: 1.11.0 data_platform description: 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: api.senior.com.br /platform/data_platformsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /getProduct: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/product 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError get: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/product 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError /getMasterDatasFields: post: description: Lista os campos do master data que foi selecionado.
*resources*
- res://senior.com.br/platform/data_platform/master_datas
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/masterDataDetailsDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError get: description: Lista os campos do master data que foi selecionado.
*resources*
- res://senior.com.br/platform/data_platform/master_datas
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/masterDataDetailsDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError /listProductLine: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – productLine properties: productLine: #/definitions/productLine 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError get: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – productLine properties: productLine: #/definitions/productLine 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError /listProducts: post: description: Lista todos os produtos que o cliente possui, e que pode contratar.
*resources*
- res://senior.com.br/platform/data_platform/products
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – products properties: products: #/definitions/dataProductDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError get: description: Lista todos os produtos que o cliente possui, e que pode contratar.
*resources*
- res://senior.com.br/platform/data_platform/products
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – products properties: products: #/definitions/dataProductDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError /listSeniorServices: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – productGroupDescription properties: productGroupDescription: type: string description: descrição do produto no ERP pageRequest: #/definitions/pageRequest responses: 200: description: Ok schema: type: object required: – services properties: services: #/definitions/seniorServiceDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError get: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – productGroupDescription properties: productGroupDescription: type: string description: descrição do produto no ERP pageRequest: #/definitions/pageRequest responses: 200: description: Ok schema: type: object required: – services properties: services: #/definitions/seniorServiceDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError /getMasterData: post: description: Lista as informações especificas do master data selecionado.
*resources*
- res://senior.com.br/platform/data_platform/master_datas
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/masterDataDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError get: description: Lista as informações especificas do master data selecionado.
*resources*
- res://senior.com.br/platform/data_platform/master_datas
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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: #/definitions/masterDataDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError /updateStatusProduct: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – 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. 403: description: credenciais válidas mas sem permissão 401: description: Token de autenticação inválido ou expirado 400: description: Parâmetros de inserção inválidos default: description: Error response schema: #/definitions/genericError /getAllProducts: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – products properties: products: #/definitions/productSimplify 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError get: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – products properties: products: #/definitions/productSimplify 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError /updatedDataProduct: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – products properties: products: type: array items: #/definitions/engDataProductDto description: Informações do produto a ser atualizado. responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Produto atualizado. 403: description: credenciais válidas mas sem permissão 401: description: Token de autenticação inválido ou expirado 400: description: Parâmetros de inserção inválidos default: description: Error response schema: #/definitions/genericError /saveProducts: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – products properties: products: #/definitions/product responses: 200: description: Ok schema: type: object required: – products properties: products: #/definitions/product 403: description: credenciais válidas mas sem permissão 401: description: Token de autenticação inválido ou expirado 400: description: Parâmetros de inserção inválidos default: description: Error response schema: #/definitions/genericError /listMasterDatas: post: description: Lista todos os master datas que o cliente possui, e que pode contratar
*resources*
- res://senior.com.br/platform/data_platform/master_datas
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – masterDatas properties: masterDatas: #/definitions/masterDataSummaryDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError get: description: Lista todos os master datas que o cliente possui, e que pode contratar
*resources*
- res://senior.com.br/platform/data_platform/master_datas
x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – masterDatas properties: masterDatas: #/definitions/masterDataSummaryDto 403: description: credenciais válidas mas sem permissão 400: description: Parâmetros de busca inválidos 401: description: Token de autenticação inválido ou expirado default: description: Error response schema: #/definitions/genericError /updatedMasterData: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – masterDatas properties: masterDatas: type: array items: #/definitions/engMasterDataDto 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. 403: description: credenciais válidas mas sem permissão 401: description: Token de autenticação inválido ou expirado 400: description: Parâmetros de inserção inválidos default: description: Error response schema: #/definitions/genericError /linkSeniorServiceToProduct: post: description: x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – productId – seniorService properties: productId: type: string description: seniorService: type: array items: #/definitions/seniorServiceDto description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: Serviço da senior vinculado ao produto. 403: description: credenciais válidas mas sem permissão 401: description: Token de autenticação inválido ou expirado 400: description: Parâmetros de inserção inválidos default: description: Error response schema: #/definitions/genericErrordefinitions: productLine: type: object required: – id – name – code properties: id: type: string description: name: type: string description: Nome da linha do produto. code: type: integer description: Codigo do grupo product: 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: #/definitions/productLine iconUrl: type: string description: Url do ícone do produto. masterDatas: type: array items: #/definitions/masterDataSimplify description: Lista de master data vinculados ao produto. masterDataSimplify: 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. productSimplify: 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. engDataProductDto: type: object required: – id – name properties: id: type: string description: ID do produto da engenharia. name: type: string description: Nome do produto. description: type: string description: Breve descrição do produto. engMasterDataDto: 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: #/definitions/fieldsDto description: Lista de campos. fieldsDto: 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. dataProductDto: type: object required: – id – name – iconUrl – contracted properties: id: type: string description: Identificador do produto. name: type: string description: Nome do produto. productLine: type: string description: Linha do produto. description: type: string 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: 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 description: Data de atiação format: date-time 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: #/definitions/fieldsDto description: Lista de campos. plan: #/definitions/planDto planDto: 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 description: Frequência de execução do plano. masterDataSummaryDto: 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: 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: #/definitions/fieldsDto description: Lista de campos do master data. seniorServiceDto: 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: type: object properties: offset: type: integer description: 0-based page index. size: type: integer description: Page size (max 1000). 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