Install a Bizstack App installation to a specified tenant (home)

POST/bizstackAppInstallations

Base URL: https://api.tinkermode.com

Install a Bizstack App installation.

Note: The targetEntityId field in the request body specifies the ID of the entity under which the Bizstack App will be installed for non-tenant installations.
For tenant installations, this field must be omitted or left empty.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a project API key with the admin operation permission, a service account token with the same permission, or a key of a user with permissions:

• to create a child entity of a root entity of the tenant
• to create an access control group
• to create Bizstack App installations in a specified tenant
• to create the entity alert rules in a root entity of the tenant

Request body

Content type: application/json

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

Request example

{
  "bizstackAppId": "test_bizstack_app",
  "homeId": 23,
  "notificationEmails": "email1@example.com, email2@example.com",
  "targetEntityId": "test_entity_id"
}

Responses

`201` Successfully installed a Bizstack App.

Content type: application/json

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

`401` Authorization is required to access this resource.

Content type: application/json

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.

`403` Request failed because of invalid data or denied permission.

Content type: application/json

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.

`429` Request failed because of rate limit.

Content type: application/json

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.

`500` An unexpected error has occurred.

Content type: application/json

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.

`503` The service is temporarily unavailable.

Content type: application/json

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.