Platform | Power Bi Info

Service to manage entities of type 'PowerBiInfo'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos

URL	api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:
- DELETE PowerBiInfo by identifier
- DELETE PowerBiInfo by key

All Resources

This service uses the following resources:

ApiPowerBiInfoResource
PowerBiInfoResource

GET Operations

GET PowerBiInfos

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See PowerBiInfoResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos

GET /corePatterns/powerBiInfos

GET PowerBiInfos (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See PowerBiInfoResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos?page={page}&pageSize={pageSize}

GET /corePatterns/powerBiInfos?page={page}&pageSize={pageSize}

GET PowerBiInfo by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See PowerBiInfoResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{id}

GET /corePatterns/powerBiInfos/{id}

GET PowerBiInfo by key

Returns the entity record that matches the specified key.

The following elements are required:

appName

(string) The application's name.

Response:

When successful, the response body contains the entity record. See PowerBiInfoResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}

GET /corePatterns/powerBiInfos/{appName}

GET Print PowerBiInfo by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{id}/print?template={template}

GET /corePatterns/powerBiInfos/{id}/print?template={template}

GET Print PowerBiInfo by key

Prints the specified entity record.

The following elements are required:

appName

(string) The application's name.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}/print

GET /corePatterns/powerBiInfos/{appName}/print

GET Original Print PowerBiInfoOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{id}/printOriginal?template={template}

GET /corePatterns/powerBiInfos/{id}/printOriginal?template={template}

GET Original Print PowerBiInfo by key

Prints the specified entity record.

The following elements are required:

appName

(string) The application's name.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}/printOriginal

GET /corePatterns/powerBiInfos/{appName}/printOriginal

POST Operations

POST PowerBiInfos

Creates a new entity record.

The following elements are required:

powerBiInfoResource

(ApiPowerBiInfoResource) The request body should contain the entity record that should be created.
See ApiPowerBiInfoResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiPowerBiInfoResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos

POST /corePatterns/powerBiInfos

POST Get Token By App Name

Custom operation 'GetTokenByAppName'.

The following elements are required:

appName

(string) AppName.

Response:

When successful, the response body contains a string.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/getTokenByAppName

POST /corePatterns/powerBiInfos/getTokenByAppName

POST Get Info By App Name

Custom operation 'GetInfoByAppName'.

The following elements are required:

appName

(string) AppName.

Response:

When successful, the response body contains a resource of type 'PowerBiInfoResource'. See PowerBiInfoResource.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/getInfoByAppName

POST /corePatterns/powerBiInfos/getInfoByAppName

PUT Operations

PUT Set AppName PowerBiInfo

Updates the value of attribute 'AppName' in the specified entity record.

The following elements are required:

appName	(string) The application's name.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}/appName

PUT /corePatterns/powerBiInfos/{appName}/appName

PUT Set ClientId PowerBiInfo

Updates the value of attribute 'ClientId' in the specified entity record.

The following elements are required:

appName	(string) The application's name.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}/clientId

PUT /corePatterns/powerBiInfos/{appName}/clientId

PUT Set ClientSecret PowerBiInfo

Updates the value of attribute 'ClientSecret' in the specified entity record.

The following elements are required:

appName	(string) The application's name.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}/clientSecret

PUT /corePatterns/powerBiInfos/{appName}/clientSecret

PUT Set IsActive PowerBiInfo

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

appName	(string) The application's name.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}/isActive

PUT /corePatterns/powerBiInfos/{appName}/isActive

PUT Set Token PowerBiInfo

Updates the value of attribute 'Token' in the specified entity record.

The following elements are required:

appName	(string) The application's name.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}/token

PUT /corePatterns/powerBiInfos/{appName}/token

PUT Set TokenExpirationDate PowerBiInfo

Updates the value of attribute 'TokenExpirationDate' in the specified entity record.

The following elements are required:

appName	(string) The application's name.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}/tokenExpirationDate

PUT /corePatterns/powerBiInfos/{appName}/tokenExpirationDate

DELETE Operations

DELETE PowerBiInfo by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{id}

DELETE /corePatterns/powerBiInfos/{id}

DELETE PowerBiInfo by key

Deletes the entity record that matches the specified key.

The following elements are required:

appName

(string) The application's name.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/powerBiInfos/{appName}

DELETE /corePatterns/powerBiInfos/{appName}

Resources

ApiPowerBiInfoResource

The following elements are required:

appName	(string) The application's name.
clientId	(Guid) The client’s identifier.
clientSecret	(string) The client’s secret.

The following elements are optional:

token	(string) The token.
tokenExpirationDate	(DateTimeOffset) The token’s expiration date.

PowerBiInfoResource

The following elements are required:

appName	(string) The application's name.
clientId	(Guid) The client’s identifier.
clientSecret	(string) The client’s secret.

The following elements are optional:

token	(string) The token.
tokenExpirationDate	(DateTimeOffset) The token’s expiration date.