mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[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
GitHub
@@ -0,0 +1,10 @@
|
||||
# AuthorityClearanceGroup
|
||||
|
||||
## Properties
|
||||
| Name | Type | Description | Notes |
|
||||
|------------------|---------------------------------------------------------------|-------------|--------------------|
|
||||
| **id** | **string** | | [default to null] |
|
||||
| **displayLabel** | **string** | | [default to null] |
|
||||
| **systemGroup** | **boolean** | | [default to false] |
|
||||
| **type** | **string** | | [default to null] |
|
||||
| **marks** | **[**AuthorityClearanceMark**](AuthorityClearanceMark.md)[]** | | [default to null] |
|
||||
@@ -0,0 +1,8 @@
|
||||
# AuthorityClearanceGroupEntry
|
||||
|
||||
## Properties
|
||||
| Name | Type | Description | Notes |
|
||||
|-----------|-----------------------------------------------------------|-------------|-------------------|
|
||||
| **entry** | [**AuthorityClearanceGroup**](AuthorityClearanceGroup.md) | | [default to null] |
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# AuthorityClearanceGroupPaging
|
||||
|
||||
## Properties
|
||||
| Name | Type | Description | Notes |
|
||||
|----------|--------------------------------------------------------------------------------|-------------|------------------------------|
|
||||
| **list** | [**AuthorityClearanceGroupPagingList**](AuthorityClearanceGroupPaging_list.md) | | [optional] [default to null] |
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# AuthorityClearanceGroupPagingList
|
||||
|
||||
## Properties
|
||||
| Name | Type | Description | Notes |
|
||||
|----------------|-----------------------------------------------------------------------|-------------|------------------------------|
|
||||
| **pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null] |
|
||||
| **entries** | [**AuthorityClearanceGroupEntry[]**](AuthorityClearanceGroupEntry.md) | | [optional] [default to null] |
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# AuthorityClearanceMark
|
||||
|
||||
## Properties
|
||||
| Name | Type | Description | Notes |
|
||||
|------------------|-------------|-------------|--------------------|
|
||||
| **id** | **string** | | [default to null] |
|
||||
| **displayLabel** | **string** | | [default to null] |
|
||||
| **applied** | **boolean** | | [default to false] |
|
||||
| **inherited** | **boolean** | | [default to false] |
|
||||
@@ -0,0 +1,11 @@
|
||||
# ClassificationGuide
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [default to null]
|
||||
**originatingOrganization** | **string** | | [default to null]
|
||||
**publishedOn** | **Date** | | [default to null]
|
||||
**enabled** | **boolean** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# ClassificationGuideBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [default to null]
|
||||
**originatingOrganization** | **string** | | [default to null]
|
||||
**publishedOn** | **Date** | | [default to null]
|
||||
**enabled** | **boolean** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# ClassificationGuideEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**ClassificationGuide**](ClassificationGuide.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# ClassificationGuideInTopic
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [default to null]
|
||||
**originatingOrganization** | **string** | | [default to null]
|
||||
**publishedOn** | **Date** | | [default to null]
|
||||
**enabled** | **boolean** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# ClassificationGuidePaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**ClassificationGuidePagingList**](ClassificationGuidePagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# ClassificationGuidePagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**ClassificationGuidesEntry[]**](ClassificationGuidesEntry.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# ClassificationGuides
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [default to null]
|
||||
**originatingOrganization** | **string** | | [default to null]
|
||||
**publishedOn** | **Date** | | [default to null]
|
||||
**enabled** | **boolean** | | [optional] [default to null]
|
||||
**hasTopics** | **boolean** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,715 @@
|
||||
# ClassificationGuidesApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**combinedInstructions**](ClassificationGuidesApi.md#combinedInstructions) | **POST** /combined-instructions | Combined instructions
|
||||
[**createClassificationGuide**](ClassificationGuidesApi.md#createClassificationGuide) | **POST** /classification-guides | Create a classification guide
|
||||
[**createSubtopic**](ClassificationGuidesApi.md#createSubtopic) | **POST** /topics/{topicId}/subtopics | Create a subtopic
|
||||
[**createTopic**](ClassificationGuidesApi.md#createTopic) | **POST** /classification-guides/{classificationGuideId}/topics | Create a topic
|
||||
[**deleteClassificationGuide**](ClassificationGuidesApi.md#deleteClassificationGuide) | **DELETE** /classification-guides/{classificationGuideId} | Delete a classification guide
|
||||
[**deleteTopic**](ClassificationGuidesApi.md#deleteTopic) | **DELETE** /topics/{topicId} | Delete a topic
|
||||
[**listClassificationGuides**](ClassificationGuidesApi.md#listClassificationGuides) | **GET** /classification-guides | List all classification guides
|
||||
[**listSubtopics**](ClassificationGuidesApi.md#listSubtopics) | **GET** /topics/{topicId}/subtopics | List all subtopics
|
||||
[**listTopics**](ClassificationGuidesApi.md#listTopics) | **GET** /classification-guides/{classificationGuideId}/topics | List all topics
|
||||
[**showClassificationGuideById**](ClassificationGuidesApi.md#showClassificationGuideById) | **GET** /classification-guides/{classificationGuideId} | Get classification guide information
|
||||
[**showTopicById**](ClassificationGuidesApi.md#showTopicById) | **GET** /topics/{topicId} | Get topic information
|
||||
[**updateClassificationGuide**](ClassificationGuidesApi.md#updateClassificationGuide) | **PUT** /classification-guides/{classificationGuideId} | Update a classification guide
|
||||
[**updateTopic**](ClassificationGuidesApi.md#updateTopic) | **PUT** /topics/{topicId} | Update a topic
|
||||
|
||||
|
||||
<a name="combinedInstructions"></a>
|
||||
# **combinedInstructions**
|
||||
> InstructionEntry combinedInstructions(opts)
|
||||
|
||||
Combined instructions
|
||||
|
||||
Combines instructions from the given topics and the user defined instruction, if any.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'instructions': // | Instructions
|
||||
};
|
||||
|
||||
classificationguidesApi.combinedInstructions(opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**instructions** | [**CombinedInstructionBody**](CombinedInstructionBody.md)| Instructions | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**InstructionEntry**](InstructionEntry.md)
|
||||
|
||||
<a name="createClassificationGuide"></a>
|
||||
# **createClassificationGuide**
|
||||
> ClassificationGuideEntry createClassificationGuide(classificationGuide)
|
||||
|
||||
Create a classification guide
|
||||
|
||||
Creates a new classification guide.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationguidesApi.createClassificationGuide(classificationGuide).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationGuide** | [**ClassificationGuideBody**](ClassificationGuideBody.md)| Classification guide |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClassificationGuideEntry**](ClassificationGuideEntry.md)
|
||||
|
||||
<a name="createSubtopic"></a>
|
||||
# **createSubtopic**
|
||||
> TopicEntry createSubtopic(topicIdtopicopts)
|
||||
|
||||
Create a subtopic
|
||||
|
||||
Creates a new subtopic of a topic.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
|
||||
};
|
||||
|
||||
classificationguidesApi.createSubtopic(topicIdtopicopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**topicId** | **string**| The identifier for the topic |
|
||||
**topic** | [**TopicBody**](TopicBody.md)| Subtopic |
|
||||
**include** | [**string**](string.md)| Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
| [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**TopicEntry**](TopicEntry.md)
|
||||
|
||||
<a name="createTopic"></a>
|
||||
# **createTopic**
|
||||
> TopicEntry createTopic(classificationGuideIdtopicopts)
|
||||
|
||||
Create a topic
|
||||
|
||||
Creates a new topic.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
|
||||
};
|
||||
|
||||
classificationguidesApi.createTopic(classificationGuideIdtopicopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationGuideId** | **string**| The identifier for the classification guide |
|
||||
**topic** | [**TopicBody**](TopicBody.md)| Topic |
|
||||
**include** | [**string**](string.md)| Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
| [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**TopicEntry**](TopicEntry.md)
|
||||
|
||||
<a name="deleteClassificationGuide"></a>
|
||||
# **deleteClassificationGuide**
|
||||
> deleteClassificationGuide(classificationGuideId)
|
||||
|
||||
Delete a classification guide
|
||||
|
||||
Deletes the classification guide with id **classificationGuideId**, including any topics and instructions.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationguidesApi.deleteClassificationGuide(classificationGuideId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationGuideId** | **string**| The identifier for the classification guide |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="deleteTopic"></a>
|
||||
# **deleteTopic**
|
||||
> deleteTopic(topicId)
|
||||
|
||||
Delete a topic
|
||||
|
||||
Deletes the topic with id **topicId**, including any subtopics and instructions.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationguidesApi.deleteTopic(topicId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**topicId** | **string**| The identifier for the topic |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="listClassificationGuides"></a>
|
||||
# **listClassificationGuides**
|
||||
> ClassificationGuidePaging listClassificationGuides(opts)
|
||||
|
||||
List all classification guides
|
||||
|
||||
Gets all classification guides.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the guide. The following optional fields can be requested:
|
||||
* hasTopics - A flag indicating whether the guide already contains any topics.
|
||||
|
||||
'skipCount': 56 // | The number of entities that exist in the collection before those included in this list.
|
||||
'maxItems': 56 // | The maximum number of items to return in the list.
|
||||
'orderBy': // | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||
sort the list by one or more fields.
|
||||
|
||||
Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
|
||||
above to check if any fields used in this method have a descending default search order.
|
||||
|
||||
To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
|
||||
|
||||
'where': where_example // | A string to restrict the returned objects by using a predicate. Supported operations are AND, NOT, and OR. Fields to filter on:
|
||||
* enabled - e.g. (enabled = true OR enabled = false)
|
||||
|
||||
};
|
||||
|
||||
classificationguidesApi.listClassificationGuides(opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**include** | [**string**](string.md)| Returns additional information about the guide. The following optional fields can be requested:
|
||||
* hasTopics - A flag indicating whether the guide already contains any topics.
|
||||
| [optional]
|
||||
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list. | [optional]
|
||||
**maxItems** | **number**| The maximum number of items to return in the list. | [optional]
|
||||
**orderBy** | [**string**](string.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||
sort the list by one or more fields.
|
||||
|
||||
Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
|
||||
above to check if any fields used in this method have a descending default search order.
|
||||
|
||||
To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
|
||||
| [optional]
|
||||
**where** | **string**| A string to restrict the returned objects by using a predicate. Supported operations are AND, NOT, and OR. Fields to filter on:
|
||||
* enabled - e.g. (enabled = true OR enabled = false)
|
||||
| [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClassificationGuidePaging**](ClassificationGuidePaging.md)
|
||||
|
||||
<a name="listSubtopics"></a>
|
||||
# **listSubtopics**
|
||||
> SubtopicPaging listSubtopics(topicIdopts)
|
||||
|
||||
List all subtopics
|
||||
|
||||
Gets all subtopics of a topic.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
|
||||
'skipCount': 56 // | The number of entities that exist in the collection before those included in this list.
|
||||
'maxItems': 56 // | The maximum number of items to return in the list.
|
||||
'orderBy': // | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||
sort the list by one or more fields.
|
||||
|
||||
Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
|
||||
above to check if any fields used in this method have a descending default search order.
|
||||
|
||||
To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
|
||||
|
||||
'where': where_example // | A string to restrict the returned objects by using a predicate. Supported operations are AND, NOT, and OR. Fields to filter on:
|
||||
* hasInstruction
|
||||
* hasSubtopics
|
||||
|
||||
'includeSource': true // | Also include **source** in addition to **entries** with folder information on the parent guide/topic
|
||||
};
|
||||
|
||||
classificationguidesApi.listSubtopics(topicIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**topicId** | **string**| The identifier for the topic |
|
||||
**include** | [**string**](string.md)| Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
| [optional]
|
||||
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list. | [optional]
|
||||
**maxItems** | **number**| The maximum number of items to return in the list. | [optional]
|
||||
**orderBy** | [**string**](string.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||
sort the list by one or more fields.
|
||||
|
||||
Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
|
||||
above to check if any fields used in this method have a descending default search order.
|
||||
|
||||
To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
|
||||
| [optional]
|
||||
**where** | **string**| A string to restrict the returned objects by using a predicate. Supported operations are AND, NOT, and OR. Fields to filter on:
|
||||
* hasInstruction
|
||||
* hasSubtopics
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** in addition to **entries** with folder information on the parent guide/topic | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**SubtopicPaging**](SubtopicPaging.md)
|
||||
|
||||
<a name="listTopics"></a>
|
||||
# **listTopics**
|
||||
> TopicPaging listTopics(classificationGuideIdopts)
|
||||
|
||||
List all topics
|
||||
|
||||
Gets all topics.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
|
||||
'skipCount': 56 // | The number of entities that exist in the collection before those included in this list.
|
||||
'maxItems': 56 // | The maximum number of items to return in the list.
|
||||
'orderBy': // | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||
sort the list by one or more fields.
|
||||
|
||||
Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
|
||||
above to check if any fields used in this method have a descending default search order.
|
||||
|
||||
To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
|
||||
|
||||
'where': where_example // | A string to restrict the returned objects by using a predicate. Supported operations are AND, NOT, and OR e.g. (instruction=true and hasSubtopics=false). Fields to filter on:
|
||||
* hasInstruction
|
||||
* hasSubtopics
|
||||
|
||||
'includeSource': true // | Also include **source** in addition to **entries** with folder information on the parent guide/topic
|
||||
};
|
||||
|
||||
classificationguidesApi.listTopics(classificationGuideIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationGuideId** | **string**| The identifier for the classification guide |
|
||||
**include** | [**string**](string.md)| Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
| [optional]
|
||||
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list. | [optional]
|
||||
**maxItems** | **number**| The maximum number of items to return in the list. | [optional]
|
||||
**orderBy** | [**string**](string.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to
|
||||
sort the list by one or more fields.
|
||||
|
||||
Each field has a default sort order, which is normally ascending order. Read the API method implementation notes
|
||||
above to check if any fields used in this method have a descending default search order.
|
||||
|
||||
To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.
|
||||
| [optional]
|
||||
**where** | **string**| A string to restrict the returned objects by using a predicate. Supported operations are AND, NOT, and OR e.g. (instruction=true and hasSubtopics=false). Fields to filter on:
|
||||
* hasInstruction
|
||||
* hasSubtopics
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** in addition to **entries** with folder information on the parent guide/topic | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**TopicPaging**](TopicPaging.md)
|
||||
|
||||
<a name="showClassificationGuideById"></a>
|
||||
# **showClassificationGuideById**
|
||||
> ClassificationGuideEntry showClassificationGuideById(classificationGuideId)
|
||||
|
||||
Get classification guide information
|
||||
|
||||
Gets the classification guide with id **classificationGuideId**.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationguidesApi.showClassificationGuideById(classificationGuideId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationGuideId** | **string**| The identifier for the classification guide |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClassificationGuideEntry**](ClassificationGuideEntry.md)
|
||||
|
||||
<a name="showTopicById"></a>
|
||||
# **showTopicById**
|
||||
> TopicEntry showTopicById(topicIdopts)
|
||||
|
||||
Get topic information
|
||||
|
||||
Gets the topic with id **topicId**.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
|
||||
};
|
||||
|
||||
classificationguidesApi.showTopicById(topicIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**topicId** | **string**| The identifier for the topic |
|
||||
**include** | [**string**](string.md)| Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
| [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**TopicEntry**](TopicEntry.md)
|
||||
|
||||
<a name="updateClassificationGuide"></a>
|
||||
# **updateClassificationGuide**
|
||||
> ClassificationGuideEntry updateClassificationGuide(classificationGuideIdclassificationGuide)
|
||||
|
||||
Update a classification guide
|
||||
|
||||
Updates the classification guide with id **classificationGuideId**. For example, you can rename a classification guide.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationguidesApi.updateClassificationGuide(classificationGuideIdclassificationGuide).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationGuideId** | **string**| The identifier for the classification guide |
|
||||
**classificationGuide** | [**ClassificationGuideBody**](ClassificationGuideBody.md)| Classification guide |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClassificationGuideEntry**](ClassificationGuideEntry.md)
|
||||
|
||||
<a name="updateTopic"></a>
|
||||
# **updateTopic**
|
||||
> TopicEntry updateTopic(topicIdtopicopts)
|
||||
|
||||
Update a topic
|
||||
|
||||
Updates the topic with id **topicId**.
|
||||
|
||||
Use this to rename a topic or to add, edit, or remove the instruction associated with it.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationGuidesApi from 'ClassificationGuidesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationguidesApi = new ClassificationGuidesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
|
||||
};
|
||||
|
||||
classificationguidesApi.updateTopic(topicIdtopicopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**topicId** | **string**| The identifier for the topic |
|
||||
**topic** | [**TopicBody**](TopicBody.md)| Topic |
|
||||
**include** | [**string**](string.md)| Returns additional information about the topic. The following optional fields can be requested:
|
||||
* hasSubtopics - A flag indicating whether the topic already contains any subtopics.
|
||||
* instruction - Contains details of any instruction in the topic.
|
||||
* path - An ordered list of id-name pairs of all ancestor topics and the classification guide.
|
||||
* classificationGuide - The classification guide this topic is in.
|
||||
| [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**TopicEntry**](TopicEntry.md)
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# ClassificationGuidesBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [default to null]
|
||||
**originatingOrganization** | **string** | | [default to null]
|
||||
**publishedOn** | **Date** | | [default to null]
|
||||
**enabled** | **boolean** | | [optional] [default to null]
|
||||
**hasTopics** | **boolean** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# ClassificationGuidesEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**ClassificationGuides**](ClassificationGuides.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# ClassificationGuidesInTopic
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [default to null]
|
||||
**originatingOrganization** | **string** | | [default to null]
|
||||
**publishedOn** | **Date** | | [default to null]
|
||||
**enabled** | **boolean** | | [optional] [default to null]
|
||||
**hasTopics** | **boolean** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# ClassificationInformation
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**level** | **string** | | [default to null]
|
||||
**classificationAgency** | **string** | | [optional] [default to null]
|
||||
**reasonIds** | **string[]** | | [default to null]
|
||||
**downgradeOn** | **Date** | | [optional] [default to null]
|
||||
**downgradeEvent** | **string** | | [optional] [default to null]
|
||||
**downgradeInstructions** | **string** | | [optional] [default to null]
|
||||
**declassifyOn** | **Date** | | [optional] [default to null]
|
||||
**declassificationEvent** | **string** | | [optional] [default to null]
|
||||
**exemptionIds** | **string[]** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# ClassificationReason
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**code** | **string** | | [default to null]
|
||||
**description** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# ClassificationReasonBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **string** | | [default to null]
|
||||
**description** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# ClassificationReasonEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**ClassificationReason**](ClassificationReason.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,281 @@
|
||||
# ClassificationReasonsApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createClassificationReason**](ClassificationReasonsApi.md#createClassificationReason) | **POST** /classification-reasons | Create a classification reason
|
||||
[**deleteClassificationReason**](ClassificationReasonsApi.md#deleteClassificationReason) | **DELETE** /classification-reasons/{classificationReasonId} | Delete a classification reason
|
||||
[**listClassificationReasons**](ClassificationReasonsApi.md#listClassificationReasons) | **GET** /classification-reasons | List all classification reasons
|
||||
[**showClassificationReasonById**](ClassificationReasonsApi.md#showClassificationReasonById) | **GET** /classification-reasons/{classificationReasonId} | Get classification reason information
|
||||
[**updateClassificationReason**](ClassificationReasonsApi.md#updateClassificationReason) | **PUT** /classification-reasons/{classificationReasonId} | Update a classification reason
|
||||
|
||||
|
||||
<a name="createClassificationReason"></a>
|
||||
# **createClassificationReason**
|
||||
> ClassificationReasonEntry createClassificationReason(classificationReason)
|
||||
|
||||
Create a classification reason
|
||||
|
||||
Creates a new classification reason.
|
||||
|
||||
**Note:** You can create more than one reason by specifying a list of reasons in the JSON body.
|
||||
For example, the following JSON body creates two classification reasons:
|
||||
JSON
|
||||
[
|
||||
{
|
||||
\"code\":\"My Code1\",
|
||||
\"description\":\"My Description1\"
|
||||
},
|
||||
{
|
||||
\"code\":\"My Code2\",
|
||||
\"description\":\"My Description2\"
|
||||
}
|
||||
]
|
||||
|
||||
If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:
|
||||
|
||||
JSON
|
||||
{
|
||||
\"list\": {
|
||||
\"pagination\": {
|
||||
\"count\": 2,
|
||||
\"hasMoreItems\": false,
|
||||
\"totalItems\": 2,
|
||||
\"skipCount\": 0,
|
||||
\"maxItems\": 100
|
||||
},
|
||||
\"entries\": [
|
||||
{
|
||||
\"entry\": {
|
||||
...
|
||||
}
|
||||
},
|
||||
{
|
||||
\"entry\": {
|
||||
...
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationReasonsApi from 'ClassificationReasonsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationreasonsApi = new ClassificationReasonsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationreasonsApi.createClassificationReason(classificationReason).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationReason** | [**ClassificationReasonBody**](ClassificationReasonBody.md)| Classification reason |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClassificationReasonEntry**](ClassificationReasonEntry.md)
|
||||
|
||||
<a name="deleteClassificationReason"></a>
|
||||
# **deleteClassificationReason**
|
||||
> deleteClassificationReason(classificationReasonId)
|
||||
|
||||
Delete a classification reason
|
||||
|
||||
Deletes the classification reason **classificationReasonId**. You can't delete a classification reason that is being used to classify content. There must be at least one classification reason.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationReasonsApi from 'ClassificationReasonsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationreasonsApi = new ClassificationReasonsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationreasonsApi.deleteClassificationReason(classificationReasonId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationReasonId** | **string**| The identifier for the classification reason |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="listClassificationReasons"></a>
|
||||
# **listClassificationReasons**
|
||||
> ClassificationReasonsPaging listClassificationReasons(opts)
|
||||
|
||||
List all classification reasons
|
||||
|
||||
Gets all classification reasons.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationReasonsApi from 'ClassificationReasonsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationreasonsApi = new ClassificationReasonsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'skipCount': 56 // | The number of entities that exist in the collection before those included in this list.
|
||||
'maxItems': 56 // | The maximum number of items to return in the list.
|
||||
'fields': // | A list of field names.
|
||||
|
||||
You can use this parameter to restrict the fields
|
||||
returned within a response if, for example, you want to save on overall bandwidth.
|
||||
|
||||
The list applies to a returned individual
|
||||
entity or entries within a collection.
|
||||
|
||||
If the API method also supports the **include**
|
||||
parameter, then the fields specified in the **include**
|
||||
parameter are returned in addition to those specified in the **fields** parameter.
|
||||
|
||||
};
|
||||
|
||||
classificationreasonsApi.listClassificationReasons(opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list. | [optional]
|
||||
**maxItems** | **number**| The maximum number of items to return in the list. | [optional]
|
||||
**fields** | [**string**](string.md)| A list of field names.
|
||||
|
||||
You can use this parameter to restrict the fields
|
||||
returned within a response if, for example, you want to save on overall bandwidth.
|
||||
|
||||
The list applies to a returned individual
|
||||
entity or entries within a collection.
|
||||
|
||||
If the API method also supports the **include**
|
||||
parameter, then the fields specified in the **include**
|
||||
parameter are returned in addition to those specified in the **fields** parameter.
|
||||
| [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClassificationReasonsPaging**](ClassificationReasonsPaging.md)
|
||||
|
||||
<a name="showClassificationReasonById"></a>
|
||||
# **showClassificationReasonById**
|
||||
> ClassificationReasonEntry showClassificationReasonById(classificationReasonId)
|
||||
|
||||
Get classification reason information
|
||||
|
||||
Gets the classification reason **classificationReasonId**.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationReasonsApi from 'ClassificationReasonsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationreasonsApi = new ClassificationReasonsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationreasonsApi.showClassificationReasonById(classificationReasonId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationReasonId** | **string**| The identifier for the classification reason |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClassificationReasonEntry**](ClassificationReasonEntry.md)
|
||||
|
||||
<a name="updateClassificationReason"></a>
|
||||
# **updateClassificationReason**
|
||||
> ClassificationReasonEntry updateClassificationReason(classificationReasonIdclassificationReason)
|
||||
|
||||
Update a classification reason
|
||||
|
||||
Updates the classification reason with id **classificationReasonId**. For example, you can change a classification reason code or description.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import ClassificationReasonsApi from 'ClassificationReasonsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let classificationreasonsApi = new ClassificationReasonsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
classificationreasonsApi.updateClassificationReason(classificationReasonIdclassificationReason).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**classificationReasonId** | **string**| The identifier for the classification reason |
|
||||
**classificationReason** | [**ClassificationReasonBody**](ClassificationReasonBody.md)| Classification reason |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ClassificationReasonEntry**](ClassificationReasonEntry.md)
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# ClassificationReasonsPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**ClassificationReasonsPagingList**](ClassificationReasonsPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# ClassificationReasonsPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**ClassificationReasonEntry[]**](ClassificationReasonEntry.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# CombinedInstructionBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**classificationInformation** | [**ClassificationInformation**](ClassificationInformation.md) | | [optional] [default to null]
|
||||
**securityMarkInformation** | [**SecurityMarkInformationBody**](SecurityMarkInformationBody.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
# DeclassificationDate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# DeclassificationExemption
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**code** | **string** | | [default to null]
|
||||
**description** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# DeclassificationExemptionBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **string** | | [default to null]
|
||||
**description** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# DeclassificationExemptionEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**DeclassificationExemption**](DeclassificationExemption.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,257 @@
|
||||
# DeclassificationExemptionsApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createDeclassificationExemption**](DeclassificationExemptionsApi.md#createDeclassificationExemption) | **POST** /declassification-exemptions | Create a declassification exemption
|
||||
[**deleteDeclassificationExemption**](DeclassificationExemptionsApi.md#deleteDeclassificationExemption) | **DELETE** /declassification-exemptions/{declassificationExemptionId} | Delete a declassification exemption
|
||||
[**listDeclassificationExemptions**](DeclassificationExemptionsApi.md#listDeclassificationExemptions) | **GET** /declassification-exemptions | List all declassification exemptions
|
||||
[**showDeclassificationExemptionById**](DeclassificationExemptionsApi.md#showDeclassificationExemptionById) | **GET** /declassification-exemptions/{declassificationExemptionId} | Get declassification exemption information
|
||||
[**updateDeclassificationExemption**](DeclassificationExemptionsApi.md#updateDeclassificationExemption) | **PUT** /declassification-exemptions/{declassificationExemptionId} | Update a declassification exemption
|
||||
|
||||
|
||||
<a name="createDeclassificationExemption"></a>
|
||||
# **createDeclassificationExemption**
|
||||
> DeclassificationExemptionEntry createDeclassificationExemption(declassificationExemption)
|
||||
|
||||
Create a declassification exemption
|
||||
|
||||
Creates a new declassification exemption.
|
||||
|
||||
**Note:** You can create more than one exemption by specifying a list of exemptions in the JSON body.
|
||||
For example, the following JSON body creates two declassification exemptions:
|
||||
JSON
|
||||
[
|
||||
{
|
||||
\"code\":\"My Code1\",
|
||||
\"description\":\"My Description1\"
|
||||
},
|
||||
{
|
||||
\"code\":\"My Code2\",
|
||||
\"description\":\"My Description2\"
|
||||
}
|
||||
]
|
||||
|
||||
If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:
|
||||
|
||||
JSON
|
||||
{
|
||||
\"list\": {
|
||||
\"pagination\": {
|
||||
\"count\": 2,
|
||||
\"hasMoreItems\": false,
|
||||
\"totalItems\": 2,
|
||||
\"skipCount\": 0,
|
||||
\"maxItems\": 100
|
||||
},
|
||||
\"entries\": [
|
||||
{
|
||||
\"entry\": {
|
||||
...
|
||||
}
|
||||
},
|
||||
{
|
||||
\"entry\": {
|
||||
...
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import DeclassificationExemptionsApi from 'DeclassificationExemptionsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let declassificationexemptionsApi = new DeclassificationExemptionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
declassificationexemptionsApi.createDeclassificationExemption(declassificationExemption).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**declassificationExemption** | [**DeclassificationExemptionBody**](DeclassificationExemptionBody.md)| Declassification exemption |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DeclassificationExemptionEntry**](DeclassificationExemptionEntry.md)
|
||||
|
||||
<a name="deleteDeclassificationExemption"></a>
|
||||
# **deleteDeclassificationExemption**
|
||||
> deleteDeclassificationExemption(declassificationExemptionId)
|
||||
|
||||
Delete a declassification exemption
|
||||
|
||||
Deletes the declassification exemption with id **declassificationExemptionId**. You can't delete a classification exemption that is being used to classify content.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import DeclassificationExemptionsApi from 'DeclassificationExemptionsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let declassificationexemptionsApi = new DeclassificationExemptionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
declassificationexemptionsApi.deleteDeclassificationExemption(declassificationExemptionId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**declassificationExemptionId** | **string**| The identifier for the declassification exemption |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="listDeclassificationExemptions"></a>
|
||||
# **listDeclassificationExemptions**
|
||||
> DeclassificationExemptionsPaging listDeclassificationExemptions(opts)
|
||||
|
||||
List all declassification exemptions
|
||||
|
||||
Gets all declassification exemptions.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import DeclassificationExemptionsApi from 'DeclassificationExemptionsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let declassificationexemptionsApi = new DeclassificationExemptionsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'skipCount': 56 // | The number of entities that exist in the collection before those included in this list.
|
||||
'maxItems': 56 // | The maximum number of items to return in the list.
|
||||
};
|
||||
|
||||
declassificationexemptionsApi.listDeclassificationExemptions(opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**skipCount** | **number**| The number of entities that exist in the collection before those included in this list. | [optional]
|
||||
**maxItems** | **number**| The maximum number of items to return in the list. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**DeclassificationExemptionsPaging**](DeclassificationExemptionsPaging.md)
|
||||
|
||||
<a name="showDeclassificationExemptionById"></a>
|
||||
# **showDeclassificationExemptionById**
|
||||
> DeclassificationExemptionEntry showDeclassificationExemptionById(declassificationExemptionId)
|
||||
|
||||
Get declassification exemption information
|
||||
|
||||
Gets the declassification exemption with id **declassificationExemptionId**.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import DeclassificationExemptionsApi from 'DeclassificationExemptionsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let declassificationexemptionsApi = new DeclassificationExemptionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
declassificationexemptionsApi.showDeclassificationExemptionById(declassificationExemptionId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**declassificationExemptionId** | **string**| The identifier for the declassification exemption |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DeclassificationExemptionEntry**](DeclassificationExemptionEntry.md)
|
||||
|
||||
<a name="updateDeclassificationExemption"></a>
|
||||
# **updateDeclassificationExemption**
|
||||
> DeclassificationExemptionEntry updateDeclassificationExemption(declassificationExemptionIddeclassificationExemption)
|
||||
|
||||
Update a declassification exemption
|
||||
|
||||
Updates the declassification exemption with id **declassificationExemptionId**. For example, you can rename a declassification exemption.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import DeclassificationExemptionsApi from 'DeclassificationExemptionsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let declassificationexemptionsApi = new DeclassificationExemptionsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
declassificationexemptionsApi.updateDeclassificationExemption(declassificationExemptionIddeclassificationExemption).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**declassificationExemptionId** | **string**| The identifier for the declassification exemption |
|
||||
**declassificationExemption** | [**DeclassificationExemptionBody**](DeclassificationExemptionBody.md)| Declassification exemption |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DeclassificationExemptionEntry**](DeclassificationExemptionEntry.md)
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# DeclassificationExemptionsPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**DeclassificationExemptionsPagingList**](DeclassificationExemptionsPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# DeclassificationExemptionsPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**DeclassificationExemptionEntry[]**](DeclassificationExemptionEntry.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
# DefaultClassificationValuesApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**calculateDefaultDeclassificationDate**](DefaultClassificationValuesApi.md#calculateDefaultDeclassificationDate) | **POST** /default-classification-values/{nodeId}/calculate-declassification-date | Calculate the default declassification date
|
||||
|
||||
|
||||
<a name="calculateDefaultDeclassificationDate"></a>
|
||||
# **calculateDefaultDeclassificationDate**
|
||||
> DeclassificationDate calculateDefaultDeclassificationDate(nodeId)
|
||||
|
||||
Calculate the default declassification date
|
||||
|
||||
Calculates the default declassification date for **nodeId** based on the properties of the node and the current declassification time frame.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import DefaultClassificationValuesApi from 'DefaultClassificationValuesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let defaultclassificationvaluesApi = new DefaultClassificationValuesApi(this.alfrescoApi);
|
||||
|
||||
|
||||
defaultclassificationvaluesApi.calculateDefaultDeclassificationDate(nodeId).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**nodeId** | **string**| The identifier of a node. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DeclassificationDate**](DeclassificationDate.md)
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# ModelError
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | [**ErrorError**](ErrorError.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# ErrorError
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**errorKey** | **string** | | [optional] [default to null]
|
||||
**statusCode** | **number** | | [default to null]
|
||||
**briefSummary** | **string** | | [default to null]
|
||||
**stackTrace** | **string** | | [default to null]
|
||||
**descriptionURL** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# Instruction
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**classificationInformation** | [**ClassificationInformation**](ClassificationInformation.md) | | [optional] [default to null]
|
||||
**securityMarkInformation** | [**SecurityMarkInformation**](SecurityMarkInformation.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# InstructionBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**classificationInformation** | [**ClassificationInformation**](ClassificationInformation.md) | | [optional] [default to null]
|
||||
**securityMarkInformation** | [**SecurityMarkInformationBody**](SecurityMarkInformationBody.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# InstructionEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**Instruction**](Instruction.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# NodeSecurityMarkBody
|
||||
|
||||
## Properties
|
||||
| Name | Type | Description | Notes |
|
||||
|-------------|------------|-------------|-------------------|
|
||||
| **id** | **string** | | [default to null] |
|
||||
| **groupId** | **string** | | [default to null] |
|
||||
| **op** | **string** | | [default to null] |
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# Pagination
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**count** | **number** | The number of objects in the entries array.
|
||||
| [default to null]
|
||||
**hasMoreItems** | **boolean** | A boolean value which is **true** if there are more entities in the collection
|
||||
beyond those in this response. A true value means a request with a larger value
|
||||
for the **skipCount** or the **maxItems** parameter will return more entities.
|
||||
| [default to null]
|
||||
**totalItems** | **number** | An integer describing the total number of entities in the collection.
|
||||
The API might not be able to determine this value,
|
||||
in which case this property will not be present.
|
||||
| [optional] [default to null]
|
||||
**skipCount** | **number** | An integer describing how many entities exist in the collection before
|
||||
those included in this list.
|
||||
| [default to null]
|
||||
**maxItems** | **number** | The value of the **maxItems** parameter used to generate this list,
|
||||
or if there was no **maxItems** parameter the default value is 100
|
||||
| [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
# Path
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# PathElement
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**name** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# SecurityControlSetting
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**key** | **string** | | [default to null]
|
||||
**value** | **any** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityControlSettingBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**value** | **any** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityControlSettingEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**SecurityControlSetting**](SecurityControlSetting.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
# SecurityControlSettingsApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getSecurityControlSetting**](SecurityControlSettingsApi.md#getSecurityControlSetting) | **GET** /security-control-settings/{securityControlSettingKey} | Get security control setting value
|
||||
[**updateSecurityControlSetting**](SecurityControlSettingsApi.md#updateSecurityControlSetting) | **PUT** /security-control-settings/{securityControlSettingKey} | Update security control setting value
|
||||
|
||||
|
||||
<a name="getSecurityControlSetting"></a>
|
||||
# **getSecurityControlSetting**
|
||||
> SecurityControlSettingEntry getSecurityControlSetting(securityControlSettingKey)
|
||||
|
||||
Get security control setting value
|
||||
|
||||
Gets the value for a selected **securityControlSettingKey**.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import SecurityControlSettingsApi from 'SecurityControlSettingsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let securitycontrolsettingsApi = new SecurityControlSettingsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
securitycontrolsettingsApi.getSecurityControlSetting(securityControlSettingKey).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**securityControlSettingKey** | **string**| The key for the security control setting. You can use one of the following settings:
|
||||
* -declassificationTimeFrame- for the declassification time frame value set in alfresco-global.properties file
|
||||
|
|
||||
|
||||
### Return type
|
||||
|
||||
[**SecurityControlSettingEntry**](SecurityControlSettingEntry.md)
|
||||
|
||||
<a name="updateSecurityControlSetting"></a>
|
||||
# **updateSecurityControlSetting**
|
||||
> SecurityControlSettingEntry updateSecurityControlSetting(securityControlSettingKeysecurityControlSettingValue)
|
||||
|
||||
Update security control setting value
|
||||
|
||||
Updates the value of a selected **securityControlSettingKey**.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import SecurityControlSettingsApi from 'SecurityControlSettingsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let securitycontrolsettingsApi = new SecurityControlSettingsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
securitycontrolsettingsApi.updateSecurityControlSetting(securityControlSettingKeysecurityControlSettingValue).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**securityControlSettingKey** | **string**| The key for the security control setting. You can use one of the following settings:
|
||||
* -declassificationTimeFrame- for the declassification time frame value set in alfresco-global.properties file
|
||||
|
|
||||
**securityControlSettingValue** | [**SecurityControlSettingBody**](SecurityControlSettingBody.md)| The new value for the security control setting. This can be a string or number, depending on the setting key. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**SecurityControlSettingEntry**](SecurityControlSettingEntry.md)
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# SecurityGroup
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**groupName** | **string** | | [default to null]
|
||||
**groupType** | **string** | | [default to null]
|
||||
**inUse** | **boolean** | | [default to null]
|
||||
@@ -0,0 +1,9 @@
|
||||
# SecurityGroupBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**groupName** | **string** | | [default to null]
|
||||
**groupType** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityMarkEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**SecurityGroup**](SecurityGroup.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityMarkPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**SecurityGroupPagingList**](SecurityGroupPaging_list.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# SecurityGroupPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**SecurityGroupEntry[]**](SecurityGroupEntry.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# SecurityMark
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**name** | **string** | | [default to null]
|
||||
**groupId** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityMarkBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityMarkEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**SecurityMark**](SecurityMark.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityMarkInformation
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**add** | [**SecurityMarks**](SecurityMarks.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityMarkInformationBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**add** | [**SecurityMarksBody**](SecurityMarksBody.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SecurityMarkPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**SecurityMarkPagingList**](SecurityMarkPaging_list.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# SecurityMarkPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**SecurityMarkEntry[]**](SecurityMarkEntry.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
# SecurityMarks
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
# SecurityMarksBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# SubtopicPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**TopicPagingList**](TopicPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
16
lib/js-api/src/api/gs-classification-rest-api/docs/Topic.md
Normal file
16
lib/js-api/src/api/gs-classification-rest-api/docs/Topic.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Topic
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**name** | **string** | | [default to null]
|
||||
**description** | **string** | | [optional] [default to null]
|
||||
**hasInstruction** | **boolean** | Flag indicating whether the topic has an instruction or not. | [default to null]
|
||||
**instruction** | [**Instruction**](Instruction.md) | | [optional] [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**hasSubtopics** | **boolean** | Flag indicating whether the topic has subtopics. This field is only included when requested. | [optional] [default to null]
|
||||
**path** | [**Path**](Path.md) | | [optional] [default to null]
|
||||
**classificationGuide** | [**ClassificationGuideInTopic**](ClassificationGuideInTopic.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# TopicBody
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [default to null]
|
||||
**description** | **string** | | [optional] [default to null]
|
||||
**instruction** | [**InstructionBody**](InstructionBody.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# TopicEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**Topic**](Topic.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# TopicPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**TopicPagingList**](TopicPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# TopicPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**TopicEntry[]**](TopicEntry.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user