mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
ea2c0ce229
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
81 lines
2.2 KiB
Markdown
81 lines
2.2 KiB
Markdown
# 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)
|
|
|