Configurações (configuration)

Configurações (configuration)

27 views 17/03/2021 07/05/2021 integrador 0

2.0info: 7.9.0 Configurações description: Serviço de configurações centralizadas da plataforma Senior X x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: configuration contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /platform/configuration/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /actions/updateCustomProperty: post: description: Atualiza uma propriedade customizada. Atualiza apenas do tenant autenticado e no domínio platform, serviço __custom__ ### Resources: – res://senior.com.br/platform/configuration_custom x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/customPropertyValue responses: 200: description: Ok 404: description: Propriedade não encontrada 403: description: Permissão negada 401: description: O token de acesso é inválido ou está expirado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/createCustomProperty: post: description: Insere uma propriedade customizada. Insere apenas do tenant autenticado e no domínio platform, serviço __custom__ ### Resources: – res://senior.com.br/platform/configuration_custom x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/customPropertyValue responses: 200: description: Ok 409: description: Propriedade já existe 403: description: Permissão negada 401: description: O token de acesso é inválido ou está expirado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /queries/getCustomProperty: post: description: Obtém uma propriedade customizada. Obtém apenas do tenant autenticado e no domínio platform, serviço __custom__ ### Resources: – res://senior.com.br/platform/configuration_custom x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – propertyKey properties: propertyKey: type: string description: Nome da propriedade que deve ser retornada responses: 200: description: Ok schema: type: object required: – propertyKey properties: propertyKey: type: string description: Nome da propriedade type: #/definitions/propertyType propertyValue: type: string description: Valor da propriedade hashTags: type: string description: HashTags para a tela de configuração label: type: string description: Descrição da propriedade na tela de configuração propertyLevel: #/definitions/propertyLevel 404: description: Propriedade não encontrada 403: description: Permissão negada 401: description: O token de acesso é inválido ou está expirado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /actions/deleteCustomProperty: post: description: Exclui uma propriedade customizada. Exclui apenas do tenant autenticado e no domínio platform, serviço __custom__ ### Resources: – res://senior.com.br/platform/configuration_custom x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – propertyKey properties: propertyKey: type: string description: Nome da propriedade responses: 200: description: Ok 404: description: Propriedade não encontrada 403: description: Permissão negada 401: description: O token de acesso é inválido ou está expirado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: propertyLevel: type: string enum: – INFRA – SYSTEM propertyType: type: string enum: – String – Integer – Long – Double – Boolean – Date – Time – DateTime – Secret customPropertyValue: type: object required: – propertyKey properties: propertyKey: type: string description: Nome da propriedade type: #/definitions/propertyType propertyValue: type: string description: Valor da propriedade hashTags: type: array items: type: string description: HashTags para a tela de configuração label: type: string description: Descrição da propriedade na tela de configuração propertyLevel: #/definitions/propertyLevel 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