Create a database connection map
POST {{baseUrl}}/api/datasources/mappings
Create a new connection map. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You provide the information needed to create the new connection map in the body parameter of the request; you must provide a project id which you will get from GET /projects, connection id which you will get from GET /datasources/connections, datasource id which you will get from GET /datasources and database login id which you will get from GET /datasources/logins. For locale, it would work with either locale id or locale name. Locale name should provided in form of 'languageCOUNTRY' such as deDE, zhTW, enUS, jaJP, itIT etc.
Body
PARAM
| Key | Datatype | Required | Description |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
Content-Type
|
string |
RESPONSES
status Created
| {
"id": "NTpCN0NBOTJGMDRCOUZBRThEOTQxQzNFOUI3RTBDRDc1NDo3RkMwNUE2NTQ3M0NFMkZEODQ1Q0U2QTFEM0YxMzIzMzpCNUZCQzM1RjFCNDM5RjVBNEU2QUM0QjA3MjE5M0M5NjpEQUQ2Q0FENjQ1N0RBRjI5RTM0NDYzOTYxNjg4RUE2MDpGNDBDMjFGMTVBNEQ5NkJDQUYxMDJDQjQwOEE4NzcxMzowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA==",
"projectId": "B7CA92F04B9FAE8D941C3E9B7E0CD754",
"connection": {
"name": "Test Datasource Connection",
"id": "B5FBC35F1B439F5A4E6AC4B072193C96"
},
"datasource": {
"name": "Advanced Data Warehousing Warehouse",
"id": "DAD6CAD6457DAF29E34463961688EA60"
},
"user": {
"name": "MSTR User",
"id": "7FC05A65473CE2FD845CE6A1D3F13233"
},
"login": {
"name": "Test Datasource Login",
"id": "F40C21F15A4D96BCAF102CB408A87713"
},
"defaultConnectionMap": false
} |
ENDPOINTS