2.0info: 1.1.0 MicroStrategy description: Gerenciamento e controle do MicroStrategy x-senior-domain: BI x-senior-domain-path: bi x-senior-service-path: microstrategy contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/bisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /microstrategy/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /microstrategy/queries/exportMstrConnection: 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: default: description: Error response schema: #/definitions/genericError /microstrategy/queries/exportMstrPackage: 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: default: description: Error response schema: #/definitions/genericError /microstrategy/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: default: description: Error response schema: #/definitions/genericError /microstrategy/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /microstrategy/actions/applyPackage: post: description: Teste de conexão com banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantId properties: tenantId: type: string description: ID tenant type: string description: Versão da URL wait: type: boolean description: Aguardar execução default: false responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso message: type: string description: Mensagem versions: type: array items: type: string description: Versão da URL default: description: Error response schema: #/definitions/genericError /microstrategy/actions/testDBConnection: post: description: Teste de conexão com banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – connection properties: connection: type: object allOf: – #/definitions/dbConnectionDTO description: Conexão responses: 200: description: Ok schema: type: object required: – success – message – url properties: success: type: boolean description: Sucesso message: type: string description: Mensagem url: type: string description: URL utilizada no teste default: description: Error response schema: #/definitions/genericError /microstrategy/actions/testMSTRConnection: post: description: Teste de conexão com MicroStrategy tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – mstrConnection properties: mstrConnection: type: object allOf: – #/definitions/mstrConnection description: Conexão responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Sucesso message: type: string description: Mensagem default: description: Error response schema: #/definitions/genericError /microstrategy/actions/importPackagePrepare: post: description: Preparar importação de datamart tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – packageVersion properties: packageVersion: type: string maxLength: 255 description: Versão do pacote packageChecksum: type: string maxLength: 64 description: Checksum do pacote responses: 200: description: Ok schema: type: object required: – url – version properties: url: type: string description: URL para upload do arquivo type: string description: Versão da URL default: description: Error response schema: #/definitions/genericError /microstrategy/actions/importPackage: post: description: Executar importação de datamart tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – packageVersion – version properties: packageVersion: type: string maxLength: 255 description: Versão do pacote type: string description: Versão da URL responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /microstrategy/actions/importMstrConnection: 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: default: description: Error response schema: #/definitions/genericError /microstrategy/actions/importMstrPackage: 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: default: description: Error response schema: #/definitions/genericError /microstrategy/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: default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrConnection: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mstrConnection responses: 200: description: The created resource schema: #/definitions/mstrConnection 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/mstrConnection responses: 200: description: The created resource schema: #/definitions/mstrConnection 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/mstrConnection default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrConnection/{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/mstrConnection responses: 200: description: Ok schema: #/definitions/mstrConnection 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/mstrConnection responses: 200: description: Ok schema: #/definitions/mstrConnection 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/mstrConnection 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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrConnection/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mstrConnection responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrExecutable: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mstrExecutable responses: 200: description: The created resource schema: #/definitions/mstrExecutable 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/mstrExecutable responses: 200: description: The created resource schema: #/definitions/mstrExecutable 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/mstrExecutable default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrExecutable/{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/mstrExecutable responses: 200: description: Ok schema: #/definitions/mstrExecutable 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/mstrExecutable responses: 200: description: Ok schema: #/definitions/mstrExecutable 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/mstrExecutable 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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrConnection/{parentId}/mstrExecutable: 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/mstrExecutable responses: 200: description: The created resources schema: type: array items: #/definitions/mstrExecutable 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/mstrExecutable responses: 200: description: The created resources schema: type: array items: #/definitions/mstrExecutable 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/mstrExecutable default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrConnection/{parentId}/mstrExecutable/{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/mstrExecutable responses: 200: description: Ok schema: #/definitions/mstrExecutable 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/mstrExecutable responses: 200: description: Ok schema: #/definitions/mstrExecutable 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/mstrExecutable 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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrExecutable/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mstrExecutable responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrPackage: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mstrPackage responses: 200: description: The created resource schema: #/definitions/mstrPackage 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/mstrPackage responses: 200: description: The created resource schema: #/definitions/mstrPackage 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/mstrPackage default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrPackage/{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/mstrPackage responses: 200: description: Ok schema: #/definitions/mstrPackage 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/mstrPackage responses: 200: description: Ok schema: #/definitions/mstrPackage 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/mstrPackage 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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/mstrPackage/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mstrPackage responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /microstrategy/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 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 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 default: description: Error response schema: #/definitions/genericError /microstrategy/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 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 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 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 default: description: Error response schema: #/definitions/genericError /microstrategy/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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/tenantPackage: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenantPackage responses: 200: description: The created resource schema: #/definitions/tenantPackage 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/tenantPackage responses: 200: description: The created resource schema: #/definitions/tenantPackage 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/tenantPackage default: description: Error response schema: #/definitions/genericError /microstrategy/entities/tenantPackage/{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/tenantPackage responses: 200: description: Ok schema: #/definitions/tenantPackage 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/tenantPackage responses: 200: description: Ok schema: #/definitions/tenantPackage 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/tenantPackage 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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/tenant/{parentId}/tenantPackages: 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/tenantPackage responses: 200: description: The created resources schema: type: array items: #/definitions/tenantPackage 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/tenantPackage responses: 200: description: The created resources schema: type: array items: #/definitions/tenantPackage 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/tenantPackage default: description: Error response schema: #/definitions/genericError /microstrategy/entities/tenant/{parentId}/tenantPackages/{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/tenantPackage responses: 200: description: Ok schema: #/definitions/tenantPackage 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/tenantPackage responses: 200: description: Ok schema: #/definitions/tenantPackage 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/tenantPackage 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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/tenantPackage/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenantPackage responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /microstrategy/entities/dbConnection: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dbConnection responses: 200: description: The created resource schema: #/definitions/dbConnection 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/dbConnection responses: 200: description: The created resource schema: #/definitions/dbConnection 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/dbConnection default: description: Error response schema: #/definitions/genericError /microstrategy/entities/dbConnection/{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/dbConnection responses: 200: description: Ok schema: #/definitions/dbConnection 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/dbConnection responses: 200: description: Ok schema: #/definitions/dbConnection 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/dbConnection 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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/tenant/{parentId}/dbConnection: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/dbConnection responses: 200: description: The created resource schema: #/definitions/dbConnection 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: object allOf: – #/definitions/dbConnection responses: 200: description: The created resource schema: #/definitions/dbConnection 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/dbConnection default: description: Error response schema: #/definitions/genericError /microstrategy/entities/tenant/{parentId}/dbConnection/{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/dbConnection responses: 200: description: Ok schema: #/definitions/dbConnection 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/dbConnection responses: 200: description: Ok schema: #/definitions/dbConnection 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/dbConnection 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 default: description: Error response schema: #/definitions/genericError /microstrategy/entities/dbConnection/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dbConnection responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: dataBaseKind: description: Tipo de execução da atualização type: string enum: – SqlServer – PostgreSQL – Oracle soKind: description: Tipo de sistema operacional type: string enum: – Windows – Linux 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 dbConnectionDTO: description: Conexão com banco de dados type: object required: – dataBaseKind – server – port – dataBase – username – password properties: enabled: type: boolean description: Ativa default: true remote: type: boolean description: Remota default: false dataBaseKind: type: string allOf: – #/definitions/dataBaseKind description: Tipo de banco de dados server: type: string maxLength: 255 description: Servidor port: type: integer format: int64 description: Porta minimum: 1 dataBase: type: string maxLength: 255 description: Nome da base de dados ou da instância username: type: string maxLength: 255 description: Usuário password: type: string maxLength: 255 description: Senha secret: true connectionUrl: type: string maxLength: 255 description: URL de conexão clusterOrIntegrated: type: boolean description: Cluster ou integrada default: false mstrConnection: description: Conexão com MicroStrategy type: object required: – soKind – name – server – port – username – projectName – ldap properties: id: type: string format: uuid description: PK enabled: type: boolean description: Conexão ativa default: false soKind: type: string allOf: – #/definitions/soKind description: SO name: type: string maxLength: 255 description: Nome da conexão description: type: string maxLength: 1000 description: Descrição da conexão server: type: string maxLength: 255 description: Servidor port: type: integer format: int64 description: Porta minimum: 1 username: type: string maxLength: 255 description: Usuário password: type: string maxLength: 255 description: Senha secret: true projectName: type: string maxLength: 255 description: Nome do projeto ldap: type: boolean description: LDAP / SGU / G7 mstrExecutable: type: array items: type: object allOf: – #/definitions/mstrExecutable description: Executaveis 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. mstrExecutable: description: Executavel MicroStrategy type: object required: – name – path – sudo properties: id: type: string format: uuid description: PK mstrConnection: type: object allOf: – #/definitions/mstrConnection description: MicroStaretgy enabled: type: boolean description: Executavel ativo default: false name: type: string maxLength: 255 description: Nome do executavel path: type: string maxLength: 1000 description: Caminho de execução sudo: type: boolean description: Sudo 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. mstrPackage: description: Tenant type: object required: – packageVersion – packageURL – packageChecksum properties: id: type: string format: uuid description: PK packageVersion: type: string maxLength: 255 description: Versão do pacote packageURL: type: string maxLength: 4000 description: URL do pacote packageChecksum: type: string maxLength: 64 description: Checksum do pacote 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. tenant: description: Tenant type: object required: – tenantId – tenantDomain – enabled properties: id: type: string format: uuid description: PK tenantId: type: string maxLength: 255 description: ID tenant tenantDomain: type: string maxLength: 255 description: Domínio do tenant dbConnection: type: object allOf: – #/definitions/dbConnection description: Conexão com a base para uso do MicroStrategy mstrConnection: type: object allOf: – #/definitions/mstrConnection description: Conexão com MicroStrategy enabled: type: boolean description: Habilitado tenantPackages: type: array items: type: object allOf: – #/definitions/tenantPackage description: Pacotes aplicados 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. tenantPackage: description: Pacotes utilizados no Tenant type: object required: – success – packageVersion properties: id: type: string format: uuid description: PK tenant: type: object allOf: – #/definitions/tenant description: Tenant success: type: boolean description: Aplicado com sucesso packageVersion: type: string description: Versão do pacote mstrPackage: type: object allOf: – #/definitions/mstrPackage description: Pacote 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. dbConnection: description: Conexão com banco de dados type: object required: – dataBaseKind – server – port – dataBase – username – password properties: id: type: string format: uuid description: PK enabled: type: boolean description: Ativa default: true remote: type: boolean description: Remota default: false dataBaseKind: type: string allOf: – #/definitions/dataBaseKind description: Tipo de banco de dados server: type: string maxLength: 255 description: Servidor port: type: integer format: int64 description: Porta minimum: 1 dataBase: type: string maxLength: 255 description: Nome da base de dados ou da instância username: type: string maxLength: 255 description: Usuário password: type: string maxLength: 255 description: Senha secret: true connectionUrl: type: string maxLength: 255 description: URL de conexão clusterOrIntegrated: type: boolean description: Cluster ou integrada default: false 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. 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