inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

88
lib/js-api/src/api/gs-classification-rest-api/README.md Normal file
View File

@@ -0,0 +1,88 @@
Provides access to classification and security mark related features.
- Last Build date: 2018-11-05T11:25:29.023Z
## Documentation for API Endpoints
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*.ClassificationGuidesApi* | [**combinedInstructions**](docs/ClassificationGuidesApi.md#combinedInstructions) | **POST** /combined-instructions | Combined instructions
*.ClassificationGuidesApi* | [**createClassificationGuide**](docs/ClassificationGuidesApi.md#createClassificationGuide) | **POST** /classification-guides | Create a classification guide
*.ClassificationGuidesApi* | [**createSubtopic**](docs/ClassificationGuidesApi.md#createSubtopic) | **POST** /topics/{topicId}/subtopics | Create a subtopic
*.ClassificationGuidesApi* | [**createTopic**](docs/ClassificationGuidesApi.md#createTopic) | **POST** /classification-guides/{classificationGuideId}/topics | Create a topic
*.ClassificationGuidesApi* | [**deleteClassificationGuide**](docs/ClassificationGuidesApi.md#deleteClassificationGuide) | **DELETE** /classification-guides/{classificationGuideId} | Delete a classification guide
*.ClassificationGuidesApi* | [**deleteTopic**](docs/ClassificationGuidesApi.md#deleteTopic) | **DELETE** /topics/{topicId} | Delete a topic
*.ClassificationGuidesApi* | [**listClassificationGuides**](docs/ClassificationGuidesApi.md#listClassificationGuides) | **GET** /classification-guides | List all classification guides
*.ClassificationGuidesApi* | [**listSubtopics**](docs/ClassificationGuidesApi.md#listSubtopics) | **GET** /topics/{topicId}/subtopics | List all subtopics
*.ClassificationGuidesApi* | [**listTopics**](docs/ClassificationGuidesApi.md#listTopics) | **GET** /classification-guides/{classificationGuideId}/topics | List all topics
*.ClassificationGuidesApi* | [**showClassificationGuideById**](docs/ClassificationGuidesApi.md#showClassificationGuideById) | **GET** /classification-guides/{classificationGuideId} | Get classification guide information
*.ClassificationGuidesApi* | [**showTopicById**](docs/ClassificationGuidesApi.md#showTopicById) | **GET** /topics/{topicId} | Get topic information
*.ClassificationGuidesApi* | [**updateClassificationGuide**](docs/ClassificationGuidesApi.md#updateClassificationGuide) | **PUT** /classification-guides/{classificationGuideId} | Update a classification guide
*.ClassificationGuidesApi* | [**updateTopic**](docs/ClassificationGuidesApi.md#updateTopic) | **PUT** /topics/{topicId} | Update a topic
*.ClassificationReasonsApi* | [**createClassificationReason**](docs/ClassificationReasonsApi.md#createClassificationReason) | **POST** /classification-reasons | Create a classification reason
*.ClassificationReasonsApi* | [**deleteClassificationReason**](docs/ClassificationReasonsApi.md#deleteClassificationReason) | **DELETE** /classification-reasons/{classificationReasonId} | Delete a classification reason
*.ClassificationReasonsApi* | [**listClassificationReasons**](docs/ClassificationReasonsApi.md#listClassificationReasons) | **GET** /classification-reasons | List all classification reasons
*.ClassificationReasonsApi* | [**showClassificationReasonById**](docs/ClassificationReasonsApi.md#showClassificationReasonById) | **GET** /classification-reasons/{classificationReasonId} | Get classification reason information
*.ClassificationReasonsApi* | [**updateClassificationReason**](docs/ClassificationReasonsApi.md#updateClassificationReason) | **PUT** /classification-reasons/{classificationReasonId} | Update a classification reason
*.DeclassificationExemptionsApi* | [**createDeclassificationExemption**](docs/DeclassificationExemptionsApi.md#createDeclassificationExemption) | **POST** /declassification-exemptions | Create a declassification exemption
*.DeclassificationExemptionsApi* | [**deleteDeclassificationExemption**](docs/DeclassificationExemptionsApi.md#deleteDeclassificationExemption) | **DELETE** /declassification-exemptions/{declassificationExemptionId} | Delete a declassification exemption
*.DeclassificationExemptionsApi* | [**listDeclassificationExemptions**](docs/DeclassificationExemptionsApi.md#listDeclassificationExemptions) | **GET** /declassification-exemptions | List all declassification exemptions
*.DeclassificationExemptionsApi* | [**showDeclassificationExemptionById**](docs/DeclassificationExemptionsApi.md#showDeclassificationExemptionById) | **GET** /declassification-exemptions/{declassificationExemptionId} | Get declassification exemption information
*.DeclassificationExemptionsApi* | [**updateDeclassificationExemption**](docs/DeclassificationExemptionsApi.md#updateDeclassificationExemption) | **PUT** /declassification-exemptions/{declassificationExemptionId} | Update a declassification exemption
*.DefaultClassificationValuesApi* | [**calculateDefaultDeclassificationDate**](docs/DefaultClassificationValuesApi.md#calculateDefaultDeclassificationDate) | **POST** /default-classification-values/{nodeId}/calculate-declassification-date | Calculate the default declassification date
*.SecurityControlSettingsApi* | [**getSecurityControlSetting**](docs/SecurityControlSettingsApi.md#getSecurityControlSetting) | **GET** /security-control-settings/{securityControlSettingKey} | Get security control setting value
*.SecurityControlSettingsApi* | [**updateSecurityControlSetting**](docs/SecurityControlSettingsApi.md#updateSecurityControlSetting) | **PUT** /security-control-settings/{securityControlSettingKey} | Update security control setting value
## Documentation for Models
- [ClassificationGuideBody](docs/ClassificationGuideBody.md)
- [ClassificationGuideEntry](docs/ClassificationGuideEntry.md)
- [ClassificationGuidePaging](docs/ClassificationGuidePaging.md)
- [ClassificationGuidePagingList](docs/ClassificationGuidePagingList.md)
- [ClassificationGuidesBody](docs/ClassificationGuidesBody.md)
- [ClassificationGuidesEntry](docs/ClassificationGuidesEntry.md)
- [ClassificationInformation](docs/ClassificationInformation.md)
- [ClassificationReason](docs/ClassificationReason.md)
- [ClassificationReasonBody](docs/ClassificationReasonBody.md)
- [ClassificationReasonEntry](docs/ClassificationReasonEntry.md)
- [ClassificationReasonsPaging](docs/ClassificationReasonsPaging.md)
- [ClassificationReasonsPagingList](docs/ClassificationReasonsPagingList.md)
- [DeclassificationDate](docs/DeclassificationDate.md)
- [DeclassificationExemption](docs/DeclassificationExemption.md)
- [DeclassificationExemptionBody](docs/DeclassificationExemptionBody.md)
- [DeclassificationExemptionEntry](docs/DeclassificationExemptionEntry.md)
- [DeclassificationExemptionsPaging](docs/DeclassificationExemptionsPaging.md)
- [DeclassificationExemptionsPagingList](docs/DeclassificationExemptionsPagingList.md)
- [ErrorError](docs/ErrorError.md)
- [Instruction](docs/Instruction.md)
- [InstructionBody](docs/InstructionBody.md)
- [InstructionEntry](docs/InstructionEntry.md)
- [ModelError](docs/ModelError.md)
- [Pagination](docs/Pagination.md)
- [Path](docs/Path.md)
- [PathElement](docs/PathElement.md)
- [SecurityControlSetting](docs/SecurityControlSetting.md)
- [SecurityControlSettingBody](docs/SecurityControlSettingBody.md)
- [SecurityControlSettingEntry](docs/SecurityControlSettingEntry.md)
- [SecurityMark](docs/SecurityMark.md)
- [SecurityMarkBody](docs/SecurityMarkBody.md)
- [SecurityMarkInformation](docs/SecurityMarkInformation.md)
- [SecurityMarkInformationBody](docs/SecurityMarkInformationBody.md)
- [SecurityMarks](docs/SecurityMarks.md)
- [SecurityMarksBody](docs/SecurityMarksBody.md)
- [SubtopicPaging](docs/SubtopicPaging.md)
- [Topic](docs/Topic.md)
- [TopicBody](docs/TopicBody.md)
- [TopicEntry](docs/TopicEntry.md)
- [TopicPaging](docs/TopicPaging.md)
- [TopicPagingList](docs/TopicPagingList.md)
- [ClassificationGuideInTopic](docs/ClassificationGuideInTopic.md)
- [ClassificationGuidesInTopic](docs/ClassificationGuidesInTopic.md)
- [CombinedInstructionBody](docs/CombinedInstructionBody.md)
- [ClassificationGuide](docs/ClassificationGuide.md)
- [ClassificationGuides](docs/ClassificationGuides.md)

63
lib/js-api/src/api/gs-classification-rest-api/api/authorityClearance.api.ts Normal file
View File

@@ -0,0 +1,63 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { BaseApi } from './base.api';
import { AuthorityClearanceGroupPaging, NodeSecurityMarkBody, SecurityMarkEntry, SecurityMarkPaging } from '../model';
import { GsPagingQuery } from './types';
/**
* AuthorityClearanceApi service.
*/
export class AuthorityClearanceApi extends BaseApi {
/**
* Get the authority clearances for a single user/group
*
* @param authorityId The name for the authority for which the clearance is to be fetched. Can be left blank in which case it will fetch it for all users with pagination
* @param opts Optional parameters
* @returns Promise<AuthorityClearanceGroupPaging>
*/
getAuthorityClearanceForAuthority(authorityId: string, opts?: GsPagingQuery): Promise<AuthorityClearanceGroupPaging> {
const pathParams = {
authorityId
};
return this.get({
path: '/cleared-authorities/{authorityId}/clearing-marks',
pathParams,
queryParams: opts
});
}
/**
* Updates the authority clearance.
*
* @param authorityId The name for the authority for which the clearance is to be updated
* @param authorityClearance AuthorityClearanceBody
* @returns Promise<SecurityMarkEntry | SecurityMarkPaging>
*/
updateAuthorityClearance(authorityId: string, authorityClearance: NodeSecurityMarkBody[]): Promise<SecurityMarkEntry | SecurityMarkPaging> {
const pathParams = {
authorityId
};
return this.post({
path: '/cleared-authorities/{authorityId}/clearing-marks',
pathParams,
bodyParam: authorityClearance
});
}
}

25
lib/js-api/src/api/gs-classification-rest-api/api/base.api.ts Normal file
View File

@@ -0,0 +1,25 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ApiClient } from '../../../api-clients/api-client';
import { LegacyHttpClient } from '../../../api-clients/http-client.interface';
export abstract class BaseApi extends ApiClient {
override get apiClient(): LegacyHttpClient {
return this.httpClient ?? this.alfrescoApi.gsClient;
}
}

393
lib/js-api/src/api/gs-classification-rest-api/api/classificationGuides.api.ts Normal file
View File

@@ -0,0 +1,393 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
ClassificationGuideBody,
ClassificationGuideEntry,
ClassificationGuidePaging,
InstructionEntry,
SubtopicPaging,
TopicBody,
TopicEntry,
TopicPaging
} from '../model';
import { BaseApi } from './base.api';
import { buildCollectionParam } from '../../../alfrescoApiClient';
import { throwIfNotDefined } from '../../../assert';
import { GsIncludeQuery, GsPagingQuery } from './types';
export interface CombinedInstructionsOpts {
instructions?: any;
}
/**
* ClassificationGuidesApi service.
*/
export class ClassificationGuidesApi extends BaseApi {
/**
* Combines instructions from the given topics and the user defined instruction, if any.
*
* @param opts Optional parameters
* @param opts.instructions Instructions
* @returns Promise<InstructionEntry>
*/
combinedInstructions(opts?: CombinedInstructionsOpts): Promise<InstructionEntry> {
return this.post({
path: '/combined-instructions',
bodyParam: opts?.instructions
});
}
/**
* Create a classification guide
*
* @param classificationGuide Classification guide
* @returns Promise<ClassificationGuideEntry>
*/
createClassificationGuide(classificationGuide: ClassificationGuideBody): Promise<ClassificationGuideEntry> {
throwIfNotDefined(classificationGuide, 'classificationGuide');
return this.post({
path: '/classification-guides',
bodyParam: classificationGuide
});
}
/**
* Create a subtopic
*
* @param topicId The identifier for the topic
* @param topic Subtopic
* @param opts Optional parameters
* @returns Promise<TopicEntry>
*/
createSubtopic(topicId: string, topic: TopicBody, opts?: GsIncludeQuery): Promise<TopicEntry> {
throwIfNotDefined(topicId, 'topicId');
throwIfNotDefined(topic, 'topic');
const pathParams = {
topicId
};
const queryParams = {
include: buildCollectionParam(opts?.include, 'csv')
};
return this.post({
path: '/topics/{topicId}/subtopics',
pathParams,
queryParams,
bodyParam: topic,
returnType: TopicEntry
});
}
/**
* Create a topic
*
* @param classificationGuideId The identifier for the classification guide
* @param topic Topic
* @param opts Optional parameters
* @returns Promise<TopicEntry>
*/
createTopic(classificationGuideId: string, topic: TopicBody, opts?: GsIncludeQuery): Promise<TopicEntry> {
throwIfNotDefined(classificationGuideId, 'classificationGuideId');
throwIfNotDefined(topic, 'topic');
const pathParams = {
classificationGuideId
};
const queryParams = {
include: buildCollectionParam(opts?.include, 'csv')
};
return this.post({
path: '/classification-guides/{classificationGuideId}/topics',
pathParams,
queryParams,
bodyParam: topic,
returnType: TopicEntry
});
}
/**
* Delete a classification guide
*
* @param classificationGuideId The identifier for the classification guide
* @returns Promise<{}>
*/
deleteClassificationGuide(classificationGuideId: string): Promise<void> {
throwIfNotDefined(classificationGuideId, 'classificationGuideId');
const pathParams = {
classificationGuideId
};
return this.delete({
path: '/classification-guides/{classificationGuideId}',
pathParams
});
}
/**
* Delete a topic
*
* @param topicId The identifier for the topic
* @returns Promise<{}>
*/
deleteTopic(topicId: string): Promise<void> {
throwIfNotDefined(topicId, 'topicId');
const pathParams = {
topicId
};
return this.delete({
path: '/topics/{topicId}',
pathParams
});
}
/**
* List all classification guides
*
* @param opts Optional parameters
* @param opts.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.
* @param opts.where 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)
* @returns Promise<ClassificationGuidePaging>
*/
listClassificationGuides(opts?: { orderBy?: string[]; where?: string } & GsPagingQuery & GsIncludeQuery): Promise<ClassificationGuidePaging> {
opts = opts || {};
const queryParams = {
include: buildCollectionParam(opts?.include, 'csv'),
skipCount: opts?.skipCount,
maxItems: opts?.maxItems,
orderBy: buildCollectionParam(opts?.orderBy, 'csv'),
where: opts?.where
};
return this.get({
path: '/classification-guides',
queryParams
});
}
/**
* List all subtopics
*
* @param topicId The identifier for the topic
* @param opts Optional parameters
* @param opts.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.
* @param opts.where A string to restrict the returned objects by using a predicate. Supported operations are AND, NOT, and OR. Fields to filter on:
* - hasInstruction
* - hasSubtopics
* @param opts.includeSource Also include **source** in addition to **entries** with folder information on the parent guide/topic
* @returns Promise<SubtopicPaging>
*/
listSubtopics(
topicId: string,
opts?: {
orderBy?: string[];
where?: string;
includeSource?: boolean;
} & GsPagingQuery &
GsIncludeQuery
): Promise<SubtopicPaging> {
throwIfNotDefined(topicId, 'topicId');
opts = opts || {};
const pathParams = {
topicId
};
const queryParams = {
include: buildCollectionParam(opts?.include, 'csv'),
skipCount: opts?.skipCount,
maxItems: opts?.maxItems,
orderBy: buildCollectionParam(opts?.orderBy, 'csv'),
where: opts?.where,
includeSource: opts?.includeSource
};
return this.get({
path: '/topics/{topicId}/subtopics',
pathParams,
queryParams,
returnType: SubtopicPaging
});
}
/**
* List all topics
*
* @param classificationGuideId The identifier for the classification guide
* @param opts Optional parameters
* @param opts.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.
* @param opts.where 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
* @param opts.includeSource Also include **source** in addition to **entries** with folder information on the parent guide/topic
* @returns Promise<TopicPaging>
*/
listTopics(
classificationGuideId: string,
opts?: {
orderBy?: string[];
where?: string;
includeSource?: boolean;
} & GsPagingQuery &
GsIncludeQuery
): Promise<TopicPaging> {
throwIfNotDefined(classificationGuideId, 'classificationGuideId');
opts = opts || {};
const pathParams = {
classificationGuideId
};
const queryParams = {
include: buildCollectionParam(opts?.include, 'csv'),
skipCount: opts?.skipCount,
maxItems: opts?.maxItems,
orderBy: buildCollectionParam(opts?.orderBy, 'csv'),
where: opts?.where,
includeSource: opts?.includeSource
};
return this.get({
path: '/classification-guides/{classificationGuideId}/topics',
pathParams,
queryParams,
returnType: TopicPaging
});
}
/**
* Get classification guide information
*
* @param classificationGuideId The identifier for the classification guide
* @returns Promise<ClassificationGuideEntry>
*/
showClassificationGuideById(classificationGuideId: string): Promise<ClassificationGuideEntry> {
throwIfNotDefined(classificationGuideId, 'classificationGuideId');
const pathParams = {
classificationGuideId
};
return this.get({
path: '/classification-guides/{classificationGuideId}',
pathParams
});
}
/**
* Get topic information
*
* @param topicId The identifier for the topic
* @param opts Optional parameters
* @returns Promise<TopicEntry>
*/
showTopicById(topicId: string, opts?: GsIncludeQuery): Promise<TopicEntry> {
throwIfNotDefined(topicId, 'topicId');
const pathParams = {
topicId
};
const queryParams = {
include: buildCollectionParam(opts?.include, 'csv')
};
return this.post({
path: '/topics/{topicId}',
pathParams,
queryParams,
returnType: TopicEntry
});
}
/**
* Update a classification guide
*
* Updates the classification guide with id **classificationGuideId**. For example, you can rename a classification guide.
*
* @param classificationGuideId The identifier for the classification guide
* @param classificationGuide Classification guide
* @returns Promise<ClassificationGuideEntry>
*/
updateClassificationGuide(classificationGuideId: string, classificationGuide: ClassificationGuideBody): Promise<ClassificationGuideEntry> {
throwIfNotDefined(classificationGuideId, 'classificationGuideId');
throwIfNotDefined(classificationGuide, 'classificationGuide');
const pathParams = {
classificationGuideId
};
return this.put({
path: '/classification-guides/{classificationGuideId}',
pathParams,
bodyParam: classificationGuide
});
}
/**
* 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.
*
* @param topicId The identifier for the topic
* @param topic Topic
* @param opts Optional parameters
* @returns Promise<TopicEntry>
*/
updateTopic(topicId: string, topic: TopicBody, opts?: GsIncludeQuery): Promise<TopicEntry> {
throwIfNotDefined(topicId, 'topicId');
throwIfNotDefined(topic, 'topic');
const pathParams = {
topicId
};
const queryParams = {
include: buildCollectionParam(opts?.include, 'csv')
};
return this.put({
path: '/topics/{topicId}',
pathParams,
queryParams,
bodyParam: topic,
returnType: TopicEntry
});
}
}

126
lib/js-api/src/api/gs-classification-rest-api/api/classificationReasons.api.ts Normal file
View File

@@ -0,0 +1,126 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClassificationReasonBody, ClassificationReasonEntry, ClassificationReasonsPaging } from '../model';
import { BaseApi } from './base.api';
import { buildCollectionParam } from '../../../alfrescoApiClient';
import { throwIfNotDefined } from '../../../assert';
import { GsFieldsQuery, GsPagingQuery } from './types';
/**
* ClassificationReasonsApi service.
*/
export class ClassificationReasonsApi extends BaseApi {
/**
* Creates a new classification reason.
*
* **Note:** You can create more than one reason by specifying a list of reasons in the JSON body.
*
* @param classificationReason Classification reason
* @returns Promise<ClassificationReasonEntry>
*/
createClassificationReason(classificationReason: ClassificationReasonBody): Promise<ClassificationReasonEntry> {
throwIfNotDefined(classificationReason, 'classificationReason');
return this.post({
path: '/classification-reasons',
bodyParam: classificationReason
});
}
/**
* 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.
*
* @param classificationReasonId The identifier for the classification reason
* @returns Promise<{}>
*/
deleteClassificationReason(classificationReasonId: string): Promise<void> {
throwIfNotDefined(classificationReasonId, 'classificationReasonId');
const pathParams = {
classificationReasonId
};
return this.delete({
path: '/classification-reasons/{classificationReasonId}',
pathParams
});
}
/**
* List all classification reasons
*
* @param opts Optional parameters
* @returns Promise<ClassificationReasonsPaging>
*/
listClassificationReasons(opts?: GsPagingQuery & GsFieldsQuery): Promise<ClassificationReasonsPaging> {
const queryParams = {
skipCount: opts?.skipCount,
maxItems: opts?.maxItems,
fields: buildCollectionParam(opts?.fields, 'csv')
};
return this.get({
path: '/classification-reasons',
queryParams
});
}
/**
* Get classification reason information
*
* @param classificationReasonId The identifier for the classification reason
* @returns Promise<ClassificationReasonEntry>
*/
showClassificationReasonById(classificationReasonId: string): Promise<ClassificationReasonEntry> {
throwIfNotDefined(classificationReasonId, 'classificationReasonId');
const pathParams = {
classificationReasonId
};
return this.get({
path: '/classification-reasons/{classificationReasonId}',
pathParams
});
}
/**
* Updates the classification reason with id **classificationReasonId**. For example, you can change a classification reason code or description.
*
* @param classificationReasonId The identifier for the classification reason
* @param classificationReason Classification reason
* @returns Promise<ClassificationReasonEntry>
*/
updateClassificationReason(classificationReasonId: string, classificationReason: ClassificationReasonBody): Promise<ClassificationReasonEntry> {
throwIfNotDefined(classificationReasonId, 'classificationReasonId');
throwIfNotDefined(classificationReason, 'classificationReason');
const pathParams = {
classificationReasonId
};
return this.put({
path: '/classification-reasons/{classificationReasonId}',
pathParams,
bodyParam: classificationReason
});
}
}

118
lib/js-api/src/api/gs-classification-rest-api/api/declassificationExemptions.api.ts Normal file
View File

@@ -0,0 +1,118 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DeclassificationExemptionBody, DeclassificationExemptionEntry, DeclassificationExemptionsPaging } from '../model';
import { BaseApi } from './base.api';
import { throwIfNotDefined } from '../../../assert';
import { GsPagingQuery } from './types';
/**
* DeclassificationExemptionsApi service.
*/
export class DeclassificationExemptionsApi extends BaseApi {
/**
* Create a declassification exemption
*
* @param declassificationExemption Declassification exemption
* @returns Promise<DeclassificationExemptionEntry>
*/
createDeclassificationExemption(declassificationExemption: DeclassificationExemptionBody): Promise<DeclassificationExemptionEntry> {
throwIfNotDefined(declassificationExemption, 'declassificationExemption');
return this.post({
path: '/declassification-exemptions',
bodyParam: declassificationExemption
});
}
/**
* Deletes the declassification exemption with id **declassificationExemptionId**.
* You can't delete a classification exemption that is being used to classify content.
*
* @param declassificationExemptionId The identifier for the declassification exemption
* @returns Promise<{}>
*/
deleteDeclassificationExemption(declassificationExemptionId: string): Promise<void> {
throwIfNotDefined(declassificationExemptionId, 'declassificationExemptionId');
const pathParams = {
declassificationExemptionId
};
return this.delete({
path: '/declassification-exemptions/{declassificationExemptionId}',
pathParams
});
}
/**
* List all declassification exemptions
*
* @param opts Optional parameters
* @returns Promise<DeclassificationExemptionsPaging>
*/
listDeclassificationExemptions(opts?: GsPagingQuery): Promise<DeclassificationExemptionsPaging> {
return this.get({
path: '/declassification-exemptions',
queryParams: opts
});
}
/**
* Get declassification exemption information
*
* @param declassificationExemptionId The identifier for the declassification exemption
* @returns Promise<DeclassificationExemptionEntry>
*/
showDeclassificationExemptionById(declassificationExemptionId: string): Promise<DeclassificationExemptionEntry> {
throwIfNotDefined(declassificationExemptionId, 'declassificationExemptionId');
const pathParams = {
declassificationExemptionId
};
return this.get({
path: '/declassification-exemptions/{declassificationExemptionId}',
pathParams
});
}
/**
* Update a declassification exemption
*
* @param declassificationExemptionId The identifier for the declassification exemption
* @param declassificationExemption Declassification exemption
* @returns Promise<DeclassificationExemptionEntry>
*/
updateDeclassificationExemption(
declassificationExemptionId: string,
declassificationExemption: DeclassificationExemptionBody
): Promise<DeclassificationExemptionEntry> {
throwIfNotDefined(declassificationExemptionId, 'declassificationExemptionId');
throwIfNotDefined(declassificationExemption, 'declassificationExemption');
const pathParams = {
declassificationExemptionId
};
return this.put({
path: '/declassification-exemptions/{declassificationExemptionId}',
pathParams,
bodyParam: declassificationExemption
});
}
}

46
lib/js-api/src/api/gs-classification-rest-api/api/defaultClassificationValues.api.ts Normal file
View File

@@ -0,0 +1,46 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { DeclassificationDate } from '../model';
import { BaseApi } from './base.api';
import { DateAlfresco } from '../../content-custom-api';
import { throwIfNotDefined } from '../../../assert';
/**
* DefaultClassificationValuesApi service.
*/
export class DefaultClassificationValuesApi extends BaseApi {
/**
* Calculates the default declassification date for **nodeId** based on the properties of the node and the current declassification time frame.
*
* @param nodeId The identifier of a node.
* @returns Promise<DeclassificationDate>
*/
calculateDefaultDeclassificationDate(nodeId: string): Promise<DeclassificationDate> {
throwIfNotDefined(nodeId, 'nodeId');
const pathParams = {
nodeId
};
return this.post({
path: '/default-classification-values/{nodeId}/calculate-declassification-date',
pathParams,
returnType: DateAlfresco
});
}
}

27
lib/js-api/src/api/gs-classification-rest-api/api/index.ts Normal file
View File

@@ -0,0 +1,27 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export * from './types';
export * from './classificationGuides.api';
export * from './classificationReasons.api';
export * from './declassificationExemptions.api';
export * from './defaultClassificationValues.api';
export * from './securityControlSettings.api';
export * from './securityMarks.api';
export * from './securityGroups.api';
export * from './nodeSecurityMarks.api';
export * from './authorityClearance.api';

70
lib/js-api/src/api/gs-classification-rest-api/api/nodeSecurityMarks.api.ts Normal file
View File

@@ -0,0 +1,70 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { BaseApi } from './base.api';
import { throwIfNotDefined } from '../../../assert';
import { NodeSecurityMarkBody } from '../model/nodeSecurityMarkBody';
import { SecurityMarkPaging } from '../model/securityMarkPaging';
import { GsPagingQuery } from './types';
/**
* NodeSecurityMarksApi
*/
export class NodeSecurityMarksApi extends BaseApi {
/**
* Add/Remove security mark on a node
*
* @param nodeId The key for the node id.
* @param dataBody Array of NodeSecurityMarkBody.
* @returns Promise<SecurityMarkPaging>
*/
manageSecurityMarksOnNode(nodeId: string, dataBody: Array<NodeSecurityMarkBody>): Promise<SecurityMarkPaging> {
throwIfNotDefined(nodeId, 'nodeId');
throwIfNotDefined(dataBody, 'dataBody');
const pathParams = {
nodeId
};
return this.post({
path: '/secured-nodes/{nodeId}/securing-marks',
pathParams,
bodyParam: dataBody
});
}
/**
* Get security marks on a node
*
* @param nodeId The key for the node id.
* @param opts Optional parameters
* @returns Promise<SecurityMarkPaging>
*/
getSecurityMarksOnNode(nodeId: string, opts?: GsPagingQuery): Promise<SecurityMarkPaging> {
throwIfNotDefined(nodeId, 'nodeId');
const pathParams = {
nodeId
};
return this.get({
path: '/secured-nodes/{nodeId}/securing-marks',
pathParams,
queryParams: opts
});
}
}

73
lib/js-api/src/api/gs-classification-rest-api/api/securityControlSettings.api.ts Normal file
View File

@@ -0,0 +1,73 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { SecurityControlSettingBody, SecurityControlSettingEntry } from '../model';
import { BaseApi } from './base.api';
import { throwIfNotDefined } from '../../../assert';
/**
* SecurityControlSettingsApi service.
*
* @module SecurityControlSettingsApi
*/
export class SecurityControlSettingsApi extends BaseApi {
/**
* Get security control setting value
*
* @param securityControlSettingKey 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
* @returns Promise<SecurityControlSettingEntry>
*/
getSecurityControlSetting(securityControlSettingKey: string): Promise<SecurityControlSettingEntry> {
throwIfNotDefined(securityControlSettingKey, 'securityControlSettingKey');
const pathParams = {
securityControlSettingKey
};
return this.get({
path: '/security-control-settings/{securityControlSettingKey}',
pathParams
});
}
/**
* Update security control setting value
*
* @param securityControlSettingKey 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
* @param securityControlSettingValue The new value for the security control setting. This can be a string or number, depending on the setting key.
* @returns Promise<SecurityControlSettingEntry>
*/
updateSecurityControlSetting(
securityControlSettingKey: string,
securityControlSettingValue: SecurityControlSettingBody
): Promise<SecurityControlSettingEntry> {
throwIfNotDefined(securityControlSettingKey, 'securityControlSettingKey');
throwIfNotDefined(securityControlSettingValue, 'securityControlSettingValue');
const pathParams = {
securityControlSettingKey
};
return this.put({
path: '/security-control-settings/{securityControlSettingKey}',
pathParams,
bodyParam: securityControlSettingValue
});
}
}

109
lib/js-api/src/api/gs-classification-rest-api/api/securityGroups.api.ts Normal file
View File

@@ -0,0 +1,109 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { BaseApi } from './base.api';
import { SecurityGroupBody, SecurityGroupEntry, SecurityGroupPaging } from '../model';
import { GsGroupInclude, GsPagingQuery } from './types';
/**
* SecurityGroupsApi service.
*
* @module SecurityGroupsApi
*/
export class SecurityGroupsApi extends BaseApi {
/**
* Get All security groups
*
* @param opts Optional parameters
* @returns Promise<SecurityGroupPaging>
*/
getSecurityGroups(opts?: GsPagingQuery & GsGroupInclude): Promise<SecurityGroupPaging> {
return this.get({
path: '/security-groups',
queryParams: opts
});
}
/**
* Create security group
*
* @param securityGroupBody securityGroupBody.
* @param opts Optional parameters
* @returns Promise<SecurityGroupEntry>
*/
createSecurityGroup(securityGroupBody: SecurityGroupBody, opts?: GsGroupInclude): Promise<SecurityGroupEntry> {
return this.post({
path: '/security-groups',
queryParams: opts,
bodyParam: securityGroupBody
});
}
/**
* Get a security groups information
*
* @param securityGroupId The Key of Security Group id for which info is required
* @param opts Optional parameters
* @returns Promise<SecurityGroupEntry>
*/
getSecurityGroupInfo(securityGroupId: string, opts?: GsGroupInclude): Promise<SecurityGroupEntry> {
const pathParams = {
securityGroupId
};
return this.get({
path: '/security-groups/{securityGroupId}',
pathParams,
queryParams: opts
});
}
/**
* Update a security groups information
*
* @param securityGroupId The Key of Security Group id for which info is required
* @param securityGroupBody SecurityGroupBody
* @param opts Optional parameters
* @returns Promise<SecurityGroupEntry>
*/
updateSecurityGroup(securityGroupId: string, securityGroupBody: SecurityGroupBody, opts?: GsGroupInclude): Promise<SecurityGroupEntry> {
const pathParams = {
securityGroupId
};
return this.put({
path: '/security-groups/{securityGroupId}',
pathParams,
queryParams: opts,
bodyParam: securityGroupBody
});
}
/**
* Delete security group
*
* @param securityGroupId The key for the security group id.
* @returns Promise<SecurityMarkEntry>
*/
deleteSecurityGroup(securityGroupId: string): Promise<void> {
const pathParams = { securityGroupId };
return this.delete({
path: '/security-groups/{securityGroupId}',
pathParams
});
}
}

138
lib/js-api/src/api/gs-classification-rest-api/api/securityMarks.api.ts Normal file
View File

@@ -0,0 +1,138 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { BaseApi } from './base.api';
import { throwIfNotDefined } from '../../../assert';
import { SecurityMarkBody, SecurityMarkEntry, SecurityMarkPaging } from '../model';
import { GsPagingQuery } from './types';
/**
* Security Marks API.
*
* @module SecurityMarksApi
*/
export class SecurityMarksApi extends BaseApi {
/**
* Get security mark value
*
* @param securityGroupId The key for the security group id.
* @param opts Options
* @returns Promise<SecurityMarkPaging>
*/
getSecurityMarks(securityGroupId: string, opts?: GsPagingQuery): Promise<SecurityMarkPaging> {
throwIfNotDefined(securityGroupId, 'securityGroupId');
const pathParams = {
securityGroupId
};
return this.get({
path: '/security-groups/{securityGroupId}/security-marks',
pathParams,
queryParams: opts
});
}
/**
* Create security marks
*
* @param securityGroupId The key for the security group id.
* @param securityMarkBody securityMarkBody[].
* @returns Promise<SecurityMarkEntry|SecurityMarkPaging>
*/
createSecurityMarks(securityGroupId: string, securityMarkBody: SecurityMarkBody[]): Promise<SecurityMarkPaging | SecurityMarkEntry> {
throwIfNotDefined(securityGroupId, 'securityGroupId');
throwIfNotDefined(securityMarkBody, 'securityMarkBody');
const pathParams = { securityGroupId };
return this.post({
path: '/security-groups/{securityGroupId}/security-marks',
pathParams,
bodyParam: securityMarkBody
});
}
/**
* Get security mark value information
*
* @param securityGroupId The key for the security group id.
* @param securityMarkId The key for the security mark id
* @returns Promise<SecurityMarkEntry>
*/
getSecurityMark(securityGroupId: string, securityMarkId: string): Promise<SecurityMarkEntry> {
throwIfNotDefined(securityGroupId, 'securityGroupId');
throwIfNotDefined(securityMarkId, 'securityMarkId');
const pathParams = {
securityGroupId,
securityMarkId
};
return this.get({
path: '/security-groups/{securityGroupId}/security-marks/{securityMarkId}',
pathParams
});
}
/**
* Updates Security Mark value
*
* @param securityGroupId The key for the security group id.
* @param securityMarkId The key for the security mark is in use or not.
* @param securityMarkBody securityMarkBody.
* @returns Promise<SecurityMarkEntry>
*/
updateSecurityMark(securityGroupId: string, securityMarkId: string, securityMarkBody: SecurityMarkBody): Promise<SecurityMarkEntry> {
throwIfNotDefined(securityGroupId, 'securityGroupId');
throwIfNotDefined(securityMarkId, 'securityMarkId');
throwIfNotDefined(securityMarkBody, 'securityMarkBody');
const pathParams = {
securityGroupId,
securityMarkId
};
return this.put({
path: '/security-groups/{securityGroupId}/security-marks/{securityMarkId}',
pathParams,
bodyParam: securityMarkBody
});
}
/**
* Delete security mark
*
* @param securityGroupId The key for the security group id.
* @param securityMarkId The key for the security mark id.
* @returns Promise<any>
*/
deleteSecurityMark(securityGroupId: string, securityMarkId: string): Promise<SecurityMarkEntry> {
throwIfNotDefined(securityGroupId, 'securityGroupId');
throwIfNotDefined(securityMarkId, 'securityMarkId');
const pathParams = {
securityGroupId,
securityMarkId
};
return this.delete({
path: '/security-groups/{securityGroupId}/security-marks/{securityMarkId}',
pathParams
});
}
}

60
lib/js-api/src/api/gs-classification-rest-api/api/types.ts Normal file
View File

@@ -0,0 +1,60 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export type GsGroupInclude = {
/**
* Returns additional information about the security group. The following optional fields can be requested:
* - inUse - A flag indicating whether the security group is in use or not.
*/
include?: string;
};
export type GsPagingQuery = {
/**
* The number of entities that exist in the collection before those included in this list.
*/
skipCount?: number;
/**
* The maximum number of items to return in the list.
*/
maxItems?: number;
};
export type GsFieldsQuery = {
/**
* 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.
*/
fields?: string[];
};
export type GsIncludeQuery = {
/**
* Returns additional information about the record. Any optional field from the response model can be requested.
*/
include?: string[];
};

10
lib/js-api/src/api/gs-classification-rest-api/docs/AuthorityClearanceGroup.md Normal file
View File

@@ -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] |

8
lib/js-api/src/api/gs-classification-rest-api/docs/AuthorityClearanceGroupEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# AuthorityClearanceGroupEntry
## Properties
| Name | Type | Description | Notes |
|-----------|-----------------------------------------------------------|-------------|-------------------|
| **entry** | [**AuthorityClearanceGroup**](AuthorityClearanceGroup.md) | | [default to null] |

8
lib/js-api/src/api/gs-classification-rest-api/docs/AuthorityClearanceGroupPaging.md Normal file
View File

@@ -0,0 +1,8 @@
# AuthorityClearanceGroupPaging
## Properties
| Name | Type | Description | Notes |
|----------|--------------------------------------------------------------------------------|-------------|------------------------------|
| **list** | [**AuthorityClearanceGroupPagingList**](AuthorityClearanceGroupPaging_list.md) | | [optional] [default to null] |

9
lib/js-api/src/api/gs-classification-rest-api/docs/AuthorityClearanceGroupPaging_list.md Normal file
View File

@@ -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] |

9
lib/js-api/src/api/gs-classification-rest-api/docs/AuthorityClearanceMark.md Normal file
View File

@@ -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] |

11
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuide.md Normal file
View File

@@ -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]

11
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuideBody.md Normal file
View File

@@ -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]

8
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuideEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# ClassificationGuideEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**ClassificationGuide**](ClassificationGuide.md) | | [default to null]

11
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuideInTopic.md Normal file
View File

@@ -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]

8
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuidePaging.md Normal file
View File

@@ -0,0 +1,8 @@
# ClassificationGuidePaging
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**ClassificationGuidePagingList**](ClassificationGuidePagingList.md) | | [optional] [default to null]

9
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuidePaging_list.md Normal file
View File

@@ -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]

12
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuides.md Normal file
View File

@@ -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]

715
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuidesApi.md Normal file
View File

@@ -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)

12
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuidesBody.md Normal file
View File

@@ -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]

8
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuidesEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# ClassificationGuidesEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**ClassificationGuides**](ClassificationGuides.md) | | [default to null]

12
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationGuidesInTopic.md Normal file
View File

@@ -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]

16
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationInformation.md Normal file
View File

@@ -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]

10
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationReason.md Normal file
View File

@@ -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]

9
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationReasonBody.md Normal file
View File

@@ -0,0 +1,9 @@
# ClassificationReasonBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **string** | | [default to null]
**description** | **string** | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationReasonEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# ClassificationReasonEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**ClassificationReason**](ClassificationReason.md) | | [default to null]

281
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationReasonsApi.md Normal file
View File

@@ -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)

8
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationReasonsPaging.md Normal file
View File

@@ -0,0 +1,8 @@
# ClassificationReasonsPaging
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**ClassificationReasonsPagingList**](ClassificationReasonsPagingList.md) | | [optional] [default to null]

9
lib/js-api/src/api/gs-classification-rest-api/docs/ClassificationReasonsPaging_list.md Normal file
View File

@@ -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]

9
lib/js-api/src/api/gs-classification-rest-api/docs/CombinedInstructionBody.md Normal file
View File

@@ -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]

7
lib/js-api/src/api/gs-classification-rest-api/docs/DeclassificationDate.md Normal file
View File

@@ -0,0 +1,7 @@
# DeclassificationDate
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

10
lib/js-api/src/api/gs-classification-rest-api/docs/DeclassificationExemption.md Normal file
View File

@@ -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]

9
lib/js-api/src/api/gs-classification-rest-api/docs/DeclassificationExemptionBody.md Normal file
View File

@@ -0,0 +1,9 @@
# DeclassificationExemptionBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **string** | | [default to null]
**description** | **string** | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/DeclassificationExemptionEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# DeclassificationExemptionEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**DeclassificationExemption**](DeclassificationExemption.md) | | [default to null]

257
lib/js-api/src/api/gs-classification-rest-api/docs/DeclassificationExemptionsApi.md Normal file
View File

@@ -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)

8
lib/js-api/src/api/gs-classification-rest-api/docs/DeclassificationExemptionsPaging.md Normal file
View File

@@ -0,0 +1,8 @@
# DeclassificationExemptionsPaging
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**DeclassificationExemptionsPagingList**](DeclassificationExemptionsPagingList.md) | | [optional] [default to null]

9
lib/js-api/src/api/gs-classification-rest-api/docs/DeclassificationExemptionsPaging_list.md Normal file
View File

@@ -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]

48
lib/js-api/src/api/gs-classification-rest-api/docs/DefaultClassificationValuesApi.md Normal file
View File

@@ -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)

8
lib/js-api/src/api/gs-classification-rest-api/docs/Error.md Normal file
View File

@@ -0,0 +1,8 @@
# ModelError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | [**ErrorError**](ErrorError.md) | | [optional] [default to null]

12
lib/js-api/src/api/gs-classification-rest-api/docs/Error_error.md Normal file
View File

@@ -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]

9
lib/js-api/src/api/gs-classification-rest-api/docs/Instruction.md Normal file
View File

@@ -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]

9
lib/js-api/src/api/gs-classification-rest-api/docs/InstructionBody.md Normal file
View File

@@ -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]

8
lib/js-api/src/api/gs-classification-rest-api/docs/InstructionEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# InstructionEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**Instruction**](Instruction.md) | | [default to null]

11
lib/js-api/src/api/gs-classification-rest-api/docs/NodeSecurityMarkBody.md Normal file
View File

@@ -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] |

23
lib/js-api/src/api/gs-classification-rest-api/docs/Pagination.md Normal file
View File

@@ -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]

7
lib/js-api/src/api/gs-classification-rest-api/docs/Path.md Normal file
View File

@@ -0,0 +1,7 @@
# Path
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

9
lib/js-api/src/api/gs-classification-rest-api/docs/PathElement.md Normal file
View File

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

9
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityControlSetting.md Normal file
View File

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

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityControlSettingBody.md Normal file
View File

@@ -0,0 +1,8 @@
# SecurityControlSettingBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **any** | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityControlSettingEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# SecurityControlSettingEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**SecurityControlSetting**](SecurityControlSetting.md) | | [default to null]

93
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityControlSettingsApi.md Normal file
View File

@@ -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)

9
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityGroup.md Normal file
View File

@@ -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]

9
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityGroupBody.md Normal file
View File

@@ -0,0 +1,9 @@
# SecurityGroupBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**groupName** | **string** | | [default to null]
**groupType** | **string** | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityGroupEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# SecurityMarkEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**SecurityGroup**](SecurityGroup.md) | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityGroupPaging.md Normal file
View File

@@ -0,0 +1,8 @@
# SecurityMarkPaging
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**SecurityGroupPagingList**](SecurityGroupPaging_list.md) | | [optional] [default to null]

9
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityGroupPaging_list.md Normal file
View File

@@ -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]

10
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMark.md Normal file
View File

@@ -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]

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMarkBody.md Normal file
View File

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

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMarkEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# SecurityMarkEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**SecurityMark**](SecurityMark.md) | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMarkInformation.md Normal file
View File

@@ -0,0 +1,8 @@
# SecurityMarkInformation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**add** | [**SecurityMarks**](SecurityMarks.md) | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMarkInformationBody.md Normal file
View File

@@ -0,0 +1,8 @@
# SecurityMarkInformationBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**add** | [**SecurityMarksBody**](SecurityMarksBody.md) | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMarkPaging.md Normal file
View File

@@ -0,0 +1,8 @@
# SecurityMarkPaging
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**SecurityMarkPagingList**](SecurityMarkPaging_list.md) | | [optional] [default to null]

9
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMarkPaging_list.md Normal file
View File

@@ -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]

7
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMarks.md Normal file
View File

@@ -0,0 +1,7 @@
# SecurityMarks
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

7
lib/js-api/src/api/gs-classification-rest-api/docs/SecurityMarksBody.md Normal file
View File

@@ -0,0 +1,7 @@
# SecurityMarksBody
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

8
lib/js-api/src/api/gs-classification-rest-api/docs/SubtopicPaging.md Normal file
View File

@@ -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
View 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]

10
lib/js-api/src/api/gs-classification-rest-api/docs/TopicBody.md Normal file
View File

@@ -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]

8
lib/js-api/src/api/gs-classification-rest-api/docs/TopicEntry.md Normal file
View File

@@ -0,0 +1,8 @@
# TopicEntry
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entry** | [**Topic**](Topic.md) | | [default to null]

8
lib/js-api/src/api/gs-classification-rest-api/docs/TopicPaging.md Normal file
View File

@@ -0,0 +1,8 @@
# TopicPaging
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**list** | [**TopicPagingList**](TopicPagingList.md) | | [optional] [default to null]

9
lib/js-api/src/api/gs-classification-rest-api/docs/TopicPaging_list.md Normal file
View File

@@ -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]

19
lib/js-api/src/api/gs-classification-rest-api/index.ts Normal file
View File

@@ -0,0 +1,19 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export * from './api';
export * from './model';

26
lib/js-api/src/api/gs-classification-rest-api/model/authorityClearanceGroup.ts Normal file
View File

@@ -0,0 +1,26 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AuthorityClearanceMark } from './authorityClearanceMark';
export interface AuthorityClearanceGroup {
id: string;
displayLabel: string;
systemGroup: boolean;
type: string;
marks: AuthorityClearanceMark[];
}

22
lib/js-api/src/api/gs-classification-rest-api/model/authorityClearanceGroupEntry.ts Normal file
View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AuthorityClearanceGroup } from './authorityClearanceGroup';
export interface AuthorityClearanceGroupEntry {
entry: AuthorityClearanceGroup;
}

22
lib/js-api/src/api/gs-classification-rest-api/model/authorityClearanceGroupPaging.ts Normal file
View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { AuthorityClearanceGroupPagingList } from './authorityClearanceGroupPagingList';
export interface AuthorityClearanceGroupPaging {
list?: AuthorityClearanceGroupPagingList;
}

24
lib/js-api/src/api/gs-classification-rest-api/model/authorityClearanceGroupPagingList.ts Normal file
View File

@@ -0,0 +1,24 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Pagination } from '../../content-rest-api';
import { AuthorityClearanceGroupEntry } from './authorityClearanceGroupEntry';
export interface AuthorityClearanceGroupPagingList {
pagination: Pagination;
entries?: AuthorityClearanceGroupEntry[];
}

23
lib/js-api/src/api/gs-classification-rest-api/model/authorityClearanceMark.ts Normal file
View File

@@ -0,0 +1,23 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface AuthorityClearanceMark {
id: string;
displayLabel: string;
applied: boolean;
inherited: boolean;
}

26
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuide.ts Normal file
View File

@@ -0,0 +1,26 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A classification guide.
*/
export interface ClassificationGuide {
name: string;
originatingOrganization: string;
publishedOn: Date;
enabled?: boolean;
}

23
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuideBody.ts Normal file
View File

@@ -0,0 +1,23 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface ClassificationGuideBody {
name: string;
originatingOrganization: string;
publishedOn: Date;
enabled?: boolean;
}

22
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuideEntry.ts Normal file
View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClassificationGuide } from './classificationGuide';
export interface ClassificationGuideEntry {
entry: ClassificationGuide;
}

26
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuideInTopic.ts Normal file
View File

@@ -0,0 +1,26 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The classification guide which the topic is contained in. This field is only returned when requested.
*/
export interface ClassificationGuideInTopic {
name: string;
originatingOrganization: string;
publishedOn: Date;
enabled?: boolean;
}

22
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuidePaging.ts Normal file
View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClassificationGuidePagingList } from './classificationGuidePagingList';
export interface ClassificationGuidePaging {
list?: ClassificationGuidePagingList;
}

24
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuidePagingList.ts Normal file
View File

@@ -0,0 +1,24 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClassificationGuidesEntry } from './classificationGuidesEntry';
import { Pagination } from '../../content-rest-api';
export interface ClassificationGuidePagingList {
pagination?: Pagination;
entries?: ClassificationGuidesEntry[];
}

27
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuides.ts Normal file
View File

@@ -0,0 +1,27 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A classification guide in a list.
*/
export interface ClassificationGuides {
name: string;
originatingOrganization: string;
publishedOn: Date;
enabled?: boolean;
hasTopics?: boolean;
}

24
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuidesBody.ts Normal file
View File

@@ -0,0 +1,24 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface ClassificationGuidesBody {
name: string;
originatingOrganization: string;
publishedOn: Date;
enabled?: boolean;
hasTopics?: boolean;
}

22
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuidesEntry.ts Normal file
View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClassificationGuides } from './classificationGuides';
export interface ClassificationGuidesEntry {
entry: ClassificationGuides;
}

27
lib/js-api/src/api/gs-classification-rest-api/model/classificationGuidesInTopic.ts Normal file
View File

@@ -0,0 +1,27 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* The classification guide which the topic is contained in. This field is only returned when requested.
*/
export interface ClassificationGuidesInTopic {
name: string;
originatingOrganization: string;
publishedOn: Date;
enabled?: boolean;
hasTopics?: boolean;
}

28
lib/js-api/src/api/gs-classification-rest-api/model/classificationInformation.ts Normal file
View File

@@ -0,0 +1,28 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface ClassificationInformation {
level: string;
classificationAgency?: string;
reasonIds: string[];
downgradeOn?: Date;
downgradeEvent?: string;
downgradeInstructions?: string;
declassifyOn?: Date;
declassificationEvent?: string;
exemptionIds?: string[];
}

22
lib/js-api/src/api/gs-classification-rest-api/model/classificationReason.ts Normal file
View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface ClassificationReason {
id: string;
code: string;
description: string;
}

21
lib/js-api/src/api/gs-classification-rest-api/model/classificationReasonBody.ts Normal file
View File

@@ -0,0 +1,21 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export interface ClassificationReasonBody {
code: string;
description: string;
}

22
lib/js-api/src/api/gs-classification-rest-api/model/classificationReasonEntry.ts Normal file
View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClassificationReason } from './classificationReason';
export interface ClassificationReasonEntry {
entry: ClassificationReason;
}

22
lib/js-api/src/api/gs-classification-rest-api/model/classificationReasonsPaging.ts Normal file
View File

@@ -0,0 +1,22 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClassificationReasonsPagingList } from './classificationReasonsPagingList';
export interface ClassificationReasonsPaging {
list?: ClassificationReasonsPagingList;
}

24
lib/js-api/src/api/gs-classification-rest-api/model/classificationReasonsPagingList.ts Normal file
View File

@@ -0,0 +1,24 @@
/*!
* @license
* Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { ClassificationReasonEntry } from './classificationReasonEntry';
import { Pagination } from '../../content-rest-api';
export interface ClassificationReasonsPagingList {
pagination?: Pagination;
entries?: ClassificationReasonEntry[];
}

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