Skip to content

Commit

Permalink
Sync & Update code (#54)
Browse files Browse the repository at this point in the history
* US538739; Update yarn.lock

* update with latest code

* fix lint issues

* fix issues found by build

---------

Co-authored-by: ziyuhehe <davidheskrrr@gamil.com>
  • Loading branch information
ziyuhehe and ziyuhehe authored Mar 15, 2024
1 parent 69088e0 commit 9eea1c3
Show file tree
Hide file tree
Showing 211 changed files with 6,899 additions and 4,780 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A detailed description of each step of this request is listed down below. For th

## Get list of datasources based on project

Endpoint: [GET /api/projects/{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/getProjectDatasources)
Endpoint: [GET /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/getProjectDatasources)

This endpoint allows the caller to get the datasources associated with a specific project with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing the datasources for a project.

Expand Down Expand Up @@ -118,7 +118,7 @@ Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/

:::

Endpoint: [PATCH /api/projects/{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources)
Endpoint: [PATCH /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources)

This endpoint allows the caller to add and remove a datasource to a specific project with the MicroStrategy REST Server. In this request we will add a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be adding the Act! Essentials datasource to the MicroStrategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.
Expand Down Expand Up @@ -246,7 +246,7 @@ Learn more about MicroStrategy REST API Playground [here](/docs/getting-started/
:::
Endpoint: [PATCH /api/projects/{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources)
Endpoint: [PATCH /api/projects/\{projectId}/datasources](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateProjectDatasources)
This endpoint allows the caller to add and remove a datasource to a specific project with the MicroStrategy REST Server. In this request we will remove a datasource. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. For this sample we will be removing the Act! Essentials datasource from the MicroStrategy Tutorial project. You can find the datasourceId using the endpoint `GET /api/datasources` and the projectId using `GET /api/projects`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a list of the project's datasources.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A detailed description of each step is listed down below.

## Convert for a database source

Endpoint: [POST /api/datasources/{datasourceId}/conversion](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/datasourceConversion)
Endpoint: [POST /api/datasources/\{datasourceId}/conversion](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/datasourceConversion)

This endpoint allows the caller to convert for a database source with a embedded database connection. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the `datasourceId` using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 204.

Expand Down Expand Up @@ -232,7 +232,7 @@ Sample Response

## Convert for a datasource connection

Endpoint: [POST /api/datasources/connections/{connectionId}/conversion](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/datasourceConnectionConversion)
Endpoint: [POST /api/datasources/connections/\{connectionId}/conversion](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/datasourceConnectionConversion)

This endpoint allows the caller to convert for a standalone datasource connection. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the `connectionId` using the endpoint `GET /api/datasources/connections`. If the call is successful, the resulting HTTP response returns an HTTP status code 204.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You can obtain the datasource ID from searching for the datasource by name with

:::

Endpoint: [DELETE /api/datasources/{datasourceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/deleteDatasource)
Endpoint: [DELETE /api/datasources/\{datasourceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/deleteDatasource)

Sample Request Header:

Expand Down Expand Up @@ -58,7 +58,7 @@ You can obtain the connection ID from searching for datasource connections with

:::

Endpoint: [DELETE /api/datasources/connections/{connectionId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/deleteDatabaseConnectionById)
Endpoint: [DELETE /api/datasources/connections/\{connectionId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/deleteDatabaseConnectionById)

Sample Request Header:

Expand Down Expand Up @@ -89,7 +89,7 @@ You can obtain the login ID from viewing datasource logins with the endpoint `GE

:::

Endpoint: [DELETE /api/datasources/{datasourceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/deleteDatasource)
Endpoint: [DELETE /api/datasources/\{datasourceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/deleteDatasource)

Sample Request Header:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A detailed description of each step of this request is listed down below.

## Update a database source

Endpoint: [PATCH /api/datasources/{datasourceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasource)
Endpoint: [PATCH /api/datasources/\{datasourceId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasource)

This endpoint allows the caller to update a database source with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing a info for the updated database source.

Expand Down Expand Up @@ -98,7 +98,7 @@ Sample Response

## Update a datasource connection

Endpoint: [PATCH /api/datasources/connections/{connectionId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasourceConnection)
Endpoint: [PATCH /api/datasources/connections/\{connectionId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasourceConnection)

This endpoint allows the caller to update a datasource connection with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the connectionId using the endpoint `GET /api/datasources/connections`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource connection.

Expand Down Expand Up @@ -181,7 +181,7 @@ Sample Response

## Update a datasource login

Endpoint: [PATCH /api/datasources/logins/{loginId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasourceLogin)
Endpoint: [PATCH /api/datasources/logins/\{loginId}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateDatasourceLogin)

This endpoint allows the caller to update a datasource login with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the loginId using the endpoint `GET /api/datasources/logins`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info for the updated datasource login.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A detailed description of each step of this request is listed down below.

## Get job prioritization info for a database source

Endpoint: [GET /api/datasources/{datasourceId}/jobPriorities](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/getJobPrioritization)
Endpoint: [GET /api/datasources/\{datasourceId}/jobPriorities](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/getJobPrioritization)

This endpoint allows the caller to get job prioritization info for a specific database source with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 200 and a response body containing info regarding the job priorities for the datasource.

Expand Down Expand Up @@ -97,7 +97,7 @@ Sample Response

## Update job prioritization info for a database source

Endpoint: [PATCH /api/datasources/{datasourceId}/jobPriorities](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateJobPrioritization)
Endpoint: [PATCH /api/datasources/\{datasourceId}/jobPriorities](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Datasource%20Management/updateJobPrioritization)

This endpoint allows the caller to update job prioritization info for a specific database source with the MicroStrategy REST Server. You use the authorization token returned during login as the value for `X-MSTR-AuthToken`. You can find the datasourceId using the endpoint `GET /api/datasources`. If the call is successful, the resulting HTTP response returns an HTTP status code 204 and a empty response body.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ Sample Response

## Create a user email address

Endpoint: [POST /api/v2/users/{id}/addresses](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/User%20Management/createAddress)
Endpoint: [POST /api/v2/users/\{id}/addresses](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/User%20Management/createAddress)

This endpoint allows you to create a new address for a specific user.

Expand Down Expand Up @@ -552,7 +552,7 @@ Sample Response
## Get information on a specific subscription
Endpoint: [GET /api/subscriptions/{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/getSubscriptionById)
Endpoint: [GET /api/subscriptions/\{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/getSubscriptionById)
This endpoint returns all of the information on a specific subscription for a given project. This endpoint returns the name, ID, and other information about the Subscription. You obtain the authorization token needed to execute the request using `POST /api/auth/login` and you obtain the project ID using `GET /api/projects`. You retrieve the subscription by specifying the subscription ID in the path of the request. If the call is successful, the resulting HTTP response returns an HTTP status code of 200 and a response body containing all the information on the specified subscription.
Expand Down Expand Up @@ -641,7 +641,7 @@ Sample Response
## Send the specified subscription immediately
Endpoint: [POST /api/subscriptions/{id}/send](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/sendSubscription)
Endpoint: [POST /api/subscriptions/\{id}/send](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/sendSubscription)
This endpoint sends the specified subscription immediately. You obtain the authorization token needed to execute the request using `POST /api/auth/login`; you obtain the project ID using `GET /api/projects`. You identify the subscription by specifying the subscription ID in the request, you provide the information to send the subscription ID in the path parameter of the request. If the content is prompted and the user wants to update the answers, the user can answer the prompts and then provide content id and instance id as the request body of the call. If the call is successful, the resulting HTTP response returns an HTTP status code of 202 and an empty response body.
Expand Down Expand Up @@ -671,7 +671,7 @@ Sample Response
## Delete the subscription
Endpoint: [DELETE /api/subscriptions/{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/removeSubscription)
Endpoint: [DELETE /api/subscriptions/\{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/removeSubscription)
This endpoint allows you to delete/unsubscribe from the specified subscription. You obtain the authorization token needed to execute the request using `POST /api/auth/login`; you obtain the project ID using `GET /api/projects`. You delete the subscription by specifying the subscription ID in the path of the request. If the call is successful, the resulting HTTP response returns an HTTP status code of 204 and an empty response body.
Expand Down Expand Up @@ -701,7 +701,7 @@ Sample Response
## Delete user email
Endpoint: [DELETE /api/users/{userID}/addresses/{addressID}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/User%20Management/deleteUserAddress)
Endpoint: [DELETE /api/users/\{userID}/addresses/\{addressID}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/User%20Management/deleteUserAddress)
This endpoint deletes a specific address for a specific user. You obtain the authorization token needed to execute the request using `POST /api/auth/login`. You identify the user and the address by specifying the user ID and address ID in the path of the request. If the call is successful, the resulting HTTP response returns an HTTP status code of 204 and an empty response body.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Sample Response

## Create a user email

Endpoint: [POST /api/v2/users/{id}/addresses](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/User%20Management/createAddress)
Endpoint: [POST /api/v2/users/\{id}/addresses](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/User%20Management/createAddress)

This endpoint allows you to create a new address for a specific user. You obtain the authorization token needed to execute the request using `POST /api/auth/login`; you pass the authorization token in the request header. You identify the user by specifying the user ID in the path of the request; the user ID can be obtained by using `GET /api/users`. You provide the information used to create the new user address in the body parameter of the request - including the name and actual value for the address, whether it is the default address, and the type of delivery and content style. If the call is successful, the resulting HTTP response returns an HTTP status code of 200 and a response body containing all the information on the newly created address.

Expand Down Expand Up @@ -383,7 +383,7 @@ Sample Response

## Delete the subscription

Endpoint: [DELETE /api/subscriptions/{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/removeSubscription)
Endpoint: [DELETE /api/subscriptions/\{id}](https://demo.microstrategy.com/MicroStrategyLibrary/api-docs/index.html#/Subscriptions/removeSubscription)

This endpoint allows you to delete/unsubscribe from the specified subscription. You obtain the authorization token needed to execute the request using `POST /api/auth/login`, you obtain the project ID using `GET /api/projects`, and you obtain the subscription ID through `GET /api/subscriptions`. You delete the subscription by specifying the subscription ID in the path of the request. If the call is successful, the resulting HTTP response returns an HTTP status code of 204 and an empty response body.

Expand Down
Loading

0 comments on commit 9eea1c3

Please sign in to comment.