[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081)

* 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
This commit is contained in:
Denys Vuika
2023-11-21 10:27:51 +00:00
committed by GitHub
parent 804fa2ffd4
commit ea2c0ce229
1334 changed files with 82605 additions and 1068 deletions

View File

@@ -0,0 +1,30 @@
# AboutApi
All URIs are relative to */activiti-app/api*
| Method | HTTP request | Description |
|---------------------------------|---------------------------------|-----------------------------|
| [getAppVersion](#getAppVersion) | **GET** /enterprise/app-version | Get server type and version |
# getAppVersion
Get server type and version
Provides information about the running Alfresco Process Services Suite.
The response payload object has the properties type, majorVersion, minorVersion, revisionVersion and edition.
**Return type**: **Map<string, string>**
**Example**
```javascript
import { AlfrescoApi, AboutApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const aboutApi = new AboutApi(alfrescoApi);
aboutApi.getAppVersion().then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```

View File

@@ -0,0 +1,11 @@
# AbstractGroupRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**externalId** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**status** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,14 @@
# AbstractUserRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**company** | **string** | | [optional] [default to null]
**email** | **string** | | [optional] [default to null]
**externalId** | **string** | | [optional] [default to null]
**firstName** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**lastName** | **string** | | [optional] [default to null]
**pictureId** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,56 @@
# AccountIntegrationApi
All URIs are relative to */activiti-app/api*
| Method | HTTP request | Description |
|-----------------------------|-----------------------------------------|---------------------------------------|
| [getAccounts](#getAccounts) | **GET** /enterprise/account/integration | Retrieve external account information |
# **getAccounts**
Retrieve external account information
Accounts are used to integrate with third party apps and clients
**Return type**: [ResultListDataRepresentationAccountRepresentation](#ResultListDataRepresentationAccountRepresentation)
**Example**
```javascript
import { AlfrescoApi, AccountIntegrationApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const accountIntegrationApi = new AccountIntegrationApi(alfrescoApi);
accountIntegrationApi.getAccounts().then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# Models
## ResultListDataRepresentationAccountRepresentation
**Properties**
| Name | Type |
|-------|---------------------------------------------------|
| data | [AccountRepresentation[]](#AccountRepresentation) |
| size | number |
| start | number |
| total | number |
## AccountRepresentation
**Properties**
| Name | Type |
|------------------|---------|
| authorizationUrl | string |
| authorized | boolean |
| metaDataAllowed | boolean |
| name | string |
| serviceId | string |

View File

@@ -0,0 +1,8 @@
# AddGroupCapabilitiesRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**capabilities** | **string[]** | | [optional] [default to null]

View File

@@ -0,0 +1,313 @@
# AdminEndpointsApi
All URIs are relative to */activiti-app/api*
| Method | HTTP request | Description |
|---------------------------------------------------------------|------------------------------------------------------------------|----------------------------------|
| [createBasicAuthConfiguration](#createBasicAuthConfiguration) | **POST** /enterprise/admin/basic-auths | Add an endpoint authorization |
| [createEndpointConfiguration](#createEndpointConfiguration) | **POST** /enterprise/admin/endpoints | Create an endpoint |
| [getBasicAuthConfiguration](#getBasicAuthConfiguration) | **GET** /enterprise/admin/basic-auths/{basicAuthId} | Get an endpoint authorization |
| [getBasicAuthConfigurations](#getBasicAuthConfigurations) | **GET** /enterprise/admin/basic-auths | List endpoint authorizations |
| [getEndpointConfiguration](#getEndpointConfiguration) | **GET** /enterprise/admin/endpoints/{endpointConfigurationId} | Get an endpoint |
| [getEndpointConfigurations](#getEndpointConfigurations) | **GET** /enterprise/admin/endpoints | List endpoints |
| [removeBasicAuthConfiguration](#removeBasicAuthConfiguration) | **DELETE** /enterprise/admin/basic-auths/{basicAuthId} | Delete an endpoint authorization |
| [removeEndpointConfiguration](#removeEndpointConfiguration) | **DELETE** /enterprise/admin/endpoints/{endpointConfigurationId} | Delete an endpoint |
| [updateBasicAuthConfiguration](#updateBasicAuthConfiguration) | **PUT** /enterprise/admin/basic-auths/{basicAuthId} | Update an endpoint authorization |
| [updateEndpointConfiguration](#updateEndpointConfiguration) | **PUT** /enterprise/admin/endpoints/{endpointConfigurationId} | Update an endpoint |
# createBasicAuthConfiguration
Add an endpoint authorization
**Parameters**
| Name | Type |
|--------------------------|---------------------------------------------------------------------------------|
| **createRepresentation** | [CreateEndpointBasicAuthRepresentation](#CreateEndpointBasicAuthRepresentation) |
**Return type**: [EndpointBasicAuthRepresentation](#EndpointBasicAuthRepresentation)
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const createRepresentation = {};
adminEndpointsApi.createBasicAuthConfiguration(createRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# createEndpointConfiguration
Create an endpoint
**Parameters**
| Name | Type |
|--------------------|-------------------------------------------------------------------------------|
| **representation** | [EndpointConfigurationRepresentation](EndpointConfigurationRepresentation.md) |
**Return type**: [EndpointConfigurationRepresentation](EndpointConfigurationRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const representation = {};
adminEndpointsApi.createEndpointConfiguration(representation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getBasicAuthConfiguration
Get an endpoint authorization
**Parameters**
| Name | Type | Description |
|-----------------|--------|-------------|
| **basicAuthId** | number | basicAuthId |
| **tenantId** | number | tenantId |
**Return type**: [EndpointBasicAuthRepresentation](#EndpointBasicAuthRepresentation)
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const authId = 0;
const tenantId = 0;
adminEndpointsApi.getBasicAuthConfiguration(authId, tenantId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getBasicAuthConfigurations
List endpoint authorizations
**Parameters**
| Name | Type |
|--------------|--------|
| **tenantId** | number |
**Return type**: [EndpointBasicAuthRepresentation](#EndpointBasicAuthRepresentation)
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const tenantId = 0;
adminEndpointsApi.getBasicAuthConfigurations(tenantId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getEndpointConfiguration
Get an endpoint
**Parameters**
| Name | Type |
|-----------------------------|--------|
| **endpointConfigurationId** | number |
| **tenantId** | number |
**Return type**: [EndpointConfigurationRepresentation](EndpointConfigurationRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const endpointConfigurationId = 0;
const tenantId = 0;
adminEndpointsApi.getEndpointConfiguration(endpointConfigurationId, tenantId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getEndpointConfigurations
List endpoints
**Parameters**
| Name | Type |
|--------------|--------|
| **tenantId** | number |
**Return type**: [EndpointConfigurationRepresentation](EndpointConfigurationRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const tenantId = 0;
adminEndpointsApi.getEndpointConfigurations(tenantId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# removeBasicAuthConfiguration
Delete an endpoint authorization
**Parameters**
| Name | Type |
|-----------------|--------|
| **basicAuthId** | number |
| **tenantId** | number |
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const basicAuthId = 0;
const tenantId = 0;
adminEndpointsApi.removeBasicAuthConfiguration(basicAuthId, tenantId).then(() => {
console.log('API called successfully.');
});
```
# removeEndpointConfiguration
Delete an endpoint
**Parameters**
| Name | Type |
|-----------------------------|--------|
| **endpointConfigurationId** | number |
| **tenantId** | number |
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const endpointConfigurationId = 0;
const tenantId = 0;
adminendpointsApi.removeEndpointConfiguration(endpointConfigurationId, tenantId).then(() => {
console.log('API called successfully.');
});
```
# updateBasicAuthConfiguration
Update an endpoint authorization
**Parameters**
| Name | Type |
|--------------------------|---------------------------------------------------------------------------------|
| **basicAuthId** | number |
| **createRepresentation** | [CreateEndpointBasicAuthRepresentation](#CreateEndpointBasicAuthRepresentation) |
**Return type**: [EndpointBasicAuthRepresentation](#EndpointBasicAuthRepresentation)
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const basicAuthId = 0;
const createRepresentation = {};
adminEndpointsApi.updateBasicAuthConfiguration(basicAuthId, createRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# updateEndpointConfiguration
Update an endpoint
**Parameters**
| Name | Type |
|-----------------------------|-------------------------------------------------------------------------------|
| **endpointConfigurationId** | number |
| **representation** | [EndpointConfigurationRepresentation](EndpointConfigurationRepresentation.md) |
**Return type**: [EndpointConfigurationRepresentation](EndpointConfigurationRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, AdminEndpointsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const adminEndpointsApi = new AdminEndpointsApi(alfrescoApi);
const endpointConfigurationId = 0;
const representation = {};
adminendpointsApi.updateEndpointConfiguration(endpointConfigurationId, representation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# Models
## CreateEndpointBasicAuthRepresentation
**Properties**
| Name | Type |
|----------|--------|
| name | string |
| password | string |
| tenantId | number |
| username | string |
## EndpointBasicAuthRepresentation
**Properties**
| Name | Type |
|-------------|--------|
| created | Date |
| id | number |
| lastUpdated | Date |
| name | string |
| tenantId | number |
| username | string |

View File

@@ -0,0 +1,661 @@
# AdmingroupsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**activate**](AdminGroupsApi.md#activate) | **POST** /enterprise/admin/groups/{groupId}/action/activate | Activate a group
[**addAllUsersToGroup**](AdminGroupsApi.md#addAllUsersToGroup) | **POST** /enterprise/admin/groups/{groupId}/add-all-users | Add users to a group
[**addGroupCapabilities**](AdminGroupsApi.md#addGroupCapabilities) | **POST** /enterprise/admin/groups/{groupId}/capabilities | Add capabilities to a group
[**addGroupMember**](AdminGroupsApi.md#addGroupMember) | **POST** /enterprise/admin/groups/{groupId}/members/{userId} | Add a user to a group
[**addRelatedGroup**](AdminGroupsApi.md#addRelatedGroup) | **POST** /enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId} | Get a related group
[**createNewGroup**](AdminGroupsApi.md#createNewGroup) | **POST** /enterprise/admin/groups | Create a group
[**deleteGroupCapability**](AdminGroupsApi.md#deleteGroupCapability) | **DELETE** /enterprise/admin/groups/{groupId}/capabilities/{groupCapabilityId} | Remove a capability from a group
[**deleteGroupMember**](AdminGroupsApi.md#deleteGroupMember) | **DELETE** /enterprise/admin/groups/{groupId}/members/{userId} | Delete a member from a group
[**deleteGroup**](AdminGroupsApi.md#deleteGroup) | **DELETE** /enterprise/admin/groups/{groupId} | Delete a group
[**deleteRelatedGroup**](AdminGroupsApi.md#deleteRelatedGroup) | **DELETE** /enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId} | Delete a related group
[**getCapabilities**](AdminGroupsApi.md#getCapabilities) | **GET** /enterprise/admin/groups/{groupId}/potential-capabilities | List group capabilities
[**getGroupUsers**](AdminGroupsApi.md#getGroupUsers) | **GET** /enterprise/admin/groups/{groupId}/users | Get group members
[**getGroup**](AdminGroupsApi.md#getGroup) | **GET** /enterprise/admin/groups/{groupId} | Get a group
[**getGroups**](AdminGroupsApi.md#getGroups) | **GET** /enterprise/admin/groups | Query groups
[**getRelatedGroups**](AdminGroupsApi.md#getRelatedGroups) | **GET** /enterprise/admin/groups/{groupId}/related-groups | Get related groups
[**updateGroup**](AdminGroupsApi.md#updateGroup) | **PUT** /enterprise/admin/groups/{groupId} | Update a group
<a name="activate"></a>
# **activate**
> activate(groupId)
Activate a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.activate(groupId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
### Return type
null (empty response body)
<a name="addAllUsersToGroup"></a>
# **addAllUsersToGroup**
> addAllUsersToGroup(groupId)
Add users to a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.addAllUsersToGroup(groupId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
### Return type
null (empty response body)
<a name="addGroupCapabilities"></a>
# **addGroupCapabilities**
> addGroupCapabilities(groupIdaddGroupCapabilitiesRepresentation)
Add capabilities to a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.addGroupCapabilities(groupIdaddGroupCapabilitiesRepresentation).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**addGroupCapabilitiesRepresentation** | [**AddGroupCapabilitiesRepresentation**](AddGroupCapabilitiesRepresentation.md)| addGroupCapabilitiesRepresentation |
### Return type
null (empty response body)
<a name="addGroupMember"></a>
# **addGroupMember**
> addGroupMember(groupIduserId)
Add a user to a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.addGroupMember(groupIduserId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**userId** | **number**| userId |
### Return type
null (empty response body)
<a name="addRelatedGroup"></a>
# **addRelatedGroup**
> addRelatedGroup(groupIdrelatedGroupIdtype)
Get a related group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.addRelatedGroup(groupIdrelatedGroupIdtype).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**relatedGroupId** | **number**| relatedGroupId |
**type** | **string**| type |
### Return type
null (empty response body)
<a name="createNewGroup"></a>
# **createNewGroup**
> GroupRepresentation createNewGroup(groupRepresentation)
Create a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.createNewGroup(groupRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupRepresentation** | [**GroupRepresentation**](GroupRepresentation.md)| groupRepresentation |
### Return type
[**GroupRepresentation**](GroupRepresentation.md)
<a name="deleteGroupCapability"></a>
# **deleteGroupCapability**
> deleteGroupCapability(groupIdgroupCapabilityId)
Remove a capability from a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.deleteGroupCapability(groupIdgroupCapabilityId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**groupCapabilityId** | **number**| groupCapabilityId |
### Return type
null (empty response body)
<a name="deleteGroupMember"></a>
# **deleteGroupMember**
> deleteGroupMember(groupIduserId)
Delete a member from a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.deleteGroupMember(groupIduserId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**userId** | **number**| userId |
### Return type
null (empty response body)
<a name="deleteGroup"></a>
# **deleteGroup**
> deleteGroup(groupId)
Delete a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.deleteGroup(groupId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
### Return type
null (empty response body)
<a name="deleteRelatedGroup"></a>
# **deleteRelatedGroup**
> deleteRelatedGroup(groupIdrelatedGroupId)
Delete a related group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.deleteRelatedGroup(groupIdrelatedGroupId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**relatedGroupId** | **number**| relatedGroupId |
### Return type
null (empty response body)
<a name="getCapabilities"></a>
# **getCapabilities**
> string getCapabilities(groupId)
List group capabilities
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.getCapabilities(groupId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
### Return type
**string**
<a name="getGroupUsers"></a>
# **getGroupUsers**
> ResultListDataRepresentationLightUserRepresentation getGroupUsers(groupIdopts)
Get group members
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
let opts = {
'filter': filter_example // | filter
'page': 56 // | page
'pageSize': 56 // | pageSize
};
admingroupsApi.getGroupUsers(groupIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**filter** | **string**| filter | [optional]
**page** | **number**| page | [optional]
**pageSize** | **number**| pageSize | [optional]
### Return type
[**ResultListDataRepresentationLightUserRepresentation**](ResultListDataRepresentationLightUserRepresentation.md)
<a name="getGroup"></a>
# **getGroup**
> AbstractGroupRepresentation getGroup(groupIdopts)
Get a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
let opts = {
'includeAllUsers': true // | includeAllUsers
'summary': true // | summary
};
admingroupsApi.getGroup(groupIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**includeAllUsers** | **boolean**| includeAllUsers | [optional]
**summary** | **boolean**| summary | [optional]
### Return type
[**AbstractGroupRepresentation**](AbstractGroupRepresentation.md)
<a name="getGroups"></a>
# **getGroups**
> LightGroupRepresentation getGroups(opts)
Query groups
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
let opts = {
'tenantId': 789 // | tenantId
'functional': true // | functional
'summary': true // | summary
};
admingroupsApi.getGroups(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId | [optional]
**functional** | **boolean**| functional | [optional]
**summary** | **boolean**| summary | [optional]
### Return type
[**LightGroupRepresentation**](LightGroupRepresentation.md)
<a name="getRelatedGroups"></a>
# **getRelatedGroups**
> LightGroupRepresentation getRelatedGroups(groupId)
Get related groups
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.getRelatedGroups(groupId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
### Return type
[**LightGroupRepresentation**](LightGroupRepresentation.md)
<a name="updateGroup"></a>
# **updateGroup**
> GroupRepresentation updateGroup(groupIdgroupRepresentation)
Update a group
### Example
```javascript
import AdmingroupsApi from 'src/api/activiti-rest-api/docs/AdminGroupsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admingroupsApi = new AdmingroupsApi(this.alfrescoApi);
admingroupsApi.updateGroup(groupIdgroupRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
**groupRepresentation** | [**GroupRepresentation**](GroupRepresentation.md)| groupRepresentation |
### Return type
[**GroupRepresentation**](GroupRepresentation.md)

View File

@@ -0,0 +1,322 @@
# AdmintenantsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createTenant**](AdminTenantsApi.md#createTenant) | **POST** /enterprise/admin/tenants | Create a tenant
[**deleteTenant**](AdminTenantsApi.md#deleteTenant) | **DELETE** /enterprise/admin/tenants/{tenantId} | Delete a tenant
[**getTenantEvents**](AdminTenantsApi.md#getTenantEvents) | **GET** /enterprise/admin/tenants/{tenantId}/events | Get tenant events
[**getTenantLogo**](AdminTenantsApi.md#getTenantLogo) | **GET** /enterprise/admin/tenants/{tenantId}/logo | Get a tenant's logo
[**getTenant**](AdminTenantsApi.md#getTenant) | **GET** /enterprise/admin/tenants/{tenantId} | Get a tenant
[**getTenants**](AdminTenantsApi.md#getTenants) | **GET** /enterprise/admin/tenants | List tenants
[**update**](AdminTenantsApi.md#update) | **PUT** /enterprise/admin/tenants/{tenantId} | Update a tenant
[**uploadTenantLogo**](AdminTenantsApi.md#uploadTenantLogo) | **POST** /enterprise/admin/tenants/{tenantId}/logo | Update a tenant's logo
<a name="createTenant"></a>
# **createTenant**
> LightTenantRepresentation createTenant(createTenantRepresentation)
Create a tenant
Only a tenant manager may access this endpoint
### Example
```javascript
import AdmintenantsApi from 'src/api/activiti-rest-api/docs/AdminTenantsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);
admintenantsApi.createTenant(createTenantRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**createTenantRepresentation** | [**CreateTenantRepresentation**](CreateTenantRepresentation.md)| createTenantRepresentation |
### Return type
[**LightTenantRepresentation**](LightTenantRepresentation.md)
<a name="deleteTenant"></a>
# **deleteTenant**
> deleteTenant(tenantId)
Delete a tenant
### Example
```javascript
import AdmintenantsApi from 'src/api/activiti-rest-api/docs/AdminTenantsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);
admintenantsApi.deleteTenant(tenantId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId |
### Return type
null (empty response body)
<a name="getTenantEvents"></a>
# **getTenantEvents**
> TenantEvent getTenantEvents(tenantId)
Get tenant events
### Example
```javascript
import AdmintenantsApi from 'src/api/activiti-rest-api/docs/AdminTenantsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);
admintenantsApi.getTenantEvents(tenantId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId |
### Return type
[**TenantEvent**](TenantEvent.md)
<a name="getTenantLogo"></a>
# **getTenantLogo**
> getTenantLogo(tenantId)
Get a tenant's logo
### Example
```javascript
import AdmintenantsApi from 'src/api/activiti-rest-api/docs/AdminTenantsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);
admintenantsApi.getTenantLogo(tenantId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId |
### Return type
null (empty response body)
<a name="getTenant"></a>
# **getTenant**
> TenantRepresentation getTenant(tenantId)
Get a tenant
### Example
```javascript
import AdmintenantsApi from 'src/api/activiti-rest-api/docs/AdminTenantsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);
admintenantsApi.getTenant(tenantId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId |
### Return type
[**TenantRepresentation**](TenantRepresentation.md)
<a name="getTenants"></a>
# **getTenants**
> LightTenantRepresentation getTenants()
List tenants
Only a tenant manager may access this endpoint
### Example
```javascript
import AdmintenantsApi from 'src/api/activiti-rest-api/docs/AdminTenantsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);
admintenantsApi.getTenants().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**LightTenantRepresentation**](LightTenantRepresentation.md)
<a name="update"></a>
# **update**
> TenantRepresentation update(tenantIdcreateTenantRepresentation)
Update a tenant
### Example
```javascript
import AdmintenantsApi from 'src/api/activiti-rest-api/docs/AdminTenantsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);
admintenantsApi.update(tenantIdcreateTenantRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId |
**createTenantRepresentation** | [**CreateTenantRepresentation**](CreateTenantRepresentation.md)| createTenantRepresentation |
### Return type
[**TenantRepresentation**](TenantRepresentation.md)
<a name="uploadTenantLogo"></a>
# **uploadTenantLogo**
> ImageUploadRepresentation uploadTenantLogo(tenantIdfile)
Update a tenant's logo
### Example
```javascript
import AdmintenantsApi from 'src/api/activiti-rest-api/docs/AdminTenantsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let admintenantsApi = new AdmintenantsApi(this.alfrescoApi);
admintenantsApi.uploadTenantLogo(tenantIdfile).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId |
**file** | **Blob**| file |
### Return type
[**ImageUploadRepresentation**](ImageUploadRepresentation.md)

View File

@@ -0,0 +1,231 @@
# AdminusersApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**bulkUpdateUsers**](AdminUsersApi.md#bulkUpdateUsers) | **PUT** /enterprise/admin/users | Bulk update a list of users
[**createNewUser**](AdminUsersApi.md#createNewUser) | **POST** /enterprise/admin/users | Create a user
[**getUser**](AdminUsersApi.md#getUser) | **GET** /enterprise/admin/users/{userId} | Get a user
[**getUsers**](AdminUsersApi.md#getUsers) | **GET** /enterprise/admin/users | Query users
[**updateUserDetails**](AdminUsersApi.md#updateUserDetails) | **PUT** /enterprise/admin/users/{userId} | Update a user
<a name="bulkUpdateUsers"></a>
# **bulkUpdateUsers**
> bulkUpdateUsers(update)
Bulk update a list of users
### Example
```javascript
import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let adminusersApi = new AdminusersApi(this.alfrescoApi);
adminusersApi.bulkUpdateUsers(update).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**update** | [**BulkUserUpdateRepresentation**](BulkUserUpdateRepresentation.md)| update |
### Return type
null (empty response body)
<a name="createNewUser"></a>
# **createNewUser**
> UserRepresentation createNewUser(userRepresentation)
Create a user
### Example
```javascript
import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let adminusersApi = new AdminusersApi(this.alfrescoApi);
adminusersApi.createNewUser(userRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userRepresentation** | [**UserRepresentation**](UserRepresentation.md)| userRepresentation |
### Return type
[**UserRepresentation**](UserRepresentation.md)
<a name="getUser"></a>
# **getUser**
> AbstractUserRepresentation getUser(userIdopts)
Get a user
### Example
```javascript
import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let adminusersApi = new AdminusersApi(this.alfrescoApi);
let opts = {
'summary': true // | summary
};
adminusersApi.getUser(userIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **number**| userId |
**summary** | **boolean**| summary | [optional]
### Return type
[**AbstractUserRepresentation**](AbstractUserRepresentation.md)
<a name="getUsers"></a>
# **getUsers**
> ResultListDataRepresentationAbstractUserRepresentation getUsers(opts)
Query users
### Example
```javascript
import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let adminusersApi = new AdminusersApi(this.alfrescoApi);
let opts = {
'filter': filter_example // | filter
'status': status_example // | status
'accountType': accountType_example // | accountType
'sort': sort_example // | sort
'company': company_example // | company
'start': 56 // | start
'page': 56 // | page
'size': 56 // | size
'groupId': 789 // | groupId
'tenantId': 789 // | tenantId
'summary': true // | summary
};
adminusersApi.getUsers(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **string**| filter | [optional]
**status** | **string**| status | [optional]
**accountType** | **string**| accountType | [optional]
**sort** | **string**| sort | [optional]
**company** | **string**| company | [optional]
**start** | **number**| start | [optional]
**page** | **number**| page | [optional]
**size** | **number**| size | [optional]
**groupId** | **number**| groupId | [optional]
**tenantId** | **number**| tenantId | [optional]
**summary** | **boolean**| summary | [optional]
### Return type
[**ResultListDataRepresentationAbstractUserRepresentation**](ResultListDataRepresentationAbstractUserRepresentation.md)
<a name="updateUserDetails"></a>
# **updateUserDetails**
> updateUserDetails(userIduserRepresentation)
Update a user
### Example
```javascript
import AdminusersApi from 'src/api/activiti-rest-api/docs/AdminUsersApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let adminusersApi = new AdminusersApi(this.alfrescoApi);
adminusersApi.updateUserDetails(userIduserRepresentation).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **number**| userId |
**userRepresentation** | [**UserRepresentation**](UserRepresentation.md)| userRepresentation |
### Return type
null (empty response body)

View File

@@ -0,0 +1,11 @@
# AlfrescoContentRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**folder** | **boolean** | | [optional] [default to null]
**id** | **string** | | [optional] [default to null]
**simpleType** | **string** | | [optional] [default to null]
**title** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,19 @@
# AlfrescoEndpointRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accountUsername** | **string** | | [optional] [default to null]
**alfrescoTenantId** | **string** | | [optional] [default to null]
**created** | [**Date**](Date.md) | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**lastUpdated** | [**Date**](Date.md) | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**repositoryUrl** | **string** | | [optional] [default to null]
**secret** | **string** | | [optional] [default to null]
**shareUrl** | **string** | | [optional] [default to null]
**tenantId** | **number** | | [optional] [default to null]
**useShareConnector** | **boolean** | | [optional] [default to null]
**version** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,8 @@
# AlfrescoNetworkRepresenation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# AlfrescoSiteRepresenation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional] [default to null]
**title** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,11 @@
# AppDefinition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**icon** | **string** | | [optional] [default to null]
**models** | [**AppModelDefinition[]**](AppModelDefinition.md) | | [optional] [default to null]
**publishIdentityInfo** | [**PublishIdentityInfoRepresentation[]**](PublishIdentityInfoRepresentation.md) | | [optional] [default to null]
**theme** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# AppDefinitionPublishRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **string** | | [optional] [default to null]
**force** | **boolean** | | [optional] [default to null]

View File

@@ -0,0 +1,16 @@
# AppDefinitionRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**defaultAppId** | **string** | | [optional] [default to null]
**deploymentId** | **string** | | [optional] [default to null]
**description** | **string** | | [optional] [default to null]
**icon** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**modelId** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**tenantId** | **number** | | [optional] [default to null]
**theme** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,10 @@
# AppDefinitionSaveRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**appDefinition** | [**AppDefinitionRepresentation**](AppDefinitionRepresentation.md) | | [optional] [default to null]
**force** | **boolean** | | [optional] [default to null]
**publish** | **boolean** | | [optional] [default to null]

View File

@@ -0,0 +1,14 @@
# AppDefinitionUpdateResultRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**appDefinition** | [**AppDefinitionRepresentation**](AppDefinitionRepresentation.md) | | [optional] [default to null]
**customData** | **any** | | [optional] [default to null]
**error** | **boolean** | | [optional] [default to null]
**errorDescription** | **string** | | [optional] [default to null]
**errorType** | **number** | | [optional] [default to null]
**message** | **string** | | [optional] [default to null]
**messageKey** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,375 @@
# AppdefinitionsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteAppDefinition**](AppDefinitionsApi.md#deleteAppDefinition) | **DELETE** /enterprise/app-definitions/{appDefinitionId} | deleteAppDefinition
[**exportAppDefinition**](AppDefinitionsApi.md#exportAppDefinition) | **GET** /enterprise/app-definitions/{modelId}/export | Export an app definition
[**getAppDefinition**](AppDefinitionsApi.md#getAppDefinition) | **GET** /enterprise/app-definitions/{modelId} | Get an app definition
[**importAndPublishApp**](AppDefinitionsApi.md#importAndPublishApp) | **POST** /enterprise/app-definitions/publish-app | importAndPublishApp
[**importAndPublishApp**](AppDefinitionsApi.md#importAndPublishApp) | **POST** /enterprise/app-definitions/{modelId}/publish-app | importAndPublishApp
[**importAppDefinition**](AppDefinitionsApi.md#importAppDefinition) | **POST** /enterprise/app-definitions/import | Import a new app definition
[**updateAppDefinition**](AppDefinitionsApi.md#importAppDefinition) | **POST** /enterprise/app-definitions/{modelId}/import | Update the content of an existing app
[**publishAppDefinition**](AppDefinitionsApi.md#publishAppDefinition) | **POST** /enterprise/app-definitions/{modelId}/publish | Publish an app definition
[**updateAppDefinition**](AppDefinitionsApi.md#updateAppDefinition) | **PUT** /enterprise/app-definitions/{modelId} | Update an app definition
<a name="deleteAppDefinition"></a>
# **deleteAppDefinition**
> deleteAppDefinition(appDefinitionId)
deleteAppDefinition
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
appdefinitionsApi.deleteAppDefinition(appDefinitionId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**appDefinitionId** | **number**| appDefinitionId |
### Return type
null (empty response body)
<a name="exportAppDefinition"></a>
# **exportAppDefinition**
> exportAppDefinition(modelId)
Export an app definition
This will return a zip file containing the app definition model and all related models (process definitions and forms).
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
appdefinitionsApi.exportAppDefinition(modelId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId from a runtime app or the id of an app definition model |
### Return type
null (empty response body)
<a name="getAppDefinition"></a>
# **getAppDefinition**
> AppDefinitionRepresentation getAppDefinition(modelId)
Get an app definition
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
appdefinitionsApi.getAppDefinition(modelId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| Application definition ID |
### Return type
[**AppDefinitionRepresentation**](AppDefinitionRepresentation.md)
<a name="importAndPublishApp"></a>
# **importAndPublishApp**
> AppDefinitionUpdateResultRepresentation importAndPublishApp(file)
importAndPublishApp
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
appdefinitionsApi.importAndPublishApp(file).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**file** | **Blob**| file |
### Return type
[**AppDefinitionUpdateResultRepresentation**](AppDefinitionUpdateResultRepresentation.md)
<a name="importAndPublishApp"></a>
# **importAndPublishApp**
> AppDefinitionUpdateResultRepresentation importAndPublishApp(modelIdfile)
importAndPublishApp
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
appdefinitionsApi.importAndPublishApp(modelIdfile).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**file** | **Blob**| file |
### Return type
[**AppDefinitionUpdateResultRepresentation**](AppDefinitionUpdateResultRepresentation.md)
<a name="importAppDefinition"></a>
# **importAppDefinition**
> AppDefinitionRepresentation importAppDefinition(fileopts)
Import a new app definition
Allows a zip file to be uploaded containing an app definition and any number of included models.<p>This is useful to bootstrap an environment (for users or continuous integration).<p>Before using any processes included in the import the app must be published and deployed.
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
let opts = {
'renewIdmEntries': renewIdmEntries_example // | Whether to renew user and group identifiers
};
appdefinitionsApi.importAppDefinition(fileopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**file** | **Blob**| file |
**renewIdmEntries** | **string**| Whether to renew user and group identifiers | [optional] [default to false]
### Return type
[**AppDefinitionRepresentation**](AppDefinitionRepresentation.md)
<a name="updateAppDefinition"></a>
# **importAppDefinition**
> updateAppDefinition importAppDefinition(modelIdfile)
Update the content of an existing app
Imports an app inside an existing app definition and creates a new version<p>Before using any new or updated processes included in the import the app must be (re-)published and deployed.
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
appdefinitionsApi.updateAppDefinition(modelIdfile).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**file** | **Blob**| file |
### Return type
[**AppDefinitionRepresentation**](AppDefinitionRepresentation.md)
<a name="publishAppDefinition"></a>
# **publishAppDefinition**
> AppDefinitionUpdateResultRepresentation publishAppDefinition(modelIdpublishModel)
Publish an app definition
Publishing an app definition makes it available for use. The application must not have any validation errors or an error will be returned.<p>Before an app definition can be used by other users, it must also be deployed for their use
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
appdefinitionsApi.publishAppDefinition(modelIdpublishModel).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**publishModel** | [**AppDefinitionPublishRepresentation**](AppDefinitionPublishRepresentation.md)| publishModel |
### Return type
[**AppDefinitionUpdateResultRepresentation**](AppDefinitionUpdateResultRepresentation.md)
<a name="updateAppDefinition"></a>
# **updateAppDefinition**
> AppDefinitionUpdateResultRepresentation updateAppDefinition(modelIdupdatedModel)
Update an app definition
### Example
```javascript
import AppdefinitionsApi from 'src/api/activiti-rest-api/docs/AppDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let appdefinitionsApi = new AppdefinitionsApi(this.alfrescoApi);
appdefinitionsApi.updateAppDefinition(modelIdupdatedModel).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| Application definition ID |
**updatedModel** | [**AppDefinitionSaveRepresentation**](AppDefinitionSaveRepresentation.md)| updatedModel |
### Return type
[**AppDefinitionUpdateResultRepresentation**](AppDefinitionUpdateResultRepresentation.md)

View File

@@ -0,0 +1,13 @@
# AppDeploymentRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**appDefinition** | [**AppDefinitionRepresentation**](AppDefinitionRepresentation.md) | | [optional] [default to null]
**created** | [**Date**](Date.md) | | [optional] [default to null]
**createdBy** | [**LightUserRepresentation**](LightUserRepresentation.md) | | [optional] [default to null]
**deploymentId** | **string** | | [optional] [default to null]
**dmnDeploymentId** | **number** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,18 @@
# AppModelDefinition
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**createdBy** | **number** | | [optional] [default to null]
**createdByFullName** | **string** | | [optional] [default to null]
**description** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**lastUpdated** | [**Date**](Date.md) | | [optional] [default to null]
**lastUpdatedBy** | **number** | | [optional] [default to null]
**lastUpdatedByFullName** | **string** | | [optional] [default to null]
**modelType** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**stencilSetId** | **number** | | [optional] [default to null]
**version** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# AssigneeIdentifierRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**assignee** | **string** | | [optional] [default to null]
**email** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# AuditCalculatedValueRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional] [default to null]
**value** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,10 @@
# AuditDecisionExpressionInfoRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **string** | | [optional] [default to null]
**value** | **any** | | [optional] [default to null]
**variable** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# AuditDecisionInfoRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**appliedRules** | [**AuditDecisionRuleInfoRepresentation[]**](AuditDecisionRuleInfoRepresentation.md) | | [optional] [default to null]
**calculatedValues** | [**AuditCalculatedValueRepresentation[]**](AuditCalculatedValueRepresentation.md) | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# AuditDecisionRuleInfoRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**expressions** | [**AuditDecisionExpressionInfoRepresentation[]**](AuditDecisionExpressionInfoRepresentation.md) | | [optional] [default to null]
**title** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,19 @@
# AuditLogEntryRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**activityId** | **string** | | [optional] [default to null]
**activityName** | **string** | | [optional] [default to null]
**activityType** | **string** | | [optional] [default to null]
**durationInMillis** | **number** | | [optional] [default to null]
**endTime** | **string** | | [optional] [default to null]
**formData** | [**AuditLogFormDataRepresentation[]**](AuditLogFormDataRepresentation.md) | | [optional] [default to null]
**index** | **number** | | [optional] [default to null]
**selectedOutcome** | **string** | | [optional] [default to null]
**startTime** | **string** | | [optional] [default to null]
**taskAssignee** | **string** | | [optional] [default to null]
**taskName** | **string** | | [optional] [default to null]
**type** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,10 @@
# AuditLogFormDataRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fieldId** | **string** | | [optional] [default to null]
**fieldName** | **string** | | [optional] [default to null]
**value** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,12 @@
# BoxContent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**folder** | **boolean** | | [optional] [default to null]
**id** | **string** | | [optional] [default to null]
**mimeType** | **string** | | [optional] [default to null]
**simpleType** | **string** | | [optional] [default to null]
**title** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,10 @@
# BoxUserAccountCredentialsRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**authenticationURL** | **string** | | [optional] [default to null]
**expireDate** | [**Date**](Date.md) | | [optional] [default to null]
**ownerEmail** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,14 @@
# BulkUserUpdateRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**accountType** | **string** | | [optional] [default to null]
**password** | **string** | | [optional] [default to null]
**primaryGroupId** | **number** | | [optional] [default to null]
**sendNotifications** | **boolean** | | [optional] [default to null]
**status** | **string** | | [optional] [default to null]
**tenantId** | **number** | | [optional] [default to null]
**users** | **number[]** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# ChangePasswordRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**newPassword** | **string** | | [optional] [default to null]
**oldPassword** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,8 @@
# ChecklistOrderRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**order** | **string[]** | | [optional] [default to null]

View File

@@ -0,0 +1,124 @@
# ChecklistsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**addSubtask**](ChecklistsApi.md#addSubtask) | **POST** /enterprise/tasks/{taskId}/checklist | Create a task checklist
[**getChecklist**](ChecklistsApi.md#getChecklist) | **GET** /enterprise/tasks/{taskId}/checklist | Get checklist for a task
[**orderChecklist**](ChecklistsApi.md#orderChecklist) | **PUT** /enterprise/tasks/{taskId}/checklist | Change the order of items on a checklist
<a name="addSubtask"></a>
# **addSubtask**
> TaskRepresentation addSubtask(taskIdtaskRepresentation)
Create a task checklist
### Example
```javascript
import ChecklistsApi from 'ChecklistsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let checklistsApi = new ChecklistsApi(this.alfrescoApi);
checklistsApi.addSubtask(taskIdtaskRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**taskId** | **string**| taskId |
**taskRepresentation** | [**TaskRepresentation**](TaskRepresentation.md)| taskRepresentation |
### Return type
[**TaskRepresentation**](TaskRepresentation.md)
<a name="getChecklist"></a>
# **getChecklist**
> ResultListDataRepresentationTaskRepresentation getChecklist(taskId)
Get checklist for a task
### Example
```javascript
import ChecklistsApi from 'ChecklistsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let checklistsApi = new ChecklistsApi(this.alfrescoApi);
checklistsApi.getChecklist(taskId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**taskId** | **string**| taskId |
### Return type
[**ResultListDataRepresentationTaskRepresentation**](ResultListDataRepresentationTaskRepresentation.md)
<a name="orderChecklist"></a>
# **orderChecklist**
> orderChecklist(taskIdorderRepresentation)
Change the order of items on a checklist
### Example
```javascript
import ChecklistsApi from 'ChecklistsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let checklistsApi = new ChecklistsApi(this.alfrescoApi);
checklistsApi.orderChecklist(taskIdorderRepresentation).then(() => {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**taskId** | **string**| taskId |
**orderRepresentation** | [**ChecklistOrderRepresentation**](ChecklistOrderRepresentation.md)| orderRepresentation |
### Return type
null (empty response body)

View File

@@ -0,0 +1,9 @@
# CommentAuditInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**author** | **string** | | [optional] [default to null]
**message** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,11 @@
# CommentRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | [**Date**](Date.md) | | [optional] [default to null]
**createdBy** | [**LightUserRepresentation**](LightUserRepresentation.md) | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**message** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,170 @@
# CommentsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**addProcessInstanceComment**](CommentsApi.md#addProcessInstanceComment) | **POST** /enterprise/process-instances/{processInstanceId}/comments | Add a comment to a process instance
[**addTaskComment**](CommentsApi.md#addTaskComment) | **POST** /enterprise/tasks/{taskId}/comments | Add a comment to a task
[**getProcessInstanceComments**](CommentsApi.md#getProcessInstanceComments) | **GET** /enterprise/process-instances/{processInstanceId}/comments | Get comments for a process
[**getTaskComments**](CommentsApi.md#getTaskComments) | **GET** /enterprise/tasks/{taskId}/comments | Get comments for a task
<a name="addProcessInstanceComment"></a>
# **addProcessInstanceComment**
> CommentRepresentation addProcessInstanceComment(commentRequestprocessInstanceId)
Add a comment to a process instance
### Example
```javascript
import CommentsApi from 'CommentsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let commentsApi = new CommentsApi(this.alfrescoApi);
commentsApi.addProcessInstanceComment(commentRequestprocessInstanceId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**commentRequest** | [**CommentRepresentation**](CommentRepresentation.md)| commentRequest |
**processInstanceId** | **string**| processInstanceId |
### Return type
[**CommentRepresentation**](CommentRepresentation.md)
<a name="addTaskComment"></a>
# **addTaskComment**
> CommentRepresentation addTaskComment(commentRequesttaskId)
Add a comment to a task
### Example
```javascript
import CommentsApi from 'CommentsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let commentsApi = new CommentsApi(this.alfrescoApi);
commentsApi.addTaskComment(commentRequesttaskId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**commentRequest** | [**CommentRepresentation**](CommentRepresentation.md)| commentRequest |
**taskId** | **string**| taskId |
### Return type
[**CommentRepresentation**](CommentRepresentation.md)
<a name="getProcessInstanceComments"></a>
# **getProcessInstanceComments**
> ResultListDataRepresentationCommentRepresentation getProcessInstanceComments(processInstanceIdopts)
Get comments for a process
### Example
```javascript
import CommentsApi from 'CommentsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let commentsApi = new CommentsApi(this.alfrescoApi);
let opts = {
'latestFirst': true // | latestFirst
};
commentsApi.getProcessInstanceComments(processInstanceIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processInstanceId** | **string**| processInstanceId |
**latestFirst** | **boolean**| latestFirst | [optional]
### Return type
[**ResultListDataRepresentationCommentRepresentation**](ResultListDataRepresentationCommentRepresentation.md)
<a name="getTaskComments"></a>
# **getTaskComments**
> ResultListDataRepresentationCommentRepresentation getTaskComments(taskIdopts)
Get comments for a task
### Example
```javascript
import CommentsApi from 'CommentsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let commentsApi = new CommentsApi(this.alfrescoApi);
let opts = {
'latestFirst': true // | latestFirst
};
commentsApi.getTaskComments(taskIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**taskId** | **string**| taskId |
**latestFirst** | **boolean**| latestFirst | [optional]
### Return type
[**ResultListDataRepresentationCommentRepresentation**](ResultListDataRepresentationCommentRepresentation.md)

View File

@@ -0,0 +1,9 @@
# CompleteFormRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**outcome** | **string** | | [optional] [default to null]
**values** | **any** | | [optional] [default to null]

View File

@@ -0,0 +1,16 @@
# ConditionRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**leftFormFieldId** | **string** | | [optional] [default to null]
**leftRestResponseId** | **string** | | [optional] [default to null]
**nextCondition** | [**ConditionRepresentation**](ConditionRepresentation.md) | | [optional] [default to null]
**nextConditionOperator** | **string** | | [optional] [default to null]
**operator** | **string** | | [optional] [default to null]
**rightFormFieldId** | **string** | | [optional] [default to null]
**rightRestResponseId** | **string** | | [optional] [default to null]
**rightType** | **string** | | [optional] [default to null]
**rightValue** | **any** | | [optional] [default to null]

View File

@@ -0,0 +1,534 @@
# ContentApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createRelatedContentOnProcessInstance**](ContentApi.md#createRelatedContentOnProcessInstance) | **POST** /enterprise/process-instances/{processInstanceId}/content | Attach existing content to a process instance
[**createRelatedContentOnProcessInstance**](ContentApi.md#createRelatedContentOnProcessInstance) | **POST** /enterprise/process-instances/{processInstanceId}/raw-content | Upload content and attach to a process instance
[**createRelatedContentOnTask**](ContentApi.md#createRelatedContentOnTask) | **POST** /enterprise/tasks/{taskId}/content | Attach existing content to a task
[**createRelatedContentOnTask**](ContentApi.md#createRelatedContentOnTask) | **POST** /enterprise/tasks/{taskId}/raw-content | Upload content and attach to a task
[**createTemporaryRawRelatedContent**](ContentApi.md#createTemporaryRawRelatedContent) | **POST** /enterprise/content/raw | Upload content and create a local representation
[**createTemporaryRelatedContent**](ContentApi.md#createTemporaryRelatedContent) | **POST** /enterprise/content | Create a local representation of content from a remote repository
[**deleteContent**](ContentApi.md#deleteContent) | **DELETE** /enterprise/content/{contentId} | Remove a local content representation
[**getContent**](ContentApi.md#getContent) | **GET** /enterprise/content/{contentId} | Get a local content representation
[**getRawContent**](ContentApi.md#getRawContent) | **GET** /enterprise/content/{contentId}/rendition/{renditionType} | Stream content rendition
[**getRawContent**](ContentApi.md#getRawContent) | **GET** /enterprise/content/{contentId}/raw | Stream content from a local content representation
[**getRelatedContentForProcessInstance**](ContentApi.md#getRelatedContentForProcessInstance) | **GET** /enterprise/process-instances/{processInstanceId}/content | List content attached to a process instance
[**getRelatedContentForTask**](ContentApi.md#getRelatedContentForTask) | **GET** /enterprise/tasks/{taskId}/content | List content attached to a task
[**getProcessesAndTasksOnContent**](ContentApi.md#getProcessesAndTasksOnContent) | **GET** enterprise/content/document-runtime | Lists processes and tasks on workflow started with provided document
<a name="createRelatedContentOnProcessInstance"></a>
# **createRelatedContentOnProcessInstance**
> RelatedContentRepresentation createRelatedContentOnProcessInstance(processInstanceIdrelatedContentopts)
Attach existing content to a process instance
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
let opts = {
'isRelatedContent': true // | isRelatedContent
};
contentApi.createRelatedContentOnProcessInstance(processInstanceIdrelatedContentopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processInstanceId** | **string**| processInstanceId |
**relatedContent** | [**RelatedContentRepresentation**](RelatedContentRepresentation.md)| relatedContent |
**isRelatedContent** | **boolean**| isRelatedContent | [optional]
### Return type
[**RelatedContentRepresentation**](RelatedContentRepresentation.md)
<a name="createRelatedContentOnProcessInstance"></a>
# **createRelatedContentOnProcessInstance**
> RelatedContentRepresentation createRelatedContentOnProcessInstance(processInstanceIdfileopts)
Upload content and attach to a process instance
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
let opts = {
'isRelatedContent': true // | isRelatedContent
};
contentApi.createRelatedContentOnProcessInstance(processInstanceIdfileopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processInstanceId** | **string**| processInstanceId |
**file** | **Blob**| file |
**isRelatedContent** | **boolean**| isRelatedContent | [optional]
### Return type
[**RelatedContentRepresentation**](RelatedContentRepresentation.md)
<a name="createRelatedContentOnTask"></a>
# **createRelatedContentOnTask**
> RelatedContentRepresentation createRelatedContentOnTask(taskIdrelatedContentopts)
Attach existing content to a task
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
let opts = {
'isRelatedContent': true // | isRelatedContent
};
contentApi.createRelatedContentOnTask(taskIdrelatedContentopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**taskId** | **string**| taskId |
**relatedContent** | [**RelatedContentRepresentation**](RelatedContentRepresentation.md)| relatedContent |
**isRelatedContent** | **boolean**| isRelatedContent | [optional]
### Return type
[**RelatedContentRepresentation**](RelatedContentRepresentation.md)
<a name="createRelatedContentOnTask"></a>
# **createRelatedContentOnTask**
> RelatedContentRepresentation createRelatedContentOnTask(taskIdfileopts)
Upload content and attach to a task
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
let opts = {
'isRelatedContent': true // | isRelatedContent
};
contentApi.createRelatedContentOnTask(taskIdfileopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**taskId** | **string**| taskId |
**file** | **Blob**| file |
**isRelatedContent** | **boolean**| isRelatedContent | [optional]
### Return type
[**RelatedContentRepresentation**](RelatedContentRepresentation.md)
<a name="createTemporaryRawRelatedContent"></a>
# **createTemporaryRawRelatedContent**
> RelatedContentRepresentation createTemporaryRawRelatedContent(file)
Upload content and create a local representation
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
contentApi.createTemporaryRawRelatedContent(file).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**file** | **Blob**| file |
### Return type
[**RelatedContentRepresentation**](RelatedContentRepresentation.md)
<a name="createTemporaryRelatedContent"></a>
# **createTemporaryRelatedContent**
> RelatedContentRepresentation createTemporaryRelatedContent(relatedContent)
Create a local representation of content from a remote repository
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
contentApi.createTemporaryRelatedContent(relatedContent).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**relatedContent** | [**RelatedContentRepresentation**](RelatedContentRepresentation.md)| relatedContent |
### Return type
[**RelatedContentRepresentation**](RelatedContentRepresentation.md)
<a name="deleteContent"></a>
# **deleteContent**
> deleteContent(contentId)
Remove a local content representation
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
contentApi.deleteContent(contentId).then(() => {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contentId** | **number**| contentId |
### Return type
null (empty response body)
<a name="getContent"></a>
# **getContent**
> RelatedContentRepresentation getContent(contentId)
Get a local content representation
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
contentApi.getContent(contentId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contentId** | **number**| contentId |
### Return type
[**RelatedContentRepresentation**](RelatedContentRepresentation.md)
<a name="getRawContent"></a>
# **getRawContent**
> getRawContent(contentIdrenditionType)
Stream content rendition
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
contentApi.getRawContent(contentIdrenditionType).then(() => {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contentId** | **number**| contentId |
**renditionType** | **string**| renditionType |
### Return type
null (empty response body)
<a name="getRawContent"></a>
# **getRawContent**
> getRawContent(contentId)
Stream content from a local content representation
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
contentApi.getRawContent(contentId).then(() => {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**contentId** | **number**| contentId |
### Return type
null (empty response body)
<a name="getRelatedContentForProcessInstance"></a>
# **getRelatedContentForProcessInstance**
> ResultListDataRepresentationRelatedContentRepresentation getRelatedContentForProcessInstance(processInstanceIdopts)
List content attached to a process instance
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
let opts = {
'isRelatedContent': true // | isRelatedContent
};
contentApi.getRelatedContentForProcessInstance(processInstanceIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processInstanceId** | **string**| processInstanceId |
**isRelatedContent** | **boolean**| isRelatedContent | [optional]
### Return type
[**ResultListDataRepresentationRelatedContentRepresentation**](ResultListDataRepresentationRelatedContentRepresentation.md)
<a name="getRelatedContentForTask"></a>
# **getRelatedContentForTask**
> ResultListDataRepresentationRelatedContentRepresentation getRelatedContentForTask(taskIdopts)
List content attached to a task
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let contentApi = new ContentApi(this.alfrescoApi);
let opts = {
'isRelatedContent': true // | isRelatedContent
};
contentApi.getRelatedContentForTask(taskIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**taskId** | **string**| taskId |
**isRelatedContent** | **boolean**| isRelatedContent | [optional]
### Return type
[**ResultListDataRepresentationRelatedContentRepresentation**](ResultListDataRepresentationRelatedContentRepresentation.md)
<a name="getProcessesAndTasksOnContent"></a>
# **getProcessesAndTasksOnContent**
> ResultListDataRepresentationRelatedProcessTask getProcessesAndTasksOnContent(sourceId, source, size, page)
Lists processes and tasks on workflow started with provided document
### Example
```javascript
import ContentApi from 'ContentApi';
import { AlfrescoApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi();
alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
const contentApi = new ContentApi(alfrescoApi);
contentApi.getProcessesAndTasksOnContent('sourceId', 'source').then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **sourceId** | **string** | id of the document that workflow or task was started with | |
| **source** | **string** | source of the document that workflow or task was started with | |
| **sourceId** | **number** | size of the entries to get | optional param |
| **sourceId** | **number** | page number | optional param |
### Return type
[**ResultListDataRepresentationRelatedProcessTask**](ResultListDataRepresentationRelatedProcessTask.md)

View File

@@ -0,0 +1,14 @@
# CreateProcessInstanceRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**businessKey** | **string** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**outcome** | **string** | | [optional] [default to null]
**processDefinitionId** | **string** | | [optional] [default to null]
**processDefinitionKey** | **string** | | [optional] [default to null]
**values** | **any** | | [optional] [default to null]
**variables** | [**RestVariable[]**](RestVariable.md) | | [optional] [default to null]

View File

@@ -0,0 +1,12 @@
# CreateTenantRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**active** | **boolean** | | [optional] [default to null]
**configuration** | **string** | | [optional] [default to null]
**domain** | **string** | | [optional] [default to null]
**maxUsers** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,75 @@
# DataSourcesApi
All URIs are relative to */activiti-app/api*
| Method | HTTP request | Description |
|-----------------------------------|-----------------------------------------|------------------|
| [getDataSources](#getDataSources) | **GET** /enterprise/editor/data-sources | Get data sources |
# getDataSources
Get data sources
**Parameters**
| Name | Type |
|----------|--------|
| tenantId | number |
**Return type**: [ResultListDataRepresentationDataSourceRepresentation](#ResultListDataRepresentationDataSourceRepresentation)
**Example**
```javascript
import { AlfrescoApi, DataSourcesApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const dataSourcesApi = new DataSourcesApi(alfrescoApi);
const opts = {
tenantId: 789
};
datasourcesApi.getDataSources(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# Models
## ResultListDataRepresentationDataSourceRepresentation
**Properties**
| Name | Type |
|-------|---------------------------------------------------------|
| data | [DataSourceRepresentation[]](#DataSourceRepresentation) |
| size | number |
| start | number |
| total | number |
## DataSourceRepresentation
**Properties**
| Name | Type |
|----------|-------------------------------------------------------------------|
| config | [DataSourceConfigRepresentation](#DataSourceConfigRepresentation) |
| id | number |
| name | string |
| tenantId | number |
## DataSourceConfigRepresentation
**Properties**
| Name | Type |
|-------------|--------|
| driverClass | string |
| jdbcUrl | string |
| password | string |
| username | string |

View File

@@ -0,0 +1,21 @@
# DecisionAuditRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**activityId** | **string** | | [optional] [default to null]
**activityName** | **string** | | [optional] [default to null]
**auditTrailJson** | **string** | | [optional] [default to null]
**created** | [**Date**](Date.md) | | [optional] [default to null]
**decisionExecutionFailed** | **boolean** | | [optional] [default to null]
**decisionKey** | **string** | | [optional] [default to null]
**decisionModelJson** | **string** | | [optional] [default to null]
**decisionName** | **string** | | [optional] [default to null]
**dmnDeploymentId** | **number** | | [optional] [default to null]
**executionId** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**processDefinitionId** | **string** | | [optional] [default to null]
**processInstanceId** | **string** | | [optional] [default to null]
**renderedVariables** | **any** | | [optional] [default to null]

View File

@@ -0,0 +1,97 @@
# DecisionAuditsApi
All URIs are relative to */activiti-app/api*
| Method | HTTP request | Description |
|-----------------------------------|-----------------------------------------------------|-----------------------------------|
| [getAuditTrail](#getAuditTrail) | **GET** /enterprise/decisions/audits/{auditTrailId} | Get an audit trail |
| [getAuditTrails](#getAuditTrails) | **GET** /enterprise/decisions/audits | Query decision table audit trails |
# getAuditTrail
Get an audit trail
**Parameters**
| Name | Type |
|------------------|--------|
| **auditTrailId** | number |
**Return type**: [DecisionAuditRepresentation](#DecisionAuditRepresentation)
**Example**
```javascript
import { AlfrescoApi, DecisionAuditsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const decisionAuditsApi = new DecisionAuditsApi(this.alfrescoApi);
const auditTrailId = 0;
decisionauditsApi.getAuditTrail(auditTrailId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getAuditTrails
Query decision table audit trails
**Parameters**
| Name | Type |
|---------------------|--------|
| **decisionKey** | string |
| **dmnDeploymentId** | number |
**Return type**: [ResultListDataRepresentationDecisionAuditRepresentation](#ResultListDataRepresentationDecisionAuditRepresentation)
**Example**
```javascript
import { AlfrescoApi, DecisionAuditsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const decisionAuditsApi = new DecisionAuditsApi(this.alfrescoApi);
const dmnDeploymentId = 0;
decisionauditsApi.getAuditTrails(`<decisionKey>`, dmnDeploymentId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# Models
## ResultListDataRepresentationDecisionAuditRepresentation
**Properties**
| Name | Type |
|-------|---------------------------------------------------------------|
| data | [DecisionAuditRepresentation[]](#DecisionAuditRepresentation) |
| size | number |
| start | number |
| total | number |
## DecisionAuditRepresentation
**Properties**
| Name | Type |
|-------------------------|---------|
| activityId | string |
| activityName | string |
| auditTrailJson | string |
| created | Date |
| decisionExecutionFailed | boolean |
| decisionKey | string |
| decisionModelJson | string |
| decisionName | string |
| dmnDeploymentId | number |
| executionId | string |
| id | number |
| processDefinitionId | string |
| processInstanceId | string |
| renderedVariables | any |

View File

@@ -0,0 +1,136 @@
# DecisionTablesApi
All URIs are relative to */activiti-app/api*
| Method | HTTP request | Description |
|-----------------------------------------------------------|----------------------------------------------------------------------------|-------------------------------------|
| [getDecisionTableEditorJson](#getDecisionTableEditorJson) | **GET** /enterprise/decisions/decision-tables/{decisionTableId}/editorJson | Get definition for a decision table |
| [getDecisionTable](#getDecisionTable) | **GET** /enterprise/decisions/decision-tables/{decisionTableId} | Get a decision table |
| [getDecisionTables](#getDecisionTables) | **GET** /enterprise/decisions/decision-tables | Query decision tables |
# getDecisionTableEditorJson
Get definition for a decision table
**Parameters**
| Name | Type |
|---------------------|--------|
| **decisionTableId** | number |
**Return type**: [JsonNode](#JsonNode)
**Example**
```javascript
import { AlfrescoApi, DecisionTablesApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const decisionTablesApi = new DecisionTablesApi(alfrescoApi);
const decisionTableId = 0;
decisionTablesApi.getDecisionTableEditorJson(decisionTableId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getDecisionTable
Get a decision table
**Parameters**
| Name | Type |
|---------------------|--------|
| **decisionTableId** | number |
**Return type**: [RuntimeDecisionTableRepresentation](RuntimeDecisionTableRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, DecisionTablesApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const decisionTablesApi = new DecisionTablesApi(alfrescoApi);
const decisionTableId = 0;
decisionTablesApi.getDecisionTable(decisionTableId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# getDecisionTables
Query decision tables
**Parameters**
| Name | Type |
|--------------|--------|
| nameLike | string |
| keyLike | string |
| tenantIdLike | string |
| deploymentId | number |
| sort | string |
| order | string |
| start | number |
| size | number |
**Return type**: [ResultListDataRepresentationRuntimeDecisionTableRepresentation](ResultListDataRepresentationRuntimeDecisionTableRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, DecisionTablesApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*..*/);
const decisionTablesApi = new DecisionTablesApi(alfrescoApi);
const opts = {};
decisionTablesApi.getDecisionTables(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# Models
## JsonNode
**Properties**
| Name | Type |
|---------------------|---------|
| array | boolean |
| bigDecimal | boolean |
| bigInteger | boolean |
| binary | boolean |
| boolean | boolean |
| containerNode | boolean |
| double | boolean |
| float | boolean |
| floatingPointNumber | boolean |
| int | boolean |
| integralNumber | boolean |
| long | boolean |
| missingNode | boolean |
| nodeType | string |
| null | boolean |
| number | boolean |
| object | boolean |
| pojo | boolean |
| short | boolean |
| textual | boolean |
| valueNode | boolean |
### JsonNode.NodeTypeEnum
* `ARRAY` (value: `'ARRAY'`)
* `BINARY` (value: `'BINARY'`)
* `BOOLEAN` (value: `'BOOLEAN'`)
* `MISSING` (value: `'MISSING'`)
* `NULL` (value: `'NULL'`)
* `NUMBER` (value: `'NUMBER'`)
* `OBJECT` (value: `'OBJECT'`)
* `POJO` (value: `'POJO'`)
* `STRING` (value: `'STRING'`)

View File

@@ -0,0 +1,19 @@
# DecisionTaskRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**activityId** | **string** | | [optional] [default to null]
**activityName** | **string** | | [optional] [default to null]
**decisionExecutionEnded** | [**Date**](Date.md) | | [optional] [default to null]
**decisionExecutionFailed** | **boolean** | | [optional] [default to null]
**decisionKey** | **string** | | [optional] [default to null]
**decisionName** | **string** | | [optional] [default to null]
**dmnDeploymentId** | **number** | | [optional] [default to null]
**executionId** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**processDefinitionId** | **string** | | [optional] [default to null]
**processDefinitionKey** | **string** | | [optional] [default to null]
**processInstanceId** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,17 @@
# EndpointConfigurationRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**basicAuthId** | **number** | | [optional] [default to null]
**basicAuthName** | **string** | | [optional] [default to null]
**host** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**path** | **string** | | [optional] [default to null]
**port** | **string** | | [optional] [default to null]
**protocol** | **string** | | [optional] [default to null]
**requestHeaders** | [**EndpointRequestHeaderRepresentation[]**](EndpointRequestHeaderRepresentation.md) | | [optional] [default to null]
**tenantId** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# EndpointRequestHeaderRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional] [default to null]
**value** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,80 @@
# EndpointsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getEndpointConfiguration**](EndpointsApi.md#getEndpointConfiguration) | **GET** /enterprise/editor/endpoints/{endpointConfigurationId} | Get an endpoint configuration
[**getEndpointConfigurations**](EndpointsApi.md#getEndpointConfigurations) | **GET** /enterprise/editor/endpoints | List endpoint configurations
<a name="getEndpointConfiguration"></a>
# **getEndpointConfiguration**
> EndpointConfigurationRepresentation getEndpointConfiguration(endpointConfigurationId)
Get an endpoint configuration
### Example
```javascript
import EndpointsApi from 'EndpointsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let endpointsApi = new EndpointsApi(this.alfrescoApi);
endpointsApi.getEndpointConfiguration(endpointConfigurationId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**endpointConfigurationId** | **number**| endpointConfigurationId |
### Return type
[**EndpointConfigurationRepresentation**](EndpointConfigurationRepresentation.md)
<a name="getEndpointConfigurations"></a>
# **getEndpointConfigurations**
> EndpointConfigurationRepresentation getEndpointConfigurations()
List endpoint configurations
### Example
```javascript
import EndpointsApi from 'EndpointsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let endpointsApi = new EndpointsApi(this.alfrescoApi);
endpointsApi.getEndpointConfigurations().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**EndpointConfigurationRepresentation**](EndpointConfigurationRepresentation.md)

View File

@@ -0,0 +1,9 @@
# EntityAttributeScopeRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional] [default to null]
**type** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,11 @@
# EntityVariableScopeRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**EntityAttributeScopeRepresentation[]**](EntityAttributeScopeRepresentation.md) | | [optional] [default to null]
**entityName** | **string** | | [optional] [default to null]
**mappedDataModel** | **number** | | [optional] [default to null]
**mappedVariableName** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# FieldValueInfo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **string** | | [optional] [default to null]
**value** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,22 @@
# File
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**absolute** | **boolean** | | [optional] [default to null]
**absoluteFile** | **Blob** | | [optional] [default to null]
**absolutePath** | **string** | | [optional] [default to null]
**canonicalFile** | **Blob** | | [optional] [default to null]
**canonicalPath** | **string** | | [optional] [default to null]
**directory** | **boolean** | | [optional] [default to null]
**file** | **boolean** | | [optional] [default to null]
**freeSpace** | **number** | | [optional] [default to null]
**hidden** | **boolean** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**parent** | **string** | | [optional] [default to null]
**parentFile** | **Blob** | | [optional] [default to null]
**path** | **string** | | [optional] [default to null]
**totalSpace** | **number** | | [optional] [default to null]
**usableSpace** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,29 @@
# FormDefinitionRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**className** | **string** | | [optional] [default to null]
**customFieldTemplates** | **{ [key: string]: string; }** | | [optional] [default to null]
**customFieldsValueInfo** | [**{ [key: string]: FieldValueInfo; }**](FieldValueInfo.md) | | [optional] [default to null]
**fields** | [**FormFieldRepresentation[]**](FormFieldRepresentation.md) | | [optional] [default to null]
**globalDateFormat** | **string** | | [optional] [default to null]
**gridsterForm** | **boolean** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**javascriptEvents** | [**FormJavascriptEventRepresentation[]**](FormJavascriptEventRepresentation.md) | | [optional] [default to null]
**metadata** | **{ [key: string]: string; }** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**outcomeTarget** | **string** | | [optional] [default to null]
**outcomes** | [**FormOutcomeRepresentation[]**](FormOutcomeRepresentation.md) | | [optional] [default to null]
**processDefinitionId** | **string** | | [optional] [default to null]
**processDefinitionKey** | **string** | | [optional] [default to null]
**processDefinitionName** | **string** | | [optional] [default to null]
**selectedOutcome** | **string** | | [optional] [default to null]
**style** | **string** | | [optional] [default to null]
**tabs** | [**FormTabRepresentation[]**](FormTabRepresentation.md) | | [optional] [default to null]
**taskDefinitionKey** | **string** | | [optional] [default to null]
**taskId** | **string** | | [optional] [default to null]
**taskName** | **string** | | [optional] [default to null]
**variables** | [**FormVariableRepresentation[]**](FormVariableRepresentation.md) | | [optional] [default to null]

View File

@@ -0,0 +1,38 @@
# FormFieldRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**className** | **string** | | [optional] [default to null]
**col** | **number** | | [optional] [default to null]
**colspan** | **number** | | [optional] [default to null]
**dateDisplayFormat** | **string** | | [optional] [default to null]
**hasEmptyValue** | **boolean** | | [optional] [default to null]
**id** | **string** | | [optional] [default to null]
**layout** | [**LayoutRepresentation**](LayoutRepresentation.md) | | [optional] [default to null]
**maxLength** | **number** | | [optional] [default to null]
**maxValue** | **string** | | [optional] [default to null]
**minLength** | **number** | | [optional] [default to null]
**minValue** | **string** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**optionType** | **string** | | [optional] [default to null]
**options** | [**OptionRepresentation[]**](OptionRepresentation.md) | | [optional] [default to null]
**overrideId** | **boolean** | | [optional] [default to null]
**params** | **any** | | [optional] [default to null]
**placeholder** | **string** | | [optional] [default to null]
**readOnly** | **boolean** | | [optional] [default to null]
**regexPattern** | **string** | | [optional] [default to null]
**required** | **boolean** | | [optional] [default to null]
**restIdProperty** | **string** | | [optional] [default to null]
**restLabelProperty** | **string** | | [optional] [default to null]
**restResponsePath** | **string** | | [optional] [default to null]
**restUrl** | **string** | | [optional] [default to null]
**row** | **number** | | [optional] [default to null]
**sizeX** | **number** | | [optional] [default to null]
**sizeY** | **number** | | [optional] [default to null]
**tab** | **string** | | [optional] [default to null]
**type** | **string** | | [optional] [default to null]
**value** | **any** | | [optional] [default to null]
**visibilityCondition** | [**ConditionRepresentation**](ConditionRepresentation.md) | | [optional] [default to null]

View File

@@ -0,0 +1,8 @@
# FormIdentifierRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**formId** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# FormJavascriptEventRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event** | **string** | | [optional] [default to null]
**javascriptLogic** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,223 @@
# Form Models Api
All URIs are relative to */activiti-app/api*
| Method | HTTP request | Description |
|-----------------------------------------|-------------------------------------------------------------------------|-----------------------------|
| [getFormEditorJson](#getFormEditorJson) | **GET** /enterprise/forms/{formId}/editorJson | Get form content |
| [getFormHistory](#getFormHistory) | **GET** /enterprise/editor/form-models/{formId}/history/{formHistoryId} | Get form history |
| [getForm](#getForm) | **GET** /enterprise/editor/form-models/{formId} | Get a form model |
| [getForm](#getForm) | **GET** /enterprise/forms/{formId} | Get a form |
| [getForms](#getForms) | **GET** /enterprise/editor/form-models/values | Get forms |
| [getForms](#getForms) | **GET** /enterprise/editor/form-models | List form models |
| [getForms](#getForms) | **GET** /enterprise/forms | Query forms |
| [saveForm](#saveForm) | **PUT** /enterprise/editor/form-models/{formId} | Update form model content |
| [validateModel](#validateModel) | **PUT** /enterprise/editor/form-models/{formId}/validate | Validate form model content |
# **getFormEditorJson**
Get form content
**Parameters**
| Name | Type | Description |
|------------|------------|-------------|
| **formId** | **number** | formId |
**Return type**: [FormDefinitionRepresentation](FormDefinitionRepresentation.md)
**Example**
```javascript
import {AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*...*/);
const formModelsApi = new FormModelsApi(alfrescoApi);
formModelsApi.getFormEditorJson(formId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# **getFormHistory**
Get form history
**Parameters**
| Name | Type | Description |
|-------------------|--------|---------------|
| **formId** | number | formId |
| **formHistoryId** | number | formHistoryId |
**Return type**: [FormRepresentation](FormRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, FormModelsApi} from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*...*/);
const formModelsApi = new FormModelsApi(alfrescoApi);
formModelsApi.getFormHistory(formIdformHistoryId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# **getForm**
Get a form model
**Parameters**
| Name | Type | Description |
|------------|--------|-------------|
| **formId** | number | formId |
**Return type**: [FormRepresentation](FormRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, FormModelsApi} from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*...*/);
const formModelsApi = new FormModelsApi(alfrescoApi);
formModelsApi.getForm(formId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# **getForms**
Get forms
**Parameters**
| Name | Type | Description |
|------------|--------|-------------|
| **formId** | string | formId |
**Return type**: [**FormRepresentation**](FormRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*...*/);
const formModelsApi = new FormModelsApi(alfrescoApi);
formModelsApi.getForms(formId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# **getForms**
List form models
**Return type**: [ResultListDataRepresentationFormRepresentation](ResultListDataRepresentationFormRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*...*/);
const formModelsApi = new FormModelsApi(alfrescoApi);
formModelsApi.getForms().then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# **getForms**
Query forms
**Parameters**
| Name | Type | Description |
|----------|--------|-------------|
| nameLike | string | nameLike |
| appId | number | appId |
| tenantId | number | tenantId |
| start | number | start |
| sort | string | sort |
| order | string | order |
| size | number | size |
**Return type**: [ResultListDataRepresentationRuntimeFormRepresentation](ResultListDataRepresentationRuntimeFormRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*...*/);
const formModelsApi = new FormModelsApi(alfrescoApi);
const opts = {/*...*/};
formModelsApi.getForms(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# **saveForm**
Update form model content
**Parameters**
| Name | Type | Description |
|------------------------|-----------------------------------------------------|--------------------------|
| **formId** | number | ID of the form to update |
| **saveRepresentation** | [FormSaveRepresentation](FormSaveRepresentation.md) | saveRepresentation |
**Return type**: [FormRepresentation](FormRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*...*/);
const formModelsApi = new FormModelsApi(alfrescoApi);
formModelsApi.saveForm(formIdsaveRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```
# **validateModel**
Validate form model content
The model content to be validated must be specified in the POST body
**Parameters**
| Name | Type | Description |
|------------------------|-----------------------------------------------------|--------------------|
| **formId** | number | formId |
| **saveRepresentation** | [FormSaveRepresentation](FormSaveRepresentation.md) | saveRepresentation |
**Return type**: [ValidationErrorRepresentation](ValidationErrorRepresentation.md)
**Example**
```javascript
import { AlfrescoApi, FormModelsApi } from '@alfresco/js-api';
const alfrescoApi = new AlfrescoApi(/*...*/);
const formModelsApi = new FormModelsApi(alfrescoApi);
const payload = {/*...*/};
formModelsApi.validateModel(payload).then((data) => {
console.log('API called successfully. Returned data: ' + data);
});
```

View File

@@ -0,0 +1,9 @@
# FormOutcomeRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,17 @@
# FormRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **string** | | [optional] [default to null]
**formDefinition** | [**FormDefinitionRepresentation**](FormDefinitionRepresentation.md) | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**lastUpdated** | [**Date**](Date.md) | | [optional] [default to null]
**lastUpdatedBy** | **number** | | [optional] [default to null]
**lastUpdatedByFullName** | **string** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**referenceId** | **number** | | [optional] [default to null]
**stencilSetId** | **number** | | [optional] [default to null]
**version** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,13 @@
# FormSaveRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **string** | | [optional] [default to null]
**formImageBase64** | **string** | | [optional] [default to null]
**formRepresentation** | [**FormRepresentation**](FormRepresentation.md) | | [optional] [default to null]
**newVersion** | **boolean** | | [optional] [default to null]
**processScopeIdentifiers** | [**ProcessScopeIdentifierRepresentation[]**](ProcessScopeIdentifierRepresentation.md) | | [optional] [default to null]
**reusable** | **boolean** | | [optional] [default to null]

View File

@@ -0,0 +1,13 @@
# FormScopeRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **string** | | [optional] [default to null]
**fieldVariables** | [**FormFieldRepresentation[]**](FormFieldRepresentation.md) | | [optional] [default to null]
**fields** | [**FormFieldRepresentation[]**](FormFieldRepresentation.md) | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**outcomes** | [**FormOutcomeRepresentation[]**](FormOutcomeRepresentation.md) | | [optional] [default to null]

View File

@@ -0,0 +1,10 @@
# FormTabRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional] [default to null]
**title** | **string** | | [optional] [default to null]
**visibilityCondition** | [**ConditionRepresentation**](ConditionRepresentation.md) | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# FormValueRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,10 @@
# FormVariableRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | | [optional] [default to null]
**type** | **string** | | [optional] [default to null]
**value** | **any** | | [optional] [default to null]

View File

@@ -0,0 +1,8 @@
# GlobalDateFormatRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**globalDateFormat** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,12 @@
# GoogleDriveContent
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**folder** | **boolean** | | [optional] [default to null]
**id** | **string** | | [optional] [default to null]
**mimeType** | **string** | | [optional] [default to null]
**simpleType** | **string** | | [optional] [default to null]
**title** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# GroupCapabilityRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,20 @@
# GroupRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**capabilities** | [**GroupCapabilityRepresentation[]**](GroupCapabilityRepresentation.md) | | [optional] [default to null]
**externalId** | **string** | | [optional] [default to null]
**groups** | [**GroupRepresentation[]**](GroupRepresentation.md) | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**lastSyncTimeStamp** | [**Date**](Date.md) | | [optional] [default to null]
**manager** | [**UserRepresentation**](UserRepresentation.md) | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**parentGroupId** | **number** | | [optional] [default to null]
**status** | **string** | | [optional] [default to null]
**tenantId** | **number** | | [optional] [default to null]
**type** | **number** | | [optional] [default to null]
**userCount** | **number** | | [optional] [default to null]
**users** | [**UserRepresentation[]**](UserRepresentation.md) | | [optional] [default to null]

View File

@@ -0,0 +1,95 @@
# GroupsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getGroups**](GroupsApi.md#getGroups) | **GET** /enterprise/groups | Query groups
[**getUsersForGroup**](GroupsApi.md#getUsersForGroup) | **GET** /enterprise/groups/{groupId}/users | List members of a group
<a name="getGroups"></a>
# **getGroups**
> ResultListDataRepresentationLightGroupRepresentation getGroups(opts)
Query groups
### Example
```javascript
import GroupsApi from 'GroupsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let groupsApi = new GroupsApi(this.alfrescoApi);
let opts = {
'filter': filter_example // | filter
'groupId': 789 // | groupId
'externalId': externalId_example // | externalId
'externalIdCaseInsensitive': externalIdCaseInsensitive_example // | externalIdCaseInsensitive
'tenantId': 789 // | tenantId
};
groupsApi.getGroups(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **string**| filter | [optional]
**groupId** | **number**| groupId | [optional]
**externalId** | **string**| externalId | [optional]
**externalIdCaseInsensitive** | **string**| externalIdCaseInsensitive | [optional]
**tenantId** | **number**| tenantId | [optional]
### Return type
[**ResultListDataRepresentationLightGroupRepresentation**](ResultListDataRepresentationLightGroupRepresentation.md)
<a name="getUsersForGroup"></a>
# **getUsersForGroup**
> ResultListDataRepresentationLightUserRepresentation getUsersForGroup(groupId)
List members of a group
### Example
```javascript
import GroupsApi from 'GroupsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let groupsApi = new GroupsApi(this.alfrescoApi);
groupsApi.getUsersForGroup(groupId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**groupId** | **number**| groupId |
### Return type
[**ResultListDataRepresentationLightUserRepresentation**](ResultListDataRepresentationLightUserRepresentation.md)

View File

@@ -0,0 +1,30 @@
# HistoricProcessInstanceQueryRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**excludeSubprocesses** | **boolean** | | [optional] [default to null]
**finished** | **boolean** | | [optional] [default to null]
**finishedAfter** | [**Date**](Date.md) | | [optional] [default to null]
**finishedBefore** | [**Date**](Date.md) | | [optional] [default to null]
**includeProcessVariables** | **boolean** | | [optional] [default to null]
**involvedUser** | **string** | | [optional] [default to null]
**order** | **string** | | [optional] [default to null]
**processBusinessKey** | **string** | | [optional] [default to null]
**processDefinitionId** | **string** | | [optional] [default to null]
**processDefinitionKey** | **string** | | [optional] [default to null]
**processInstanceId** | **string** | | [optional] [default to null]
**processInstanceIds** | **string[]** | | [optional] [default to null]
**size** | **number** | | [optional] [default to null]
**sort** | **string** | | [optional] [default to null]
**start** | **number** | | [optional] [default to null]
**startedAfter** | [**Date**](Date.md) | | [optional] [default to null]
**startedBefore** | [**Date**](Date.md) | | [optional] [default to null]
**startedBy** | **string** | | [optional] [default to null]
**superProcessInstanceId** | **string** | | [optional] [default to null]
**tenantId** | **string** | | [optional] [default to null]
**tenantIdLike** | **string** | | [optional] [default to null]
**variables** | [**QueryVariable[]**](QueryVariable.md) | | [optional] [default to null]
**withoutTenantId** | **boolean** | | [optional] [default to null]

View File

@@ -0,0 +1,58 @@
# HistoricTaskInstanceQueryRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**dueDate** | [**Date**](Date.md) | | [optional] [default to null]
**dueDateAfter** | [**Date**](Date.md) | | [optional] [default to null]
**dueDateBefore** | [**Date**](Date.md) | | [optional] [default to null]
**executionId** | **string** | | [optional] [default to null]
**finished** | **boolean** | | [optional] [default to null]
**includeProcessVariables** | **boolean** | | [optional] [default to null]
**includeTaskLocalVariables** | **boolean** | | [optional] [default to null]
**order** | **string** | | [optional] [default to null]
**parentTaskId** | **string** | | [optional] [default to null]
**processBusinessKey** | **string** | | [optional] [default to null]
**processBusinessKeyLike** | **string** | | [optional] [default to null]
**processDefinitionId** | **string** | | [optional] [default to null]
**processDefinitionKey** | **string** | | [optional] [default to null]
**processDefinitionKeyLike** | **string** | | [optional] [default to null]
**processDefinitionName** | **string** | | [optional] [default to null]
**processDefinitionNameLike** | **string** | | [optional] [default to null]
**processFinished** | **boolean** | | [optional] [default to null]
**processInstanceId** | **string** | | [optional] [default to null]
**processVariables** | [**QueryVariable[]**](QueryVariable.md) | | [optional] [default to null]
**size** | **number** | | [optional] [default to null]
**sort** | **string** | | [optional] [default to null]
**start** | **number** | | [optional] [default to null]
**taskAssignee** | **string** | | [optional] [default to null]
**taskAssigneeLike** | **string** | | [optional] [default to null]
**taskCandidateGroup** | **string** | | [optional] [default to null]
**taskCompletedAfter** | [**Date**](Date.md) | | [optional] [default to null]
**taskCompletedBefore** | [**Date**](Date.md) | | [optional] [default to null]
**taskCompletedOn** | [**Date**](Date.md) | | [optional] [default to null]
**taskCreatedAfter** | [**Date**](Date.md) | | [optional] [default to null]
**taskCreatedBefore** | [**Date**](Date.md) | | [optional] [default to null]
**taskCreatedOn** | [**Date**](Date.md) | | [optional] [default to null]
**taskDefinitionKey** | **string** | | [optional] [default to null]
**taskDefinitionKeyLike** | **string** | | [optional] [default to null]
**taskDeleteReason** | **string** | | [optional] [default to null]
**taskDeleteReasonLike** | **string** | | [optional] [default to null]
**taskDescription** | **string** | | [optional] [default to null]
**taskDescriptionLike** | **string** | | [optional] [default to null]
**taskId** | **string** | | [optional] [default to null]
**taskInvolvedUser** | **string** | | [optional] [default to null]
**taskMaxPriority** | **number** | | [optional] [default to null]
**taskMinPriority** | **number** | | [optional] [default to null]
**taskName** | **string** | | [optional] [default to null]
**taskNameLike** | **string** | | [optional] [default to null]
**taskOwner** | **string** | | [optional] [default to null]
**taskOwnerLike** | **string** | | [optional] [default to null]
**taskPriority** | **number** | | [optional] [default to null]
**taskVariables** | [**QueryVariable[]**](QueryVariable.md) | | [optional] [default to null]
**tenantId** | **string** | | [optional] [default to null]
**tenantIdLike** | **string** | | [optional] [default to null]
**withoutDueDate** | **boolean** | | [optional] [default to null]
**withoutTenantId** | **boolean** | | [optional] [default to null]

View File

@@ -0,0 +1,95 @@
# IdmsyncApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getLogFile**](IDMSyncApi.md#getLogFile) | **GET** /enterprise/idm-sync-log-entries/{syncLogEntryId}/logfile | Get log file for a sync log entry
[**getSyncLogEntries**](IDMSyncApi.md#getSyncLogEntries) | **GET** /enterprise/idm-sync-log-entries | List sync log entries
<a name="getLogFile"></a>
# **getLogFile**
> getLogFile(syncLogEntryId)
Get log file for a sync log entry
### Example
```javascript
import IdmsyncApi from 'src/api/activiti-rest-api/docs/IDMSyncApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let idmsyncApi = new IdmsyncApi(this.alfrescoApi);
idmsyncApi.getLogFile(syncLogEntryId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**syncLogEntryId** | **number**| syncLogEntryId |
### Return type
null (empty response body)
<a name="getSyncLogEntries"></a>
# **getSyncLogEntries**
> SyncLogEntryRepresentation getSyncLogEntries(opts)
List sync log entries
### Example
```javascript
import IdmsyncApi from 'src/api/activiti-rest-api/docs/IDMSyncApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let idmsyncApi = new IdmsyncApi(this.alfrescoApi);
let opts = {
'tenantId': 789 // | tenantId
'page': 56 // | page
'start': 56 // | start
'size': 56 // | size
};
idmsyncApi.getSyncLogEntries(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId | [optional]
**page** | **number**| page | [optional]
**start** | **number**| start | [optional]
**size** | **number**| size | [optional]
### Return type
[**SyncLogEntryRepresentation**](SyncLogEntryRepresentation.md)

View File

@@ -0,0 +1,10 @@
# IdentityLinkRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**group** | **string** | | [optional] [default to null]
**type** | **string** | | [optional] [default to null]
**user** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,11 @@
# ImageUploadRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | [**Date**](Date.md) | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**userId** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,250 @@
# IntegrationalfrescocloudApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**confirmAuthorisation**](IntegrationAlfrescoCloudApi.md#confirmAuthorisation) | **GET** /enterprise/integration/alfresco-cloud/confirm-auth-request | Alfresco Cloud Authorization
[**getAllNetworks**](IntegrationAlfrescoCloudApi.md#getAllNetworks) | **GET** /enterprise/integration/alfresco-cloud/networks | List Alfresco networks
[**getAllSites**](IntegrationAlfrescoCloudApi.md#getAllSites) | **GET** /enterprise/integration/alfresco-cloud/networks/{networkId}/sites | List Alfresco sites
[**getContentInFolderPath**](IntegrationAlfrescoCloudApi.md#getContentInFolderPath) | **GET** /enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/folderpath/{folderPath}/content | List files and folders inside a specific folder identified by path
[**getContentInFolder**](IntegrationAlfrescoCloudApi.md#getContentInFolder) | **GET** /enterprise/integration/alfresco-cloud/networks/{networkId}/folders/{folderId}/content | List files and folders inside a specific folder
[**getContentInSite**](IntegrationAlfrescoCloudApi.md#getContentInSite) | **GET** /enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/content | List files and folders inside a specific site
<a name="confirmAuthorisation"></a>
# **confirmAuthorisation**
> confirmAuthorisation(code)
Alfresco Cloud Authorization
Returns Alfresco OAuth HTML Page
### Example
```javascript
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
integrationalfrescocloudApi.confirmAuthorisation(code).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**code** | **string**| code |
### Return type
null (empty response body)
<a name="getAllNetworks"></a>
# **getAllNetworks**
> ResultListDataRepresentationAlfrescoNetworkRepresenation getAllNetworks()
List Alfresco networks
### Example
```javascript
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
integrationalfrescocloudApi.getAllNetworks().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**ResultListDataRepresentationAlfrescoNetworkRepresenation**](ResultListDataRepresentationAlfrescoNetworkRepresenation.md)
<a name="getAllSites"></a>
# **getAllSites**
> ResultListDataRepresentationAlfrescoSiteRepresenation getAllSites(networkId)
List Alfresco sites
Returns ALL Sites
### Example
```javascript
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
integrationalfrescocloudApi.getAllSites(networkId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**networkId** | **string**| networkId |
### Return type
[**ResultListDataRepresentationAlfrescoSiteRepresenation**](ResultListDataRepresentationAlfrescoSiteRepresenation.md)
<a name="getContentInFolderPath"></a>
# **getContentInFolderPath**
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInFolderPath(networkIdopts)
List files and folders inside a specific folder identified by path
### Example
```javascript
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
let opts = {
'siteId': siteId_example // | siteId
'path': path_example // | path
};
integrationalfrescocloudApi.getContentInFolderPath(networkIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**networkId** | **string**| networkId |
**siteId** | **string**| siteId | [optional]
**path** | **string**| path | [optional]
### Return type
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)
<a name="getContentInFolder"></a>
# **getContentInFolder**
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInFolder(networkIdfolderId)
List files and folders inside a specific folder
### Example
```javascript
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
integrationalfrescocloudApi.getContentInFolder(networkIdfolderId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**networkId** | **string**| networkId |
**folderId** | **string**| folderId |
### Return type
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)
<a name="getContentInSite"></a>
# **getContentInSite**
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInSite(networkIdsiteId)
List files and folders inside a specific site
### Example
```javascript
import IntegrationalfrescocloudApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoCloudApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescocloudApi = new IntegrationalfrescocloudApi(this.alfrescoApi);
integrationalfrescocloudApi.getContentInSite(networkIdsiteId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**networkId** | **string**| networkId |
**siteId** | **string**| siteId |
### Return type
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)

View File

@@ -0,0 +1,216 @@
# IntegrationalfrescoonpremiseApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getAllSites**](IntegrationAlfrescoOnPremiseApi.md#getAllSites) | **GET** /enterprise/integration/alfresco/{repositoryId}/sites | List Alfresco sites
[**getContentInFolderPath**](IntegrationAlfrescoOnPremiseApi.md#getContentInFolderPath) | **GET** /enterprise/rest/integration/alfresco/{repositoryId}/sites/{siteId}/folderpath/{folderPath}/content | List files and folders inside a specific folder identified by folder path
[**getContentInFolder**](IntegrationAlfrescoOnPremiseApi.md#getContentInFolder) | **GET** /enterprise/integration/alfresco/{repositoryId}/folders/{folderId}/content | List files and folders inside a specific folder
[**getContentInSite**](IntegrationAlfrescoOnPremiseApi.md#getContentInSite) | **GET** /enterprise/integration/alfresco/{repositoryId}/sites/{siteId}/content | List files and folders inside a specific site
[**getRepositories**](IntegrationAlfrescoOnPremiseApi.md#getRepositories) | **GET** /enterprise/profile/accounts/alfresco | List Alfresco repositories
<a name="getAllSites"></a>
# **getAllSites**
> ResultListDataRepresentationAlfrescoSiteRepresenation getAllSites(repositoryId)
List Alfresco sites
Returns ALL Sites
### Example
```javascript
import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);
integrationalfrescoonpremiseApi.getAllSites(repositoryId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**repositoryId** | **string**| repositoryId |
### Return type
[**ResultListDataRepresentationAlfrescoSiteRepresenation**](ResultListDataRepresentationAlfrescoSiteRepresenation.md)
<a name="getContentInFolderPath"></a>
# **getContentInFolderPath**
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInFolderPath(repositoryIdsiteIdfolderPath)
List files and folders inside a specific folder identified by folder path
### Example
```javascript
import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);
integrationalfrescoonpremiseApi.getContentInFolderPath(repositoryIdsiteIdfolderPath).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**repositoryId** | **string**| repositoryId |
**siteId** | **string**| siteId |
**folderPath** | **string**| folderPath |
### Return type
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)
<a name="getContentInFolder"></a>
# **getContentInFolder**
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInFolder(repositoryIdfolderId)
List files and folders inside a specific folder
### Example
```javascript
import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);
integrationalfrescoonpremiseApi.getContentInFolder(repositoryIdfolderId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**repositoryId** | **string**| repositoryId |
**folderId** | **string**| folderId |
### Return type
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)
<a name="getContentInSite"></a>
# **getContentInSite**
> ResultListDataRepresentationAlfrescoContentRepresentation getContentInSite(repositoryIdsiteId)
List files and folders inside a specific site
### Example
```javascript
import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);
integrationalfrescoonpremiseApi.getContentInSite(repositoryIdsiteId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**repositoryId** | **string**| repositoryId |
**siteId** | **string**| siteId |
### Return type
[**ResultListDataRepresentationAlfrescoContentRepresentation**](ResultListDataRepresentationAlfrescoContentRepresentation.md)
<a name="getRepositories"></a>
# **getRepositories**
> ResultListDataRepresentationAlfrescoEndpointRepresentation getRepositories(opts)
List Alfresco repositories
A tenant administrator can configure one or more Alfresco repositories to use when working with content.
### Example
```javascript
import IntegrationalfrescoonpremiseApi from 'src/api/activiti-rest-api/docs/IntegrationAlfrescoOnPremiseApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationalfrescoonpremiseApi = new IntegrationalfrescoonpremiseApi(this.alfrescoApi);
let opts = {
'tenantId': 789 // | tenantId
'includeAccounts': true // | includeAccounts
};
integrationalfrescoonpremiseApi.getRepositories(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tenantId** | **number**| tenantId | [optional]
**includeAccounts** | **boolean**| includeAccounts | [optional] [default to true]
### Return type
[**ResultListDataRepresentationAlfrescoEndpointRepresentation**](ResultListDataRepresentationAlfrescoEndpointRepresentation.md)

View File

@@ -0,0 +1,282 @@
# IntegrationboxApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**confirmAuthorisation**](IntegrationBoxApi.md#confirmAuthorisation) | **GET** /enterprise/integration/box/confirm-auth-request | Box Authorization
[**createRepositoryAccount**](IntegrationBoxApi.md#createRepositoryAccount) | **POST** /enterprise/integration/box/{userId}/account | Add Box account
[**deleteRepositoryAccount**](IntegrationBoxApi.md#deleteRepositoryAccount) | **DELETE** /enterprise/integration/box/{userId}/account | Delete account information
[**getBoxPluginStatus**](IntegrationBoxApi.md#getBoxPluginStatus) | **GET** /enterprise/integration/box/status | Get status information
[**getFiles**](IntegrationBoxApi.md#getFiles) | **GET** /enterprise/integration/box/files | List file and folders
[**getRepositoryAccount**](IntegrationBoxApi.md#getRepositoryAccount) | **GET** /enterprise/integration/box/{userId}/account | Get account information
[**updateRepositoryAccount**](IntegrationBoxApi.md#updateRepositoryAccount) | **PUT** /enterprise/integration/box/{userId}/account | Update account information
<a name="confirmAuthorisation"></a>
# **confirmAuthorisation**
> confirmAuthorisation()
Box Authorization
Returns Box OAuth HTML Page
### Example
```javascript
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.confirmAuthorisation().then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
null (empty response body)
<a name="createRepositoryAccount"></a>
# **createRepositoryAccount**
> createRepositoryAccount(userIdcredentials)
Add Box account
### Example
```javascript
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.createRepositoryAccount(userIdcredentials).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **number**| userId |
**credentials** | [**UserAccountCredentialsRepresentation**](UserAccountCredentialsRepresentation.md)| credentials |
### Return type
null (empty response body)
<a name="deleteRepositoryAccount"></a>
# **deleteRepositoryAccount**
> deleteRepositoryAccount(userId)
Delete account information
### Example
```javascript
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.deleteRepositoryAccount(userId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **number**| userId |
### Return type
null (empty response body)
<a name="getBoxPluginStatus"></a>
# **getBoxPluginStatus**
> boolean getBoxPluginStatus()
Get status information
### Example
```javascript
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.getBoxPluginStatus().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
**boolean**
<a name="getFiles"></a>
# **getFiles**
> ResultListDataRepresentationBoxContent getFiles(opts)
List file and folders
### Example
```javascript
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
let opts = {
'filter': filter_example // | filter
'parent': parent_example // | parent
};
integrationboxApi.getFiles(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **string**| filter | [optional]
**parent** | **string**| parent | [optional]
### Return type
[**ResultListDataRepresentationBoxContent**](ResultListDataRepresentationBoxContent.md)
<a name="getRepositoryAccount"></a>
# **getRepositoryAccount**
> getRepositoryAccount(userId)
Get account information
### Example
```javascript
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.getRepositoryAccount(userId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **number**| userId |
### Return type
null (empty response body)
<a name="updateRepositoryAccount"></a>
# **updateRepositoryAccount**
> updateRepositoryAccount(userIdcredentials)
Update account information
### Example
```javascript
import IntegrationboxApi from 'src/api/activiti-rest-api/docs/IntegrationBoxApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationboxApi = new IntegrationboxApi(this.alfrescoApi);
integrationboxApi.updateRepositoryAccount(userIdcredentials).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **number**| userId |
**credentials** | [**UserAccountCredentialsRepresentation**](UserAccountCredentialsRepresentation.md)| credentials |
### Return type
null (empty response body)

View File

@@ -0,0 +1,91 @@
# IntegrationdriveApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**confirmAuthorisation**](IntegrationDriveApi.md#confirmAuthorisation) | **GET** /enterprise/integration/google-drive/confirm-auth-request | Drive Authorization
[**getFiles**](IntegrationDriveApi.md#getFiles) | **GET** /enterprise/integration/google-drive/files | List files and folders
<a name="confirmAuthorisation"></a>
# **confirmAuthorisation**
> confirmAuthorisation()
Drive Authorization
Returns Drive OAuth HTML Page
### Example
```javascript
import IntegrationdriveApi from 'src/api/activiti-rest-api/docs/IntegrationDriveApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationdriveApi = new IntegrationdriveApi(this.alfrescoApi);
integrationdriveApi.confirmAuthorisation().then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
null (empty response body)
<a name="getFiles"></a>
# **getFiles**
> ResultListDataRepresentationGoogleDriveContent getFiles(opts)
List files and folders
### Example
```javascript
import IntegrationdriveApi from 'src/api/activiti-rest-api/docs/IntegrationDriveApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let integrationdriveApi = new IntegrationdriveApi(this.alfrescoApi);
let opts = {
'filter': filter_example // | filter
'parent': parent_example // | parent
'currentFolderOnly': true // | currentFolderOnly
};
integrationdriveApi.getFiles(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **string**| filter | [optional]
**parent** | **string**| parent | [optional]
**currentFolderOnly** | **boolean**| currentFolderOnly | [optional]
### Return type
[**ResultListDataRepresentationGoogleDriveContent**](ResultListDataRepresentationGoogleDriveContent.md)

View File

@@ -0,0 +1,10 @@
# LayoutRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**colspan** | **number** | | [optional] [default to null]
**column** | **number** | | [optional] [default to null]
**row** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,12 @@
# LightAppRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **string** | | [optional] [default to null]
**icon** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**theme** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,12 @@
# LightGroupRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**externalId** | **string** | | [optional] [default to null]
**groups** | [**LightGroupRepresentation[]**](LightGroupRepresentation.md) | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**status** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# LightTenantRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,14 @@
# LightUserRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**company** | **string** | | [optional] [default to null]
**email** | **string** | | [optional] [default to null]
**externalId** | **string** | | [optional] [default to null]
**firstName** | **string** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**lastName** | **string** | | [optional] [default to null]
**pictureId** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,147 @@
# ActivitiPublicRestApi.ModelJsonBpmnApi
All URIs are relative to *https://localhost:8080/activiti-app*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getHistoricEditorDisplayJsonClient**](ModelJsonBpmnApi.md#getHistoricEditorDisplayJsonClient) | **GET** /app/rest/process-instances/{processModelId}/history/{processModelHistoryId}/model-json | Export a previous process definition model to JSON
[**getEditorDisplayJsonClient**](ModelJsonBpmnApi.md#getEditorDisplayJsonClient) | **GET** app/rest/models/{processModelId}/model-json | Export a process definition model to JSON
[**getModelJSON**](ModelJsonBpmnApi.md#getModelJSON) | **GET** /app/rest/process-definitions/{processDefinitionId}/model-json | Export a process definition model to JSON
[**getModelJSONForProcessDefinition**](ModelJsonBpmnApi.md#getModelJSONForProcessDefinition) | **GET** /app/rest/process-instances/{processInstanceId}/model-json | Export a process instances model to JSON
<a name="getEditorDisplayJsonClient"></a>
# **getEditorDisplayJsonClient**
> getEditorDisplayJsonClient(processModelId, processModelHistoryId)
Export a previous process definition model to JSON
### Example
```javascript
var processModelId = 789; // Integer | processModelId
var processModelHistoryId = 789; // Integer | processModelHistoryId
this.alfrescoJsApi.activiti.modelJsonBpmnApi.getHistoricEditorDisplayJsonClient(processModelId, processModelHistoryId);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processModelId** | **Integer**| processModelId |
**processModelHistoryId** | **Integer**| processModelHistoryId |
### Return type
JSON definition model
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getEditorDisplayJsonClient"></a>
# **getEditorDisplayJsonClient**
> getEditorDisplayJsonClient(processModelId)
Export a process instances model to a BPMN 2.0 xml file
### Example
```javascript
var processModelId = 789; // Integer | processModelId
this.alfrescoJsApi.activiti.modelJsonBpmnApi.getEditorDisplayJsonClient(processModelId);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processModelId** | **Integer**| processModelId |
### Return type
JSON definition model
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getModelJSON"></a>
# **getModelJSON**
> getModelJSON(processDefinitionId)
Export a process definition model to a BPMN 2.0 xml file
### Example
```javascript
var processDefinitionId = 789; // Stringg | processDefinitionId
this.alfrescoJsApi.activiti.modelJsonBpmnApi.getModelJSON(processDefinitionId);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processDefinitionId** | **String**| processDefinitionId |
### Return type
JSON definition model
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getModelJSONForProcessDefinition"></a>
# **getModelJSONForProcessDefinition**
> getModelJSONForProcessDefinition(processInstanceId)
Export a process definition model to a BPMN 2.0 xml file
### Example
```javascript
var processInstanceId = 789; // String | processInstanceId
this.alfrescoJsApi.activiti.modelJsonBpmnApi.getModelJSONForProcessDefinition(processInstanceId);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processInstanceId** | **String**| processInstanceId |
### Return type
JSON definition model
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

View File

@@ -0,0 +1,24 @@
# ModelRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comment** | **string** | | [optional] [default to null]
**createdBy** | **number** | | [optional] [default to null]
**createdByFullName** | **string** | | [optional] [default to null]
**description** | **string** | | [optional] [default to null]
**favorite** | **boolean** | | [optional] [default to null]
**id** | **number** | | [optional] [default to null]
**lastUpdated** | [**Date**](Date.md) | | [optional] [default to null]
**lastUpdatedBy** | **number** | | [optional] [default to null]
**lastUpdatedByFullName** | **string** | | [optional] [default to null]
**latestVersion** | **boolean** | | [optional] [default to null]
**modelType** | **number** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**permission** | **string** | | [optional] [default to null]
**referenceId** | **number** | | [optional] [default to null]
**stencilSet** | **number** | | [optional] [default to null]
**tenantId** | **number** | | [optional] [default to null]
**version** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,529 @@
# ModelsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createModel**](ModelsApi.md#createModel) | **POST** /enterprise/models | Create a new model
[**deleteModel**](ModelsApi.md#deleteModel) | **DELETE** /enterprise/models/{modelId} | Delete a model
[**duplicateModel**](ModelsApi.md#duplicateModel) | **POST** /enterprise/models/{modelId}/clone | Duplicate an existing model
[**getModelJSON**](ModelsApi.md#getModelJSON) | **GET** /enterprise/models/{modelId}/editor/json | Get model content
[**getModelThumbnail**](ModelsApi.md#getModelThumbnail) | **GET** /enterprise/models/{modelId}/thumbnail | Get a model's thumbnail image
[**getModel**](ModelsApi.md#getModel) | **GET** /enterprise/models/{modelId} | Get a model
[**getModelsToIncludeInAppDefinition**](ModelsApi.md#getModelsToIncludeInAppDefinition) | **GET** /enterprise/models-for-app-definition | List process definition models shared with the current user
[**getModels**](ModelsApi.md#getModels) | **GET** /enterprise/models | List models (process, form, decision rule or app)
[**importNewVersion**](ModelsApi.md#importNewVersion) | **POST** /enterprise/models/{modelId}/newversion | Create a new version of a model
[**importProcessModel**](ModelsApi.md#importProcessModel) | **POST** /enterprise/process-models/import | Import a BPMN 2.0 XML file
[**saveModel**](ModelsApi.md#saveModel) | **POST** /enterprise/models/{modelId}/editor/json | Update model content
[**updateModel**](ModelsApi.md#updateModel) | **PUT** /enterprise/models/{modelId} | Update a model
[**validateModel**](ModelsApi.md#validateModel) | **POST** /enterprise/models/{modelId}/editor/validate | Validate model content
<a name="createModel"></a>
# **createModel**
> ModelRepresentation createModel(modelRepresentation)
Create a new model
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.createModel(modelRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelRepresentation** | [**ModelRepresentation**](ModelRepresentation.md)| modelRepresentation |
### Return type
[**ModelRepresentation**](ModelRepresentation.md)
<a name="deleteModel"></a>
# **deleteModel**
> deleteModel(modelIdopts)
Delete a model
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
let opts = {
'cascade': true // | cascade
'deleteRuntimeApp': true // | deleteRuntimeApp
};
modelsApi.deleteModel(modelIdopts).then(() => {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**cascade** | **boolean**| cascade | [optional]
**deleteRuntimeApp** | **boolean**| deleteRuntimeApp | [optional]
### Return type
null (empty response body)
<a name="duplicateModel"></a>
# **duplicateModel**
> ModelRepresentation duplicateModel(modelIdmodelRepresentation)
Duplicate an existing model
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.duplicateModel(modelIdmodelRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**modelRepresentation** | [**ModelRepresentation**](ModelRepresentation.md)| modelRepresentation |
### Return type
[**ModelRepresentation**](ModelRepresentation.md)
<a name="getModelJSON"></a>
# **getModelJSON**
> ObjectNode getModelJSON(modelId)
Get model content
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.getModelJSON(modelId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
### Return type
[**ObjectNode**](ObjectNode.md)
<a name="getModelThumbnail"></a>
# **getModelThumbnail**
> string getModelThumbnail(modelId)
Get a model's thumbnail image
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.getModelThumbnail(modelId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
### Return type
**string**
<a name="getModel"></a>
# **getModel**
> ModelRepresentation getModel(modelIdopts)
Get a model
Models act as containers for process, form, decision table and app definitions
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
let opts = {
'includePermissions': true // | includePermissions
};
modelsApi.getModel(modelIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**includePermissions** | **boolean**| includePermissions | [optional]
### Return type
[**ModelRepresentation**](ModelRepresentation.md)
<a name="getModelsToIncludeInAppDefinition"></a>
# **getModelsToIncludeInAppDefinition**
> ResultListDataRepresentationModelRepresentation getModelsToIncludeInAppDefinition()
List process definition models shared with the current user
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.getModelsToIncludeInAppDefinition().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**ResultListDataRepresentationModelRepresentation**](ResultListDataRepresentationModelRepresentation.md)
<a name="getModels"></a>
# **getModels**
> ResultListDataRepresentationModelRepresentation getModels(opts)
List models (process, form, decision rule or app)
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
let opts = {
'filter': filter_example // | filter
'sort': sort_example // | sort
'modelType': 56 // | modelType
'referenceId': 789 // | referenceId
};
modelsApi.getModels(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**filter** | **string**| filter | [optional]
**sort** | **string**| sort | [optional]
**modelType** | **number**| modelType | [optional]
**referenceId** | **number**| referenceId | [optional]
### Return type
[**ResultListDataRepresentationModelRepresentation**](ResultListDataRepresentationModelRepresentation.md)
<a name="importNewVersion"></a>
# **importNewVersion**
> ModelRepresentation importNewVersion(modelIdfile)
Create a new version of a model
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.importNewVersion(modelIdfile).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**file** | **Blob**| file |
### Return type
[**ModelRepresentation**](ModelRepresentation.md)
<a name="importProcessModel"></a>
# **importProcessModel**
> ModelRepresentation importProcessModel(file)
Import a BPMN 2.0 XML file
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.importProcessModel(file).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**file** | **Blob**| file |
### Return type
[**ModelRepresentation**](ModelRepresentation.md)
<a name="saveModel"></a>
# **saveModel**
> ModelRepresentation saveModel(modelIdvalues)
Update model content
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.saveModel(modelIdvalues).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**values** | **any**| values |
### Return type
[**ModelRepresentation**](ModelRepresentation.md)
<a name="updateModel"></a>
# **updateModel**
> ModelRepresentation updateModel(modelIdupdatedModel)
Update a model
This method allows you to update the metadata of a model. In order to update the content of the model you will need to call the specific endpoint for that model type.
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
modelsApi.updateModel(modelIdupdatedModel).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**updatedModel** | [**ModelRepresentation**](ModelRepresentation.md)| updatedModel |
### Return type
[**ModelRepresentation**](ModelRepresentation.md)
<a name="validateModel"></a>
# **validateModel**
> ValidationErrorRepresentation validateModel(modelIdopts)
Validate model content
### Example
```javascript
import ModelsApi from 'ModelsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsApi = new ModelsApi(this.alfrescoApi);
let opts = {
'values': // | values
};
modelsApi.validateModel(modelIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**values** | **any**| values | [optional]
### Return type
[**ValidationErrorRepresentation**](ValidationErrorRepresentation.md)

View File

@@ -0,0 +1,87 @@
# ModelsbpmnApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getHistoricProcessModelBpmn20Xml**](ModelsBpmnApi.md#getHistoricProcessModelBpmn20Xml) | **GET** /enterprise/models/{processModelId}/history/{processModelHistoryId}/bpmn20 | Export a historic version of a process definition as BPMN 2.0 XML
[**getProcessModelBpmn20Xml**](ModelsBpmnApi.md#getProcessModelBpmn20Xml) | **GET** /enterprise/models/{processModelId}/bpmn20 | Export a process definition as BPMN 2.0 XML
<a name="getHistoricProcessModelBpmn20Xml"></a>
# **getHistoricProcessModelBpmn20Xml**
> getHistoricProcessModelBpmn20Xml(processModelIdprocessModelHistoryId)
Export a historic version of a process definition as BPMN 2.0 XML
### Example
```javascript
import ModelsbpmnApi from 'src/api/activiti-rest-api/docs/ModelsBpmnApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsbpmnApi = new ModelsbpmnApi(this.alfrescoApi);
modelsbpmnApi.getHistoricProcessModelBpmn20Xml(processModelIdprocessModelHistoryId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processModelId** | **number**| processModelId |
**processModelHistoryId** | **number**| processModelHistoryId |
### Return type
null (empty response body)
<a name="getProcessModelBpmn20Xml"></a>
# **getProcessModelBpmn20Xml**
> getProcessModelBpmn20Xml(processModelId)
Export a process definition as BPMN 2.0 XML
### Example
```javascript
import ModelsbpmnApi from 'src/api/activiti-rest-api/docs/ModelsBpmnApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelsbpmnApi = new ModelsbpmnApi(this.alfrescoApi);
modelsbpmnApi.getProcessModelBpmn20Xml(processModelId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processModelId** | **number**| processModelId |
### Return type
null (empty response body)

View File

@@ -0,0 +1,91 @@
# ModelshistoryApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getModelHistoryCollection**](ModelsHistoryApi.md#getModelHistoryCollection) | **GET** /enterprise/models/{modelId}/history | List a model's historic versions
[**getProcessModelHistory**](ModelsHistoryApi.md#getProcessModelHistory) | **GET** /enterprise/models/{modelId}/history/{modelHistoryId} | Get a historic version of a model
<a name="getModelHistoryCollection"></a>
# **getModelHistoryCollection**
> ResultListDataRepresentationModelRepresentation getModelHistoryCollection(modelIdopts)
List a model's historic versions
### Example
```javascript
import ModelshistoryApi from 'src/api/activiti-rest-api/docs/ModelsHistoryApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelshistoryApi = new ModelshistoryApi(this.alfrescoApi);
let opts = {
'includeLatestVersion': true // | includeLatestVersion
};
modelshistoryApi.getModelHistoryCollection(modelIdopts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**includeLatestVersion** | **boolean**| includeLatestVersion | [optional]
### Return type
[**ResultListDataRepresentationModelRepresentation**](ResultListDataRepresentationModelRepresentation.md)
<a name="getProcessModelHistory"></a>
# **getProcessModelHistory**
> ModelRepresentation getProcessModelHistory(modelIdmodelHistoryId)
Get a historic version of a model
### Example
```javascript
import ModelshistoryApi from 'src/api/activiti-rest-api/docs/ModelsHistoryApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let modelshistoryApi = new ModelshistoryApi(this.alfrescoApi);
modelshistoryApi.getProcessModelHistory(modelIdmodelHistoryId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**modelId** | **number**| modelId |
**modelHistoryId** | **number**| modelHistoryId |
### Return type
[**ModelRepresentation**](ModelRepresentation.md)

View File

@@ -0,0 +1,9 @@
# NamedObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,53 @@
# ObjectNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**array** | **boolean** | | [optional] [default to null]
**bigDecimal** | **boolean** | | [optional] [default to null]
**bigInteger** | **boolean** | | [optional] [default to null]
**binary** | **boolean** | | [optional] [default to null]
**boolean** | **boolean** | | [optional] [default to null]
**containerNode** | **boolean** | | [optional] [default to null]
**double** | **boolean** | | [optional] [default to null]
**float** | **boolean** | | [optional] [default to null]
**floatingPointNumber** | **boolean** | | [optional] [default to null]
**int** | **boolean** | | [optional] [default to null]
**integralNumber** | **boolean** | | [optional] [default to null]
**long** | **boolean** | | [optional] [default to null]
**missingNode** | **boolean** | | [optional] [default to null]
**nodeType** | **string** | | [optional] [default to null]
**null** | **boolean** | | [optional] [default to null]
**number** | **boolean** | | [optional] [default to null]
**object** | **boolean** | | [optional] [default to null]
**pojo** | **boolean** | | [optional] [default to null]
**short** | **boolean** | | [optional] [default to null]
**textual** | **boolean** | | [optional] [default to null]
**valueNode** | **boolean** | | [optional] [default to null]
<a name="ObjectNode.NodeTypeEnum"></a>
## Enum: ObjectNode.NodeTypeEnum
* `ARRAY` (value: `'ARRAY'`)
* `BINARY` (value: `'BINARY'`)
* `BOOLEAN` (value: `'BOOLEAN'`)
* `MISSING` (value: `'MISSING'`)
* `NULL` (value: `'NULL'`)
* `NUMBER` (value: `'NUMBER'`)
* `OBJECT` (value: `'OBJECT'`)
* `POJO` (value: `'POJO'`)
* `STRING` (value: `'STRING'`)

View File

@@ -0,0 +1,9 @@
# OptionRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,10 @@
# PasswordValidationConstraints
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**minLength** | **number** | | [optional] [default to null]
**passwordCriteriaMessage** | **string** | | [optional] [default to null]
**regularExpression** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# ProcessContentRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | [**RelatedContentRepresentation[]**](RelatedContentRepresentation.md) | | [optional] [default to null]
**field** | [**NamedObject**](NamedObject.md) | | [optional] [default to null]

View File

@@ -0,0 +1,9 @@
# ProcessDefinitionMetaDataRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **string** | | [optional] [default to null]
**value** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,17 @@
# ProcessDefinitionRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **string** | | [optional] [default to null]
**deploymentId** | **string** | | [optional] [default to null]
**description** | **string** | | [optional] [default to null]
**hasStartForm** | **boolean** | | [optional] [default to null]
**id** | **string** | | [optional] [default to null]
**key** | **string** | | [optional] [default to null]
**metaDataValues** | [**ProcessDefinitionMetaDataRepresentation[]**](ProcessDefinitionMetaDataRepresentation.md) | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**tenantId** | **string** | | [optional] [default to null]
**version** | **number** | | [optional] [default to null]

View File

@@ -0,0 +1,440 @@
# ProcessdefinitionsApi
All URIs are relative to */activiti-app/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createIdentityLink**](ProcessDefinitionsApi.md#createIdentityLink) | **POST** /enterprise/process-definitions/{processDefinitionId}/identitylinks | Add a user or group involvement to a process definition
[**deleteIdentityLink**](ProcessDefinitionsApi.md#deleteIdentityLink) | **DELETE** /enterprise/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId} | Remove a user or group involvement from a process definition
[**getIdentityLinkType**](ProcessDefinitionsApi.md#getIdentityLinkType) | **GET** /enterprise/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId} | Get a user or group involvement with a process definition
[**getIdentityLinksForFamily**](ProcessDefinitionsApi.md#getIdentityLinksForFamily) | **GET** /enterprise/process-definitions/{processDefinitionId}/identitylinks/{family} | List either the users or groups involved with a process definition
[**getIdentityLinks**](ProcessDefinitionsApi.md#getIdentityLinks) | **GET** /enterprise/process-definitions/{processDefinitionId}/identitylinks | List the users and groups involved with a process definition
[**getProcessDefinitionDecisionTables**](ProcessDefinitionsApi.md#getProcessDefinitionDecisionTables) | **GET** /enterprise/process-definitions/{processDefinitionId}/decision-tables | List the decision tables associated with a process definition
[**getProcessDefinitionForms**](ProcessDefinitionsApi.md#getProcessDefinitionForms) | **GET** /enterprise/process-definitions/{processDefinitionId}/forms | List the forms associated with a process definition
[**getProcessDefinitionStartForm**](ProcessDefinitionsApi.md#getProcessDefinitionStartForm) | **GET** /enterprise/process-definitions/{processDefinitionId}/start-form | Retrieve the start form for a process definition
[**getProcessDefinitions**](ProcessDefinitionsApi.md#getProcessDefinitions) | **GET** /enterprise/process-definitions | Retrieve a list of process definitions
[**getRestFieldValues**](ProcessDefinitionsApi.md#getRestFieldValues) | **GET** /enterprise/process-definitions/{processDefinitionId}/start-form-values/{field} | Retrieve field values (eg. the typeahead field)
[**getRestTableFieldValues**](ProcessDefinitionsApi.md#getRestTableFieldValues) | **GET** /enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}/{column} | Retrieve field values (eg. the table field)
<a name="createIdentityLink"></a>
# **createIdentityLink**
> IdentityLinkRepresentation createIdentityLink(processDefinitionIdidentityLinkRepresentation)
Add a user or group involvement to a process definition
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.createIdentityLink(processDefinitionIdidentityLinkRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processDefinitionId** | **string**| processDefinitionId |
**identityLinkRepresentation** | [**IdentityLinkRepresentation**](IdentityLinkRepresentation.md)| identityLinkRepresentation |
### Return type
[**IdentityLinkRepresentation**](IdentityLinkRepresentation.md)
<a name="deleteIdentityLink"></a>
# **deleteIdentityLink**
> deleteIdentityLink(processDefinitionIdfamilyidentityId)
Remove a user or group involvement from a process definition
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.deleteIdentityLink(processDefinitionIdfamilyidentityId).then(() => {
console.log('API called successfully.');
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processDefinitionId** | **string**| Process definition ID |
**family** | **string**| Identity type |
**identityId** | **string**| User or group ID |
### Return type
null (empty response body)
<a name="getIdentityLinkType"></a>
# **getIdentityLinkType**
> IdentityLinkRepresentation getIdentityLinkType(processDefinitionIdfamilyidentityId)
Get a user or group involvement with a process definition
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.getIdentityLinkType(processDefinitionIdfamilyidentityId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processDefinitionId** | **string**| Process definition ID |
**family** | **string**| Identity type |
**identityId** | **string**| User or group ID |
### Return type
[**IdentityLinkRepresentation**](IdentityLinkRepresentation.md)
<a name="getIdentityLinksForFamily"></a>
# **getIdentityLinksForFamily**
> IdentityLinkRepresentation getIdentityLinksForFamily(processDefinitionIdfamily)
List either the users or groups involved with a process definition
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.getIdentityLinksForFamily(processDefinitionIdfamily).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processDefinitionId** | **string**| processDefinitionId |
**family** | **string**| Identity type |
### Return type
[**IdentityLinkRepresentation**](IdentityLinkRepresentation.md)
<a name="getIdentityLinks"></a>
# **getIdentityLinks**
> IdentityLinkRepresentation getIdentityLinks(processDefinitionId)
List the users and groups involved with a process definition
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.getIdentityLinks(processDefinitionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processDefinitionId** | **string**| processDefinitionId |
### Return type
[**IdentityLinkRepresentation**](IdentityLinkRepresentation.md)
<a name="getProcessDefinitionDecisionTables"></a>
# **getProcessDefinitionDecisionTables**
> ResultListDataRepresentationRuntimeDecisionTableRepresentation getProcessDefinitionDecisionTables(processDefinitionId)
List the decision tables associated with a process definition
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.getProcessDefinitionDecisionTables(processDefinitionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processDefinitionId** | **string**| processDefinitionId |
### Return type
[**ResultListDataRepresentationRuntimeDecisionTableRepresentation**](ResultListDataRepresentationRuntimeDecisionTableRepresentation.md)
<a name="getProcessDefinitionForms"></a>
# **getProcessDefinitionForms**
> ResultListDataRepresentationRuntimeFormRepresentation getProcessDefinitionForms(processDefinitionId)
List the forms associated with a process definition
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.getProcessDefinitionForms(processDefinitionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**processDefinitionId** | **string**| processDefinitionId |
### Return type
[**ResultListDataRepresentationRuntimeFormRepresentation**](ResultListDataRepresentationRuntimeFormRepresentation.md)
<a name="getProcessDefinitionStartForm"></a>
# **getProcessDefinitionStartForm**
> FormDefinitionRepresentation getProcessDefinitionStartForm(processDefinitionId)
Retrieve the start form for a process definition
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.getProcessDefinitionStartForm(processDefinitionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**FormDefinitionRepresentation**](FormDefinitionRepresentation.md)
<a name="getProcessDefinitions"></a>
# **getProcessDefinitions**
> ResultListDataRepresentationProcessDefinitionRepresentation getProcessDefinitions(opts)
Retrieve a list of process definitions
Get a list of process definitions (visible within the tenant of the user)
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
let opts = {
'latest': true // | latest
'appDefinitionId': 789 // | appDefinitionId
'deploymentId': deploymentId_example // | deploymentId
};
processdefinitionsApi.getProcessDefinitions(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**latest** | **boolean**| latest | [optional]
**appDefinitionId** | **number**| appDefinitionId | [optional]
**deploymentId** | **string**| deploymentId | [optional]
### Return type
[**ResultListDataRepresentationProcessDefinitionRepresentation**](ResultListDataRepresentationProcessDefinitionRepresentation.md)
<a name="getRestFieldValues"></a>
# **getRestFieldValues**
> FormValueRepresentation getRestFieldValues()
Retrieve field values (eg. the typeahead field)
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.getRestFieldValues().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**FormValueRepresentation**](FormValueRepresentation.md)
<a name="getRestTableFieldValues"></a>
# **getRestTableFieldValues**
> FormValueRepresentation getRestTableFieldValues()
Retrieve field values (eg. the table field)
### Example
```javascript
import ProcessdefinitionsApi from 'src/api/activiti-rest-api/docs/ProcessDefinitionsApi';
import {AlfrescoApi} from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let processdefinitionsApi = new ProcessdefinitionsApi(this.alfrescoApi);
processdefinitionsApi.getRestTableFieldValues().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function (error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**FormValueRepresentation**](FormValueRepresentation.md)

View File

@@ -0,0 +1,17 @@
# ProcessInstanceAuditInfoRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**decisionInfo** | [**AuditDecisionInfoRepresentation**](AuditDecisionInfoRepresentation.md) | | [optional] [default to null]
**entries** | [**AuditLogEntryRepresentation[]**](AuditLogEntryRepresentation.md) | | [optional] [default to null]
**processDefinitionName** | **string** | | [optional] [default to null]
**processDefinitionVersion** | **string** | | [optional] [default to null]
**processInstanceDurationInMillis** | **number** | | [optional] [default to null]
**processInstanceEndTime** | **string** | | [optional] [default to null]
**processInstanceId** | **string** | | [optional] [default to null]
**processInstanceInitiator** | **string** | | [optional] [default to null]
**processInstanceName** | **string** | | [optional] [default to null]
**processInstanceStartTime** | **string** | | [optional] [default to null]

View File

@@ -0,0 +1,13 @@
# ProcessInstanceFilterRepresentation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asc** | **boolean** | | [optional] [default to null]
**name** | **string** | | [optional] [default to null]
**processDefinitionId** | **string** | | [optional] [default to null]
**processDefinitionKey** | **string** | | [optional] [default to null]
**sort** | **string** | | [optional] [default to null]
**state** | **string** | | [optional] [default to null]

Some files were not shown because too many files have changed in this diff Show More