Custom Apps
To use custom apps in the Loome Portal, you will need to setup your custom app, stage your assets, and manage your metadata.
Setup a Custom App
The custom app will bind all entity types and assets together.
You can find the necessary requests to set up a custom app in the right-hand menu:
- Custom Apps:
- Stage Assets:
- Metadata:
Get Existing Custom Apps
First, you can find an existing custom app by using Get Custom App. This endpoint retrieves a list of existing available custom applications.
The response will be in JSON format, containing an array of custom applications. Each application object may include various attributes such as id, name, description, and other relevant details about the custom applications.
Get a Custom App by Id
Or, you can find an existing custom app by its Id Get Custom App by Id. It will return the name of the custom app with that Id. Use this endpoint to effectively manage and monitor your custom applications within the Loome Portal.
This endpoint retrieves detailed information about a specific custom application identified by CustomAppId. It is designed for consumers who need to access the configuration and metadata of their custom applications within the Loome Portal.
You will need to provide the path parameter CustomAppId. The unique identifier of the custom application you wish to retrieve. This parameter is required for the request.
Create a New Custom App
If you want to create a new custom app, use the Create Custom App endpoint.
The request body should be in JSON format and must include the following parameter: - Name (string): The name of the custom application being added. This is a required field.
Update a Custom App
You can update a custom app using Update Custom App. You can modify the name of the custom app.
The request body should be in JSON format and must include the following parameters: - id (string): The unique identifier of the custom application you wish to update. This is a required field. - name (string): The new name for the custom application. This is also a required field.
Delete a Custom App
You can delete a custom app using Delete Custom App. This will also delete any assets and their entity types added for this custom app.
You will need to provide the CustomAppId parameter. The string is the unique identifier of the custom application that will be deleted. This ID must correspond to an existing custom application in the system.
When deleting Custom Apps, it also deletes the associated assets with it, including the Entity Types. The attributes that were bulk uploaded remain in the system and will be unaffected, the links to the entity type will be deleted but the actual attribute will remain.