Bizstack App Installations data models
getBizstackAppInstallations — 200 response
Successfully retrieved the Bizstack App installations.
Represents a Bizstack App installation
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
appRootEntityId | string | No | read-only (server-generated) | The entityID of the entity that is the root entity of the installed Bizstack App |
appViewerAccessControlGroupId | string | No | read-only (server-generated) | The identifier of the access control group that is used to control a view access to the installed Bizstack App resources |
bizstackAppId | string | No | read-only (server-generated) | The identifier of the Bizstack App installed with this installation |
createdAt | string | No | read-only (server-generated) | The time the Bizstack App installation was created |
homeId | integer | No | read-only (server-generated) | Home that this Bizstack App installation belongs to |
id | string | No | read-only (server-generated) | The unique identifier for the Bizstack App installation |
projectId | integer | No | read-only (server-generated) | Project that this Bizstack App installation belongs to |
updatedAt | string | No | read-only (server-generated) | The time the Bizstack App installation was last updated |
getBizstackAppInstallations — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallations — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallations — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallations — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallations — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
installBizstackAppInstallationSpecifiedTenantHome — request
Request body for Install a Bizstack App installation to a specified tenant (home).
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
bizstackAppId | string | Yes | The identifier of the Bizstack App to be installed | |
homeId | integer | Yes | Home that this Bizstack App should be installed to | |
notificationEmails | string | No | Comma-separated list of email addresses to add as recipients of the alert notifications, in addition to the recipients defined by the app's alert rule templates. | |
targetEntityId | string | Yes | The entityID of the entity under which the Bizstack App should be installed |
installBizstackAppInstallationSpecifiedTenantHome — 201 response
Successfully installed a Bizstack App.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
appRootEntityId | string | No | read-only (server-generated) | The entityID of the entity that is the root entity of the installed Bizstack App |
appViewerAccessControlGroupId | string | No | read-only (server-generated) | The identifier of the access control group that is used to control a view access to the installed Bizstack App resources |
bizstackAppId | string | No | read-only (server-generated) | The identifier of the Bizstack App installed with this installation |
createdAt | string | No | read-only (server-generated) | The time the Bizstack App installation was created |
homeId | integer | No | read-only (server-generated) | Home that this Bizstack App installation belongs to |
id | string | No | read-only (server-generated) | The unique identifier for the Bizstack App installation |
projectId | integer | No | read-only (server-generated) | Project that this Bizstack App installation belongs to |
updatedAt | string | No | read-only (server-generated) | The time the Bizstack App installation was last updated |
installBizstackAppInstallationSpecifiedTenantHome — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
installBizstackAppInstallationSpecifiedTenantHome — 403 response
Request failed because of invalid data or denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
installBizstackAppInstallationSpecifiedTenantHome — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
installBizstackAppInstallationSpecifiedTenantHome — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
installBizstackAppInstallationSpecifiedTenantHome — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallation — 200 response
Successfully retrieved the Bizstack App installation with specified ID.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
appRootEntityId | string | No | read-only (server-generated) | The entityID of the entity that is the root entity of the installed Bizstack App |
appViewerAccessControlGroupId | string | No | read-only (server-generated) | The identifier of the access control group that is used to control a view access to the installed Bizstack App resources |
bizstackAppId | string | No | read-only (server-generated) | The identifier of the Bizstack App installed with this installation |
createdAt | string | No | read-only (server-generated) | The time the Bizstack App installation was created |
homeId | integer | No | read-only (server-generated) | Home that this Bizstack App installation belongs to |
id | string | No | read-only (server-generated) | The unique identifier for the Bizstack App installation |
projectId | integer | No | read-only (server-generated) | Project that this Bizstack App installation belongs to |
updatedAt | string | No | read-only (server-generated) | The time the Bizstack App installation was last updated |
getBizstackAppInstallation — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallation — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallation — 404 response
The requested bizstackAppInstallation does not exist or is not accessible.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallation — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallation — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getBizstackAppInstallation — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |