Control (control)

2.0info: 1.0.1 Control description: BI Control x-senior-domain: BI x-senior-domain-path: bi x-senior-service-path: control 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/bisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /control/queries/getAvaliableTenants: post: description: Retorna os tenants disponiveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/autoCompleteRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/stringListResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os tenants disponiveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Página in: query type: integer format: int64 – name: size description: Máximo de registros in: query type: integer format: int64 – name: orderBy description: Forma de ordenação in: query type: string – name: filter description: Filtro de busca in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/stringListResult 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/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 /control/queries/exportTenant: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/queries/exportPreset: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/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 /control/actions/prepare: post: description: Prepara o tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: overridePresets: type: boolean description: Sobrescrever pré-configurtações existentes default: false responses: 200: description: Ok schema: type: object required: – configuredPresets properties: configuredPresets: type: integer format: int64 description: Pré-configurações manipuladas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/loadTenants: post: description: Carrega os tenants já definidos nos serviços auxiliares tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – overrideTenants properties: overrideTenants: type: boolean description: Sobrescrever os dados existentes responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/validateExtractionExecutionTime: post: description: Verifica se o horário de execução da extração é permitido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId properties: tenantId: type: string maxLength: 255 description: ID tenant executionTime: type: string format: date-time description: Horário de execução timezoneOffset: type: integer format: int64 description: Fuso horário minimum: -12 maximum: 14 responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/validateExtractionExecutionPeriod: post: description: Verifica se a período da extração é permitido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId – datePeriod – scheduled properties: tenantId: type: string maxLength: 255 description: ID tenant datePeriod: type: object allOf: – #/definitions/datePeriod description: Período de datas scheduled: type: boolean description: Agendado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/validateDailyRunningsCount: post: description: Verifica se a período da extração é permitido tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId – name – system – executionsOfTheDay properties: tenantId: type: string maxLength: 255 description: ID tenant name: type: string maxLength: 255 description: Nome do data mart system: type: boolean description: Data mart nativo executionsOfTheDay: type: integer format: int64 description: Execuções no dia minimum: 0 responses: 200: description: Ok schema: type: object required: – maxDailyExecutionsWhenDeploying – maxDailyExecutions properties: maxDailyExecutionsWhenDeploying: type: integer format: int64 description: Máximo de execução quando em implantação minimum: -1 maxDailyExecutions: type: integer format: int64 description: Máximo de execução quando não em implantação minimum: -1 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/isDeploping: post: description: Tenant está marcado como em implantação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId properties: tenantId: type: string maxLength: 255 description: ID tenant deployStartDate: type: string format: date description: Data de início da implantação responses: 200: description: Ok schema: type: object required: – validationRequired – deploing properties: validationRequired: type: boolean description: Validações são necessárias deploing: type: boolean description: Em implantação deploymentEndDate: type: string format: date description: Data de fim da implantação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/isDatamartAvaliable: post: description: Verifica se o data mart fornecido pode ser utilizado pelo tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId – name – system properties: tenantId: type: string maxLength: 255 description: ID tenant name: type: string maxLength: 255 description: Nome do data mart system: type: boolean description: Data mart nativo responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado avaliable: type: array items: type: string description: Disponíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/applyPreset: post: description: Aplicar preset na definição de um tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string maxLength: 255 description: Tenant tenantId: type: string maxLength: 255 description: ID tenant presetId: type: string maxLength: 255 description: ID preset visualizationKind: type: string allOf: – #/definitions/visualizationKind description: Tipo de visualização responses: 200: description: Ok schema: type: object required: – newProperties – updatedProperties properties: newProperties: type: integer format: int64 description: Novas configurações updatedProperties: type: integer format: int64 description: Configurações atualizadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/enableDisableTenant: post: description: Habilitar/desabilitar tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId – enabled properties: tenantId: type: string maxLength: 255 description: ID tenant enabled: type: boolean description: Habilitar/desabilitar responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Habilitado/desabilitado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/increaseDeploymentTime: post: description: Habilitar/desabilitar tenant tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId properties: tenantId: type: string maxLength: 255 description: ID tenant days: type: integer format: int64 description: Número de dias default: 7 responses: 200: description: Ok schema: type: object required: – deploymentLenientDate properties: deploymentLenientDate: type: string format: date description: Data de leniência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/importTenant: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/actions/importPreset: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenant responses: 200: description: The created resource schema: #/definitions/tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenant responses: 200: description: The created resource schema: #/definitions/tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tenant responses: 200: description: Ok schema: #/definitions/tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tenant responses: 200: description: Ok schema: #/definitions/tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenant responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/extractionTime: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/extractionTime responses: 200: description: The created resource schema: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/extractionTime responses: 200: description: The created resource schema: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/extractionTime/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/extractionTime responses: 200: description: Ok schema: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/extractionTime responses: 200: description: Ok schema: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant/{parentId}/extractionTimes: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/extractionTime responses: 200: description: The created resources schema: type: array items: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/extractionTime responses: 200: description: The created resources schema: type: array items: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant/{parentId}/extractionTimes/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/extractionTime responses: 200: description: Ok schema: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/extractionTime responses: 200: description: Ok schema: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/extractionTime 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/extractionTime/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/extractionTime responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/visualization: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visualization responses: 200: description: The created resource schema: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visualization responses: 200: description: The created resource schema: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/visualization/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visualization responses: 200: description: Ok schema: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visualization responses: 200: description: Ok schema: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant/{parentId}/visualizations: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visualization responses: 200: description: The created resources schema: type: array items: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visualization responses: 200: description: The created resources schema: type: array items: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant/{parentId}/visualizations/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visualization responses: 200: description: Ok schema: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visualization responses: 200: description: Ok schema: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visualization 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/visualization/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visualization responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenantProperty: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenantProperty responses: 200: description: The created resource schema: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenantProperty responses: 200: description: The created resource schema: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenantProperty/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tenantProperty responses: 200: description: Ok schema: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tenantProperty responses: 200: description: Ok schema: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant/{parentId}/properties: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/tenantProperty responses: 200: description: The created resources schema: type: array items: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/tenantProperty responses: 200: description: The created resources schema: type: array items: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenant/{parentId}/properties/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tenantProperty responses: 200: description: Ok schema: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tenantProperty responses: 200: description: Ok schema: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tenantProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/tenantProperty/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenantProperty responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/preset: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preset responses: 200: description: The created resource schema: #/definitions/preset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/preset responses: 200: description: The created resource schema: #/definitions/preset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/preset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/preset/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preset responses: 200: description: Ok schema: #/definitions/preset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/preset responses: 200: description: Ok schema: #/definitions/preset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/preset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/preset/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/preset responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/presetProperty: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/presetProperty responses: 200: description: The created resource schema: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/presetProperty responses: 200: description: The created resource schema: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/presetProperty/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/presetProperty responses: 200: description: Ok schema: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/presetProperty responses: 200: description: Ok schema: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/preset/{parentId}/presetProperties: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/presetProperty responses: 200: description: The created resources schema: type: array items: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/presetProperty responses: 200: description: The created resources schema: type: array items: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/preset/{parentId}/presetProperties/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/presetProperty responses: 200: description: Ok schema: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/presetProperty responses: 200: description: Ok schema: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/presetProperty 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /control/entities/presetProperty/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/presetProperty responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: visualizationKind: description: Forma de visualização de BI type: string enum: – NONE – MSTR – QS – CamandaDeGestao visualizationSite: description: Local de hospedagem da visualização de BI type: string enum: – NONE – AWS – OnPremises – ThirdParty visualizationAuthentication: description: Forma de autenticação da visualização de BI type: string enum: – NONE – Platform – ThirdParty fieldKind: description: Tipo de valor type: string enum: – UUID – String – Boolean – Integer – Double – Date – DateTime etlKind: description: Tipo de etl type: string enum: – NONE – MIGRATION – G5 – G7 extractionTimeBehavior: description: Comportamento de horário de extração type: string enum: – DENY – ALLOW extractionTimeDay: description: Dias em que deve ser aplicada type: string enum: – ALL – WEEKDAYS – WEEKENDS 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR datePeriod: description: Período de datas type: object required: – startDate – endDate properties: startDate: type: string format: date description: Data de incial do período endDate: type: string format: date description: Data de final do período autoCompleteRequest: description: Dados para requisitar dados por autocomlete type: object properties: offset: type: integer format: int64 description: Página size: type: integer format: int64 description: Máximo de registros orderBy: type: string description: Forma de ordenação filter: type: string description: Filtro de busca stringListResult: description: Resultado da lista type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/stringResult minimum: 1 description: Conteúdo stringResult: description: Resultado chave X valor type: object required: – name – value properties: name: type: string description: Nome value: type: string description: Valor tenant: description: Tenant type: object required: – tenantId – enabled – etlKind – deploymentStartDate – deploymentEndDate – timezoneOffset properties: id: type: string format: uuid description: PK tenantId: type: string maxLength: 255 description: ID tenant enabled: type: boolean description: Habilitado etlKind: type: string allOf: – #/definitions/etlKind description: Tipo de ETL deploymentStartDate: type: string format: date description: Data de início da implantação deploymentEndDate: type: string format: date description: Data término da implantação deploymentLenientDate: type: string format: date description: Data de leniência visualizations: type: array items: type: object allOf: – #/definitions/visualization description: Visualizações properties: type: array items: type: object allOf: – #/definitions/tenantProperty description: Propriedades extractionTimes: type: array items: type: object allOf: – #/definitions/extractionTime description: Períodos de extração timezoneOffset: type: integer format: int64 description: Fuso horário minimum: -12 maximum: 14 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. extractionTime: description: Horário de extração type: object required: – startTime – endTime – timezoneOffset – behavior – extractionTimeDay properties: id: type: string format: uuid description: PK tenant: type: object allOf: – #/definitions/tenant description: Tenant startTime: type: string description: Horário de início endTime: type: string description: Horário de término timezoneOffset: type: integer format: int64 description: Timezone behavior: type: string allOf: – #/definitions/extractionTimeBehavior description: Comportamento extractionTimeDay: type: string allOf: – #/definitions/extractionTimeDay description: Dias em que deve ser aplicada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. visualization: description: Visualização dos dados type: object required: – enabled – visualizationKind – visualizationSite – visualizationAuthentication properties: id: type: string format: uuid description: PK tenant: type: object allOf: – #/definitions/tenant description: Tenant enabled: type: boolean description: Visualização ativa visualizationKind: type: string allOf: – #/definitions/visualizationKind description: Ferramenta visualizationSite: type: string allOf: – #/definitions/visualizationSite description: Local de hospedagem da visualização de BI visualizationAuthentication: type: string allOf: – #/definitions/visualizationAuthentication description: Forma de autenticação da visualização de BI createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. tenantProperty: description: Visualização dos dados type: object required: – fieldKind – service – key – description properties: id: type: string format: uuid description: PK tenant: type: object allOf: – #/definitions/tenant description: Tenant presetProperty: type: object allOf: – #/definitions/presetProperty description: Valor original fieldKind: type: string allOf: – #/definitions/fieldKind description: Tipo service: type: string maxLength: 255 description: Serviço key: type: string maxLength: 255 description: Chave value: type: string maxLength: 255 description: Valor description: type: string maxLength: 1000 description: Descrição x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. translations: type: object properties: locale: type: object properties: description: type: string maxLength: 1000 example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. preset: description: Pré-Configuração type: object required: – visualizationKind – name properties: id: type: string format: uuid description: PK visualizationKind: type: string allOf: – #/definitions/visualizationKind description: Ferramenta name: type: string maxLength: 255 description: Nome description: type: string maxLength: 1000 description: Descrição x-i18n: true presetProperties: type: array items: type: object allOf: – #/definitions/presetProperty description: Propriedades createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. translations: type: object properties: locale: type: object properties: description: type: string maxLength: 1000 example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. presetProperty: description: Visualização dos dados type: object required: – fieldKind – service – key – description properties: id: type: string format: uuid description: PK preset: type: object allOf: – #/definitions/preset description: Pré-Configuração fieldKind: type: string allOf: – #/definitions/fieldKind description: Tipo service: type: string maxLength: 255 description: Serviço key: type: string maxLength: 255 description: Chave value: type: string maxLength: 255 description: Valor description: type: string maxLength: 1000 description: Descrição x-i18n: true tenantProperties: type: array items: type: object allOf: – #/definitions/tenantProperty description: Propriedades em uso nos tenants readOnly: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: type: integer format: int64 description: Entity version for optimistic concurrency control. translations: type: object properties: locale: type: object properties: description: type: string maxLength: 1000 example: pt-BR: description: Exemplo de texto usando locale pt-BR. en-US: description: Text example using en-US locale. 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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