mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
ea2c0ce229
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
3.6 KiB
3.6 KiB
RuntimeappdefinitionsApi
All URIs are relative to /activiti-app/api
| Method | HTTP request | Description |
|---|---|---|
| deployAppDefinitions | POST /enterprise/runtime-app-definitions | Deploy a published app |
| getAppDefinition | GET /enterprise/runtime-app-definitions/{appDefinitionId} | Get a runtime app |
| getAppDefinitions | GET /enterprise/runtime-app-definitions | List runtime apps |
deployAppDefinitions
deployAppDefinitions(saveObject)
Deploy a published app
Deploying an app allows the user to see it on his/her landing page. Apps must be published before they can be deployed.
Example
import RuntimeappdefinitionsApi from 'src/api/activiti-rest-api/docs/RuntimeAppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let runtimeappdefinitionsApi = new RuntimeappdefinitionsApi(this.alfrescoApi);
runtimeappdefinitionsApi.deployAppDefinitions(saveObject).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| saveObject | RuntimeAppDefinitionSaveRepresentation | saveObject |
Return type
null (empty response body)
getAppDefinition
AppDefinitionRepresentation getAppDefinition(appDefinitionId)
Get a runtime app
Example
import RuntimeappdefinitionsApi from 'src/api/activiti-rest-api/docs/RuntimeAppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let runtimeappdefinitionsApi = new RuntimeappdefinitionsApi(this.alfrescoApi);
runtimeappdefinitionsApi.getAppDefinition(appDefinitionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| appDefinitionId | number | appDefinitionId |
Return type
getAppDefinitions
ResultListDataRepresentationAppDefinitionRepresentation getAppDefinitions()
List runtime apps
When a user logs in into Alfresco Process Services Suite, a landing page is displayed containing all the apps that the user is allowed to see and use. These are referred to as runtime apps.
Example
import RuntimeappdefinitionsApi from 'src/api/activiti-rest-api/docs/RuntimeAppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let runtimeappdefinitionsApi = new RuntimeappdefinitionsApi(this.alfrescoApi);
runtimeappdefinitionsApi.getAppDefinitions().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
Parameters
This endpoint does not need any parameter.