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
96 lines
2.3 KiB
Markdown
96 lines
2.3 KiB
Markdown
# 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)
|
|
|