Optional realtime: RealtimeThe application to clone.
Optional version: stringIf a blueprint, you can define which version to clone. If not provided, it will always clone the latest version.
Creates a new application.
Response wrapped in IResult
Example
const newApp = {
name: 'New application',
type: 'EXTERNAL',
key: 'new-app'
};
(async () => {
const {data, res} = await applicationService.create(newApp);
})();
Application object.
entity or id of the application.
Example
const removeApp: object = {
id: 38
};
(async () => {
const {data, res} = await applicationService.delete(removeApp);
// data will be null
})();
Removes package version.
Request response.
Example
const { res } = await applicationService.deleteVersionPackage(app, {version: '1.0.0'});
const { res } = await applicationService.deleteVersionPackage(app, {tag: 'next'});
Application entity.
Version or tag indication package to remove.
Gets the details of selected application.
Response wrapped in IResult
Example
const applicationId: number = 1;
(async () => {
const {data, res} = await applicationService.detail(applicationId);
})();
Entity or Id of the entity.
Gets manifest (cumulocity.json file) of a given application.
Application manifest object.
Application entity.
Optional version: stringGet log for a specific application instance.
Response wrapped in IResult
Example
const applicationId: number = 1;
const applicationInstanceName: string = 'apama-ctrl-1c-4g-scope-t123456789-deployment-abcdefghij-abcde';
(async () => {
const {data, res} = await applicationService.getInstanceLog(applicationId, applicationInstanceName);
})();
Entity or Id of the application.
instance name of the application.
Optional params: IApplicationInstanceLogRequestParamsObject containing parameters for querying the log file.
Extracts instance names of the provided IApplicationManagedObject.
instance names
Example
const applicationId: number = 1;
(async () => {
const {data, res} = await applicationService.getStatusDetails(applicationId);
const instances = data.map((appMO) => applicationService.getInstanceNames(appMO));
})();
Application details managedObject.
Retrieves the manifest of the application behind the given context path.
Gets instance details of the specified application (microservice).
Response wrapped in IResultList
Example
const applicationId: number = 1;
(async () => {
const {data, res} = await applicationService.getStatusDetails(applicationId);
})();
Entity or Id of the application.
Application name or contextPath as a string or Application object.
Example
const checkApp: object = {
name: 'myApplication'
};
(async () => {
const {data, res} = await applicationService.isAvailable(checkApp);
})();
Gets the list of existing applications filtered by parameters.
Response wrapped in IResultList
Object containing filters for querying applications.
Example
const filter: object = {
pageSize: 100,
withTotalPages: true
};
(async () => {
const {data, res, paging} = await applicationService.list(filter);
})();
Optional tenantOrName: string | ITenantOptional tenantOrName: string | ITenantOptional userOrId: string | number | IUserGets the list of all application versions.
Returns list of all application versions.
Example
const applicationId: number = 1;
(async () => {
const {res, data} = await applicationService.listVersions(applicationId);
})();
Entity or Id of the entity.
Additional request parameters.
Sets tags for specific application package version.
Application version object.
Application entity.
Application package version which tags will be set.
Tags array to set on package version
Updates manifest (cumulocity.json file) of a given application.
Application manifest object.
Entity or Id of the application.
Application manifest object to be stored.
Updates existing application. Make sure that you specifiy the application id within the update object.
Response wrapped in IResult
Example
const updateApp = {
id: 38
name: 'Updated application'
};
(async () => {
const {data, res} = await applicationService.update(updateApp);
})();
Application object.
Updates the availability of the given application to the provided value.
Updated application.
Entity or Id of the application.
The new application availability.
Dynamic options are stored on the API in a specific config: {} object. They can
be used to configure the app dynamically.
Note: To avoids conflicts with the default Config, it is recommended to use a certain namespace.
Returns updated configuration.
Entity or Id of the application.
Configuration to be updated.
Clones a given application. The application name, key, and context-path will be prefixed with
cloneand if necessary a number.Returns
The application entity.