mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[PRODENG-211] integrate JS-API with monorepo (part 1) (#9081)
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
This commit is contained in:
Denys Vuika
GitHub
125
lib/js-api/src/api/gs-core-rest-api/README.md
Normal file
125
lib/js-api/src/api/gs-core-rest-api/README.md
Normal file
@@ -0,0 +1,125 @@
|
||||
**GS Core API**
|
||||
|
||||
Provides access to the core features of Alfresco Governance Services.
|
||||
|
||||
|
||||
- Last Build date: 2018-11-05T11:25:35.010Z
|
||||
|
||||
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*.FilePlansApi* | [**createFilePlanCategories**](docs/FilePlansApi.md#createFilePlanCategories) | **POST** /file-plans/{filePlanId}/categories | Create record categories for a file plan
|
||||
*.FilePlansApi* | [**getFilePlan**](docs/FilePlansApi.md#getFilePlan) | **GET** /file-plans/{filePlanId} | Get a file plan
|
||||
*.FilePlansApi* | [**getFilePlanCategories**](docs/FilePlansApi.md#getFilePlanCategories) | **GET** /file-plans/{filePlanId}/categories | List file plans's children
|
||||
*.FilePlansApi* | [**updateFilePlan**](docs/FilePlansApi.md#updateFilePlan) | **PUT** /file-plans/{filePlanId} | Update a file plan
|
||||
*.FilesApi* | [**declareRecord**](docs/FilesApi.md#declareRecord) | **POST** /files/{fileId}/declare | Declare as record
|
||||
*.GssitesApi* | [**createRMSite**](docs/GssitesApi.md#createRMSite) | **POST** /gs-sites | Create the Records Management (RM) site
|
||||
*.GssitesApi* | [**deleteRMSite**](docs/GssitesApi.md#deleteRMSite) | **DELETE** /gs-sites/rm | Delete the Records Management (RM) site
|
||||
*.GssitesApi* | [**getRMSite**](docs/GssitesApi.md#getRMSite) | **GET** /gs-sites/rm | Get the Records Management (RM) site
|
||||
*.GssitesApi* | [**updateRMSite**](docs/GssitesApi.md#updateRMSite) | **PUT** /gs-sites/rm | Update the Records Management (RM) site
|
||||
*.RecordCategoriesApi* | [**createRecordCategoryChild**](docs/RecordCategoriesApi.md#createRecordCategoryChild) | **POST** /record-categories/{recordCategoryId}/children | Create a record category or a record folder
|
||||
*.RecordCategoriesApi* | [**deleteRecordCategory**](docs/RecordCategoriesApi.md#deleteRecordCategory) | **DELETE** /record-categories/{recordCategoryId} | Delete a record category
|
||||
*.RecordCategoriesApi* | [**getRecordCategory**](docs/RecordCategoriesApi.md#getRecordCategory) | **GET** /record-categories/{recordCategoryId} | Get a record category
|
||||
*.RecordCategoriesApi* | [**listRecordCategoryChildren**](docs/RecordCategoriesApi.md#listRecordCategoryChildren) | **GET** /record-categories/{recordCategoryId}/children | List record category's children
|
||||
*.RecordCategoriesApi* | [**updateRecordCategory**](docs/RecordCategoriesApi.md#updateRecordCategory) | **PUT** /record-categories/{recordCategoryId} | Update a record category
|
||||
*.RecordFoldersApi* | [**createRecordFolderChild**](docs/RecordFoldersApi.md#createRecordFolderChild) | **POST** /record-folders/{recordFolderId}/records | Create a record
|
||||
*.RecordFoldersApi* | [**deleteRecordFolder**](docs/RecordFoldersApi.md#deleteRecordFolder) | **DELETE** /record-folders/{recordFolderId} | Delete a record folder
|
||||
*.RecordFoldersApi* | [**getRecordFolder**](docs/RecordFoldersApi.md#getRecordFolder) | **GET** /record-folders/{recordFolderId} | Get a record folder
|
||||
*.RecordFoldersApi* | [**listRecordFolderChildren**](docs/RecordFoldersApi.md#listRecordFolderChildren) | **GET** /record-folders/{recordFolderId}/records | List records
|
||||
*.RecordFoldersApi* | [**updateRecordFolder**](docs/RecordFoldersApi.md#updateRecordFolder) | **PUT** /record-folders/{recordFolderId} | Update a record folder
|
||||
*.RecordsApi* | [**completeRecord**](docs/RecordsApi.md#completeRecord) | **POST** /records/{recordId}/complete | Complete a record
|
||||
*.RecordsApi* | [**deleteRecord**](docs/RecordsApi.md#deleteRecord) | **DELETE** /records/{recordId} | Delete a record
|
||||
*.RecordsApi* | [**fileRecord**](docs/RecordsApi.md#fileRecord) | **POST** /records/{recordId}/file | File a record
|
||||
*.RecordsApi* | [**getRecord**](docs/RecordsApi.md#getRecord) | **GET** /records/{recordId} | Get a record
|
||||
*.RecordsApi* | [**getRecordContent**](docs/RecordsApi.md#getRecordContent) | **GET** /records/{recordId}/content | Get record content
|
||||
*.RecordsApi* | [**updateRecord**](docs/RecordsApi.md#updateRecord) | **PUT** /records/{recordId} | Update record
|
||||
*.TransferContainersApi* | [**getTransferContainer**](docs/TransferContainersApi.md#getTransferContainer) | **GET** /transfer-containers/{transferContainerId} | Get a transfer container
|
||||
*.TransferContainersApi* | [**listTransfers**](docs/TransferContainersApi.md#listTransfers) | **GET** /transfer-containers/{transferContainerId}/transfers | List transfer container's children
|
||||
*.TransferContainersApi* | [**updateTransferContainer**](docs/TransferContainersApi.md#updateTransferContainer) | **PUT** /transfer-containers/{transferContainerId} | Update transfer container
|
||||
*.TransfersApi* | [**getTransfer**](docs/TransfersApi.md#getTransfer) | **GET** /transfers/{transferId} | Get a transfer
|
||||
*.TransfersApi* | [**listTransfersChildren**](docs/TransfersApi.md#listTransfersChildren) | **GET** /transfers/{transferId}/children | List transfer's children
|
||||
*.UnfiledContainersApi* | [**createUnfiledContainerChildren**](docs/UnfiledContainersApi.md#createUnfiledContainerChildren) | **POST** /unfiled-containers/{unfiledContainerId}/children | Create a record or an unfiled record folder
|
||||
*.UnfiledContainersApi* | [**getUnfiledContainer**](docs/UnfiledContainersApi.md#getUnfiledContainer) | **GET** /unfiled-containers/{unfiledContainerId} | Get the unfiled records container
|
||||
*.UnfiledContainersApi* | [**listUnfiledContainerChildren**](docs/UnfiledContainersApi.md#listUnfiledContainerChildren) | **GET** /unfiled-containers/{unfiledContainerId}/children | List unfiled record container's children
|
||||
*.UnfiledContainersApi* | [**updateUnfiledContainer**](docs/UnfiledContainersApi.md#updateUnfiledContainer) | **PUT** /unfiled-containers/{unfiledContainerId} | Update an unfiled record container
|
||||
*.UnfiledRecordFoldersApi* | [**createUnfiledRecordFolderChildren**](docs/UnfiledRecordFoldersApi.md#createUnfiledRecordFolderChildren) | **POST** /unfiled-record-folders/{unfiledRecordFolderId}/children | Create a record or an unfiled record folder
|
||||
*.UnfiledRecordFoldersApi* | [**deleteUnfiledRecordFolder**](docs/UnfiledRecordFoldersApi.md#deleteUnfiledRecordFolder) | **DELETE** /unfiled-record-folders/{unfiledRecordFolderId} | Delete an unfiled record folder. Deleted file plan components cannot be recovered, they are deleted permanently.
|
||||
*.UnfiledRecordFoldersApi* | [**getUnfiledRecordFolder**](docs/UnfiledRecordFoldersApi.md#getUnfiledRecordFolder) | **GET** /unfiled-record-folders/{unfiledRecordFolderId} | Get the unfiled record folder
|
||||
*.UnfiledRecordFoldersApi* | [**listUnfiledRecordFolderChildren**](docs/UnfiledRecordFoldersApi.md#listUnfiledRecordFolderChildren) | **GET** /unfiled-record-folders/{unfiledRecordFolderId}/children | List unfiled record folder's children
|
||||
*.UnfiledRecordFoldersApi* | [**updateUnfiledRecordFolder**](docs/UnfiledRecordFoldersApi.md#updateUnfiledRecordFolder) | **PUT** /unfiled-record-folders/{unfiledRecordFolderId} | Update an unfiled record folder
|
||||
|
||||
|
||||
## Documentation for Models
|
||||
|
||||
- [ChildAssociationInfo](docs/ChildAssociationInfo.md)
|
||||
- [ContentInfo](docs/ContentInfo.md)
|
||||
- [ErrorError](docs/ErrorError.md)
|
||||
- [FilePlan](docs/FilePlan.md)
|
||||
- [FilePlanBodyUpdate](docs/FilePlanBodyUpdate.md)
|
||||
- [FilePlanComponentBodyUpdate](docs/FilePlanComponentBodyUpdate.md)
|
||||
- [FilePlanEntry](docs/FilePlanEntry.md)
|
||||
- [ModelError](docs/ModelError.md)
|
||||
- [Pagination](docs/Pagination.md)
|
||||
- [PathElement](docs/PathElement.md)
|
||||
- [PathInfo](docs/PathInfo.md)
|
||||
- [RMNodeBodyCreate](docs/RMNodeBodyCreate.md)
|
||||
- [RMNodeBodyCreateWithRelativePath](docs/RMNodeBodyCreateWithRelativePath.md)
|
||||
- [RMSite](docs/RMSite.md)
|
||||
- [RMSiteBodyCreate](docs/RMSiteBodyCreate.md)
|
||||
- [RMSiteBodyUpdate](docs/RMSiteBodyUpdate.md)
|
||||
- [RMSiteEntry](docs/RMSiteEntry.md)
|
||||
- [Record](docs/Record.md)
|
||||
- [RecordCategory](docs/RecordCategory.md)
|
||||
- [RecordCategoryChild](docs/RecordCategoryChild.md)
|
||||
- [RecordCategoryChildEntry](docs/RecordCategoryChildEntry.md)
|
||||
- [RecordCategoryChildPaging](docs/RecordCategoryChildPaging.md)
|
||||
- [RecordCategoryChildPagingList](docs/RecordCategoryChildPagingList.md)
|
||||
- [RecordCategoryEntry](docs/RecordCategoryEntry.md)
|
||||
- [RecordCategoryPaging](docs/RecordCategoryPaging.md)
|
||||
- [RecordCategoryPagingList](docs/RecordCategoryPagingList.md)
|
||||
- [RecordEntry](docs/RecordEntry.md)
|
||||
- [RecordFolder](docs/RecordFolder.md)
|
||||
- [RecordFolderAssociationPaging](docs/RecordFolderAssociationPaging.md)
|
||||
- [RecordFolderAssociationPagingList](docs/RecordFolderAssociationPagingList.md)
|
||||
- [RecordFolderChildAssociationEntry](docs/RecordFolderChildAssociationEntry.md)
|
||||
- [RecordFolderEntry](docs/RecordFolderEntry.md)
|
||||
- [RequestBodyFile](docs/RequestBodyFile.md)
|
||||
- [RootCategoryBodyCreate](docs/RootCategoryBodyCreate.md)
|
||||
- [Transfer](docs/Transfer.md)
|
||||
- [TransferAssociationPaging](docs/TransferAssociationPaging.md)
|
||||
- [TransferAssociationPagingList](docs/TransferAssociationPagingList.md)
|
||||
- [TransferChild](docs/TransferChild.md)
|
||||
- [TransferChildAssociationEntry](docs/TransferChildAssociationEntry.md)
|
||||
- [TransferContainer](docs/TransferContainer.md)
|
||||
- [TransferContainerAssociationPaging](docs/TransferContainerAssociationPaging.md)
|
||||
- [TransferContainerAssociationPagingList](docs/TransferContainerAssociationPagingList.md)
|
||||
- [TransferContainerBodyUpdate](docs/TransferContainerBodyUpdate.md)
|
||||
- [TransferContainerChild](docs/TransferContainerChild.md)
|
||||
- [TransferContainerChildAssociationEntry](docs/TransferContainerChildAssociationEntry.md)
|
||||
- [TransferContainerEntry](docs/TransferContainerEntry.md)
|
||||
- [TransferEntry](docs/TransferEntry.md)
|
||||
- [UnfiledContainer](docs/UnfiledContainer.md)
|
||||
- [UnfiledContainerAssociationPaging](docs/UnfiledContainerAssociationPaging.md)
|
||||
- [UnfiledContainerAssociationPagingList](docs/UnfiledContainerAssociationPagingList.md)
|
||||
- [UnfiledContainerChild](docs/UnfiledContainerChild.md)
|
||||
- [UnfiledContainerChildAssociationEntry](docs/UnfiledContainerChildAssociationEntry.md)
|
||||
- [UnfiledContainerEntry](docs/UnfiledContainerEntry.md)
|
||||
- [UnfiledRecordContainerBodyUpdate](docs/UnfiledRecordContainerBodyUpdate.md)
|
||||
- [UnfiledRecordFolder](docs/UnfiledRecordFolder.md)
|
||||
- [UnfiledRecordFolderAssociationPaging](docs/UnfiledRecordFolderAssociationPaging.md)
|
||||
- [UnfiledRecordFolderAssociationPagingList](docs/UnfiledRecordFolderAssociationPagingList.md)
|
||||
- [UnfiledRecordFolderBodyUpdate](docs/UnfiledRecordFolderBodyUpdate.md)
|
||||
- [UnfiledRecordFolderChild](docs/UnfiledRecordFolderChild.md)
|
||||
- [UnfiledRecordFolderChildAssociationEntry](docs/UnfiledRecordFolderChildAssociationEntry.md)
|
||||
- [UnfiledRecordFolderEntry](docs/UnfiledRecordFolderEntry.md)
|
||||
- [UserInfo](docs/UserInfo.md)
|
||||
- [RecordFolderChildAssociation](docs/RecordFolderChildAssociation.md)
|
||||
- [TransferChildAssociation](docs/TransferChildAssociation.md)
|
||||
- [TransferContainerChildAssociation](docs/TransferContainerChildAssociation.md)
|
||||
- [UnfiledContainerChildAssociation](docs/UnfiledContainerChildAssociation.md)
|
||||
- [UnfiledRecordFolderChildAssociation](docs/UnfiledRecordFolderChildAssociation.md)
|
||||
|
||||
25
lib/js-api/src/api/gs-core-rest-api/api/base.api.ts
Normal file
25
lib/js-api/src/api/gs-core-rest-api/api/base.api.ts
Normal 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;
|
||||
}
|
||||
}
|
||||
165
lib/js-api/src/api/gs-core-rest-api/api/filePlans.api.ts
Normal file
165
lib/js-api/src/api/gs-core-rest-api/api/filePlans.api.ts
Normal file
@@ -0,0 +1,165 @@
|
||||
/*!
|
||||
* @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 { FilePlanBodyUpdate } from '../model/filePlanBodyUpdate';
|
||||
import { FilePlanEntry } from '../model/filePlanEntry';
|
||||
import { RecordCategoryEntry } from '../model/recordCategoryEntry';
|
||||
import { RecordCategoryPaging } from '../model/recordCategoryPaging';
|
||||
import { RootCategoryBodyCreate } from '../model/rootCategoryBodyCreate';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';
|
||||
|
||||
/**
|
||||
* FilePlansApi service.
|
||||
*/
|
||||
export class FilePlansApi extends BaseApi {
|
||||
/**
|
||||
* Create record categories for a file plan
|
||||
*
|
||||
* @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.
|
||||
* @param nodeBodyCreate The node information to create.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.autoRename If `true`, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
* @returns Promise<RecordCategoryEntry>
|
||||
*/
|
||||
createFilePlanCategories(
|
||||
filePlanId: string,
|
||||
nodeBodyCreate: RootCategoryBodyCreate,
|
||||
opts?: {
|
||||
autoRename?: boolean;
|
||||
} & RecordsIncludeQuery
|
||||
): Promise<RecordCategoryEntry> {
|
||||
throwIfNotDefined(filePlanId, 'filePlanId');
|
||||
throwIfNotDefined(nodeBodyCreate, 'nodeBodyCreate');
|
||||
|
||||
const pathParams = {
|
||||
filePlanId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
autoRename: opts?.autoRename,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/file-plans/{filePlanId}/categories',
|
||||
pathParams,
|
||||
queryParams,
|
||||
contentTypes: ['application/json', 'multipart/form-data'],
|
||||
bodyParam: nodeBodyCreate,
|
||||
returnType: RecordCategoryEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a file plan
|
||||
*
|
||||
* Mandatory fields and the file plan's aspects and properties are returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<FilePlanEntry>
|
||||
*/
|
||||
getFilePlan(filePlanId: string, opts?: RecordsIncludeQuery): Promise<FilePlanEntry> {
|
||||
throwIfNotDefined(filePlanId, 'filePlanId');
|
||||
|
||||
const pathParams = {
|
||||
filePlanId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/file-plans/{filePlanId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: FilePlanEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List file plans's children
|
||||
*
|
||||
* Minimal information for each child is returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordCategoryPaging>
|
||||
*/
|
||||
getFilePlanCategories(filePlanId: string, opts?: RecordsIncludeQuery & RecordsPagingQuery & RecordsSourceQuery): Promise<RecordCategoryPaging> {
|
||||
throwIfNotDefined(filePlanId, 'filePlanId');
|
||||
|
||||
const pathParams = {
|
||||
filePlanId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
skipCount: opts?.skipCount,
|
||||
maxItems: opts?.maxItems,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
includeSource: opts?.includeSource,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/file-plans/{filePlanId}/categories',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: RecordCategoryPaging
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a file plan
|
||||
*
|
||||
* **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
*
|
||||
* @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias.
|
||||
* @param filePlanBodyUpdate The file plan information to update.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<FilePlanEntry>
|
||||
*/
|
||||
updateFilePlan(filePlanId: string, filePlanBodyUpdate: FilePlanBodyUpdate, opts?: RecordsIncludeQuery): Promise<FilePlanEntry> {
|
||||
throwIfNotDefined(filePlanId, 'filePlanId');
|
||||
throwIfNotDefined(filePlanBodyUpdate, 'filePlanBodyUpdate');
|
||||
|
||||
const pathParams = {
|
||||
filePlanId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/file-plans/{filePlanId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: filePlanBodyUpdate,
|
||||
returnType: FilePlanEntry
|
||||
});
|
||||
}
|
||||
}
|
||||
67
lib/js-api/src/api/gs-core-rest-api/api/files.api.ts
Normal file
67
lib/js-api/src/api/gs-core-rest-api/api/files.api.ts
Normal file
@@ -0,0 +1,67 @@
|
||||
/*!
|
||||
* @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 { RecordEntry } from '../model/recordEntry';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery } from './types';
|
||||
|
||||
/**
|
||||
* Files service.
|
||||
*
|
||||
* @module FilesApi
|
||||
*/
|
||||
export class FilesApi extends BaseApi {
|
||||
/**
|
||||
* Declare as record
|
||||
*
|
||||
* Declares the file **fileId** in the unfiled records container. The original file is moved to the Records Management site and a secondary parent association is created in the file's original site.
|
||||
*
|
||||
* @param fileId The identifier of a non-record file.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.hideRecord Flag to indicate whether the record should be hidden from the current parent folder. (default to false)
|
||||
* @returns Promise<RecordEntry>
|
||||
*/
|
||||
declareRecord(
|
||||
fileId: string,
|
||||
opts?: {
|
||||
hideRecord?: boolean;
|
||||
parentId?: string;
|
||||
} & RecordsIncludeQuery
|
||||
): Promise<RecordEntry> {
|
||||
throwIfNotDefined(fileId, 'fileId');
|
||||
|
||||
const pathParams = {
|
||||
fileId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
hideRecord: opts?.hideRecord,
|
||||
parentId: opts?.parentId,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/files/{fileId}/declare',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: RecordEntry
|
||||
});
|
||||
}
|
||||
}
|
||||
100
lib/js-api/src/api/gs-core-rest-api/api/gsSites.api.ts
Normal file
100
lib/js-api/src/api/gs-core-rest-api/api/gsSites.api.ts
Normal file
@@ -0,0 +1,100 @@
|
||||
/*!
|
||||
* @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 { RMSiteBodyCreate, RMSiteBodyUpdate, RMSiteEntry } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsFieldsQuery } from './types';
|
||||
|
||||
/**
|
||||
* GsSitesApi service.
|
||||
*/
|
||||
export class GsSitesApi extends BaseApi {
|
||||
/**
|
||||
* Create the Records Management (RM) site
|
||||
*
|
||||
* The creator will be added as a member with Site Manager role.
|
||||
* When you create the RM site, the **filePlan** structure is also created including special containers, such as containers for transfers, holds and, unfiled records.
|
||||
*
|
||||
* @param siteBodyCreate The site details
|
||||
* @param opts Optional parameters
|
||||
* @param opts.skipAddToFavorites Flag to indicate whether the RM site should not be added to the user's site favorites. (default to false)
|
||||
* @returns Promise<RMSiteEntry>
|
||||
*/
|
||||
createRMSite(siteBodyCreate: RMSiteBodyCreate, opts?: { skipAddToFavorites?: boolean }): Promise<RMSiteEntry> {
|
||||
throwIfNotDefined(siteBodyCreate, 'siteBodyCreate');
|
||||
|
||||
return this.post({
|
||||
path: '/gs-sites',
|
||||
queryParams: opts,
|
||||
bodyParam: siteBodyCreate
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the Records Management (RM) site
|
||||
*
|
||||
* @returns Promise<{}>
|
||||
*/
|
||||
deleteRMSite(): Promise<void> {
|
||||
return this.delete({
|
||||
path: '/gs-sites/rm'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Records Management (RM) site
|
||||
*
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RMSiteEntry>
|
||||
*/
|
||||
getRMSite(opts?: RecordsFieldsQuery): Promise<RMSiteEntry> {
|
||||
const queryParams = {
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/gs-sites/rm',
|
||||
queryParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the Records Management (RM) site
|
||||
*
|
||||
* Update the details for the RM site. Site Manager or other (site) admin can update title or description.
|
||||
* **Note**: the id, site visibility, or compliance of the RM site cannot be updated once the site has been created.
|
||||
*
|
||||
* @param siteBodyUpdate The RM site information to update.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RMSiteEntry>
|
||||
*/
|
||||
updateRMSite(siteBodyUpdate: RMSiteBodyUpdate, opts?: RecordsFieldsQuery): Promise<RMSiteEntry> {
|
||||
throwIfNotDefined(siteBodyUpdate, 'siteBodyUpdate');
|
||||
|
||||
const queryParams = {
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/gs-sites/rm',
|
||||
queryParams,
|
||||
bodyParam: siteBodyUpdate
|
||||
});
|
||||
}
|
||||
}
|
||||
28
lib/js-api/src/api/gs-core-rest-api/api/index.ts
Normal file
28
lib/js-api/src/api/gs-core-rest-api/api/index.ts
Normal 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 * from './types';
|
||||
export * from './filePlans.api';
|
||||
export * from './files.api';
|
||||
export * from './gsSites.api';
|
||||
export * from './recordCategories.api';
|
||||
export * from './recordFolders.api';
|
||||
export * from './records.api';
|
||||
export * from './transferContainers.api';
|
||||
export * from './transfers.api';
|
||||
export * from './unfiledContainers.api';
|
||||
export * from './unfiledRecordFolders.api';
|
||||
214
lib/js-api/src/api/gs-core-rest-api/api/recordCategories.api.ts
Normal file
214
lib/js-api/src/api/gs-core-rest-api/api/recordCategories.api.ts
Normal file
@@ -0,0 +1,214 @@
|
||||
/*!
|
||||
* @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 {
|
||||
FilePlanComponentBodyUpdate,
|
||||
RecordCategoryChildEntry,
|
||||
RecordCategoryChildPaging,
|
||||
RecordCategoryEntry,
|
||||
RMNodeBodyCreateWithRelativePath
|
||||
} from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';
|
||||
|
||||
/**
|
||||
* RecordCategoriesApi service.
|
||||
*/
|
||||
export class RecordCategoriesApi extends BaseApi {
|
||||
/**
|
||||
* Create a record category or a record folder
|
||||
*
|
||||
* @param recordCategoryId The identifier of a record category.
|
||||
* @param nodeBodyCreate The node information to create.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.autoRename If `true`, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
* @returns Promise<RecordCategoryChildEntry>
|
||||
*/
|
||||
createRecordCategoryChild(
|
||||
recordCategoryId: string,
|
||||
nodeBodyCreate: RMNodeBodyCreateWithRelativePath,
|
||||
opts?: {
|
||||
autoRename?: boolean;
|
||||
} & RecordsIncludeQuery
|
||||
): Promise<RecordCategoryChildEntry> {
|
||||
throwIfNotDefined(recordCategoryId, 'recordCategoryId');
|
||||
throwIfNotDefined(nodeBodyCreate, 'nodeBodyCreate');
|
||||
|
||||
const pathParams = {
|
||||
recordCategoryId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
autoRename: opts?.autoRename,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/record-categories/{recordCategoryId}/children',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: nodeBodyCreate,
|
||||
returnType: RecordCategoryChildEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a record category
|
||||
*
|
||||
* @param recordCategoryId The identifier of a record category.
|
||||
* @returns Promise<{}>
|
||||
*/
|
||||
deleteRecordCategory(recordCategoryId: string): Promise<void> {
|
||||
throwIfNotDefined(recordCategoryId, 'recordCategoryId');
|
||||
|
||||
const pathParams = {
|
||||
recordCategoryId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/record-categories/{recordCategoryId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a record category
|
||||
*
|
||||
* Mandatory fields and the record category's aspects and properties are returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param recordCategoryId The identifier of a record category.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.relativePath Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**.
|
||||
* @returns Promise<RecordCategoryEntry>
|
||||
*/
|
||||
getRecordCategory(
|
||||
recordCategoryId: string,
|
||||
opts?: {
|
||||
relativePath?: string;
|
||||
} & RecordsIncludeQuery
|
||||
): Promise<RecordCategoryEntry> {
|
||||
throwIfNotDefined(recordCategoryId, 'recordCategoryId');
|
||||
|
||||
const pathParams = {
|
||||
recordCategoryId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
relativePath: opts?.relativePath,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/record-categories/{recordCategoryId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: RecordCategoryEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List record category's children
|
||||
*
|
||||
* Minimal information for each child is returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* The list of child nodes includes primary children and secondary children, if there are any.
|
||||
*
|
||||
* @param recordCategoryId The identifier of a record category.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.where Optionally filter the list. Here are some examples:
|
||||
* where=(nodeType='rma:recordFolder')
|
||||
* where=(nodeType='rma:recordCategory')
|
||||
* where=(isRecordFolder=true AND isClosed=false)
|
||||
* @param opts.relativePath Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**.
|
||||
* @returns Promise<RecordCategoryChildPaging>
|
||||
*/
|
||||
listRecordCategoryChildren(
|
||||
recordCategoryId: string,
|
||||
opts?: {
|
||||
where?: string;
|
||||
relativePath?: string;
|
||||
} & RecordsIncludeQuery &
|
||||
RecordsPagingQuery &
|
||||
RecordsSourceQuery
|
||||
): Promise<RecordCategoryChildPaging> {
|
||||
throwIfNotDefined(recordCategoryId, 'recordCategoryId');
|
||||
|
||||
const pathParams = {
|
||||
recordCategoryId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
skipCount: opts?.skipCount,
|
||||
maxItems: opts?.maxItems,
|
||||
where: opts?.where,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
relativePath: opts?.relativePath,
|
||||
includeSource: opts?.includeSource,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/record-categories/{recordCategoryId}/children',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: RecordCategoryChildPaging
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a record category
|
||||
*
|
||||
* **Note:** If you want to add or remove aspects, then you must use **GET /record-categories/{recordCategoryId}** first to get the complete set of *aspectNames*.
|
||||
* **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
*
|
||||
* @param recordCategoryId The identifier of a record category.
|
||||
* @param recordCategoryBodyUpdate The record category information to update.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordCategoryEntry>
|
||||
*/
|
||||
updateRecordCategory(
|
||||
recordCategoryId: string,
|
||||
recordCategoryBodyUpdate: FilePlanComponentBodyUpdate,
|
||||
opts?: RecordsIncludeQuery
|
||||
): Promise<RecordCategoryEntry> {
|
||||
throwIfNotDefined(recordCategoryId, 'recordCategoryId');
|
||||
throwIfNotDefined(recordCategoryBodyUpdate, 'recordCategoryBodyUpdate');
|
||||
|
||||
const pathParams = {
|
||||
recordCategoryId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/record-categories/{recordCategoryId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: recordCategoryBodyUpdate,
|
||||
returnType: RecordCategoryEntry
|
||||
});
|
||||
}
|
||||
}
|
||||
193
lib/js-api/src/api/gs-core-rest-api/api/recordFolders.api.ts
Normal file
193
lib/js-api/src/api/gs-core-rest-api/api/recordFolders.api.ts
Normal file
@@ -0,0 +1,193 @@
|
||||
/*!
|
||||
* @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 { FilePlanComponentBodyUpdate, RecordEntry, RecordFolderAssociationPaging, RecordFolderEntry, RMNodeBodyCreate } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';
|
||||
|
||||
/**
|
||||
* Record Folders service.
|
||||
*/
|
||||
export class RecordFoldersApi extends BaseApi {
|
||||
/**
|
||||
* Create a record
|
||||
*
|
||||
* Create a record as a primary child of **recordFolderId**.
|
||||
* This endpoint supports both JSON and multipart/form-data (file upload).
|
||||
*
|
||||
* @param recordFolderId The identifier of a record folder.
|
||||
* @param recordBodyCreate The record information to create. This field is ignored for multipart/form-data content uploads.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordEntry>
|
||||
*/
|
||||
createRecordFolderChild(recordFolderId: string, recordBodyCreate: RMNodeBodyCreate, opts?: RecordsIncludeQuery): Promise<RecordEntry> {
|
||||
throwIfNotDefined(recordFolderId, 'recordFolderId');
|
||||
throwIfNotDefined(recordBodyCreate, 'recordBodyCreate');
|
||||
|
||||
const pathParams = {
|
||||
recordFolderId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/record-folders/{recordFolderId}/records',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: recordBodyCreate,
|
||||
returnType: RecordEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes record folder **recordFolderId**.
|
||||
* Deleted file plan components cannot be recovered, they are deleted permanently.
|
||||
*
|
||||
* @param recordFolderId The identifier of a record folder.
|
||||
* @returns Promise<{}>
|
||||
*/
|
||||
deleteRecordFolder(recordFolderId: string): Promise<void> {
|
||||
throwIfNotDefined(recordFolderId, 'recordFolderId');
|
||||
|
||||
const pathParams = {
|
||||
recordFolderId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/record-folders/{recordFolderId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a record folder
|
||||
*
|
||||
* Mandatory fields and the record folder's aspects and properties are returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param recordFolderId The identifier of a record folder.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordFolderEntry>
|
||||
*/
|
||||
getRecordFolder(recordFolderId: string, opts?: RecordsIncludeQuery): Promise<RecordFolderEntry> {
|
||||
throwIfNotDefined(recordFolderId, 'recordFolderId');
|
||||
|
||||
const pathParams = {
|
||||
recordFolderId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/record-folders/{recordFolderId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: RecordFolderEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List records
|
||||
*
|
||||
* Minimal information for each record is returned by default.
|
||||
* The list of records includes primary children and secondary children, if there are any.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param recordFolderId The identifier of a record folder.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.where Optionally filter the list. Here are some examples:
|
||||
* - where=(nodeType='my:specialNodeType')
|
||||
* - where=(nodeType='my:specialNodeType INCLUDESUBTYPES')
|
||||
* - where=(isPrimary=true)
|
||||
* @returns Promise<RecordFolderAssociationPaging>
|
||||
*/
|
||||
listRecordFolderChildren(
|
||||
recordFolderId: string,
|
||||
opts?: {
|
||||
where?: string;
|
||||
} & RecordsPagingQuery &
|
||||
RecordsIncludeQuery &
|
||||
RecordsSourceQuery
|
||||
): Promise<RecordFolderAssociationPaging> {
|
||||
throwIfNotDefined(recordFolderId, 'recordFolderId');
|
||||
|
||||
const pathParams = {
|
||||
recordFolderId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
skipCount: opts?.skipCount,
|
||||
maxItems: opts?.maxItems,
|
||||
where: opts?.where,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
includeSource: opts?.includeSource,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/record-folders/{recordFolderId}/records',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: RecordFolderAssociationPaging
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates record folder **recordFolderId**. For example, you can rename a record folder:
|
||||
*
|
||||
* **Note:** if you want to add or remove aspects, then you must use **GET /record-folders/{recordFolderId}** first to get the complete set of *aspectNames*.
|
||||
* **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
*
|
||||
* @param recordFolderId The identifier of a record folder.
|
||||
* @param recordFolderBodyUpdate The record folder information to update.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordFolderEntry>
|
||||
*/
|
||||
updateRecordFolder(
|
||||
recordFolderId: string,
|
||||
recordFolderBodyUpdate: FilePlanComponentBodyUpdate,
|
||||
opts?: RecordsIncludeQuery
|
||||
): Promise<RecordFolderEntry> {
|
||||
throwIfNotDefined(recordFolderId, 'recordFolderId');
|
||||
throwIfNotDefined(recordFolderBodyUpdate, 'recordFolderBodyUpdate');
|
||||
|
||||
const pathParams = {
|
||||
recordFolderId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/record-folders/{recordFolderId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: recordFolderBodyUpdate,
|
||||
returnType: RecordFolderEntry
|
||||
});
|
||||
}
|
||||
}
|
||||
236
lib/js-api/src/api/gs-core-rest-api/api/records.api.ts
Normal file
236
lib/js-api/src/api/gs-core-rest-api/api/records.api.ts
Normal file
@@ -0,0 +1,236 @@
|
||||
/*!
|
||||
* @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 { FilePlanComponentBodyUpdate } from '../model/filePlanComponentBodyUpdate';
|
||||
import { RecordEntry } from '../model/recordEntry';
|
||||
import { RequestBodyFile } from '../model/requestBodyFile';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery } from './types';
|
||||
|
||||
/**
|
||||
* Records service.
|
||||
*
|
||||
* @module RecordsApi
|
||||
*/
|
||||
export class RecordsApi extends BaseApi {
|
||||
/**
|
||||
* Complete a record
|
||||
*
|
||||
* @param recordId The identifier of a record.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordEntry>
|
||||
*/
|
||||
completeRecord(recordId: string, opts?: RecordsIncludeQuery): Promise<RecordEntry> {
|
||||
throwIfNotDefined(recordId, 'recordId');
|
||||
|
||||
const pathParams = {
|
||||
recordId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/records/{recordId}/complete',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: RecordEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a record. Deleted file plan components cannot be recovered, they are deleted permanently.
|
||||
*
|
||||
* @param recordId The identifier of a record.
|
||||
* @returns Promise<{}>
|
||||
*/
|
||||
deleteRecord(recordId: string): Promise<void> {
|
||||
throwIfNotDefined(recordId, 'recordId');
|
||||
|
||||
const pathParams = {
|
||||
recordId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/records/{recordId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* File a record
|
||||
*
|
||||
* You need to specify the target record folder by providing its id **targetParentId**
|
||||
* If the record is already filed, a link to the target record folder is created.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param recordId The identifier of a record.
|
||||
* @param nodeBodyFile The target record folder id
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordEntry>
|
||||
*/
|
||||
fileRecord(recordId: string, nodeBodyFile: RequestBodyFile, opts?: RecordsIncludeQuery): Promise<RecordEntry> {
|
||||
throwIfNotDefined(recordId, 'recordId');
|
||||
throwIfNotDefined(nodeBodyFile, 'nodeBodyFile');
|
||||
|
||||
const pathParams = {
|
||||
recordId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/records/{recordId}/file',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: nodeBodyFile,
|
||||
returnType: RecordEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a record
|
||||
*
|
||||
* Mandatory fields and the record's aspects and properties are returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param recordId The identifier of a record.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordEntry>
|
||||
*/
|
||||
getRecord(recordId: string, opts?: RecordsIncludeQuery): Promise<RecordEntry> {
|
||||
throwIfNotDefined(recordId, 'recordId');
|
||||
|
||||
const pathParams = {
|
||||
recordId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/records/{recordId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: RecordEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get record content
|
||||
*
|
||||
* @param recordId The identifier of a record.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.attachment **true** enables a web browser to download the file as an attachment.
|
||||
* **false** means a web browser may preview the file in a new tab or window, but not download the file.
|
||||
*
|
||||
* You can only set this parameter to **false** if the content type of the file is in the supported list;
|
||||
* for example, certain image files and PDF files.
|
||||
*
|
||||
* If the content type is not supported for preview, then a value of **false** is ignored, and
|
||||
* the attachment will be returned in the response. (default to true)
|
||||
* @param opts.ifModifiedSince Only returns the content if it has been modified since the date provided.
|
||||
* Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT.
|
||||
* @returns Promise<{}>
|
||||
*/
|
||||
getRecordContent(
|
||||
recordId: string,
|
||||
opts?: {
|
||||
attachment?: boolean;
|
||||
ifModifiedSince?: string;
|
||||
}
|
||||
): Promise<any> {
|
||||
throwIfNotDefined(recordId, 'recordId');
|
||||
|
||||
const pathParams = {
|
||||
recordId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
attachment: opts?.attachment
|
||||
};
|
||||
|
||||
const headerParams = {
|
||||
'If-Modified-Since': opts?.ifModifiedSince
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/records/{recordId}/content',
|
||||
pathParams,
|
||||
queryParams,
|
||||
headerParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update record
|
||||
*
|
||||
* Updates the record **recordId**. For example, you can rename a record:
|
||||
* JSON
|
||||
* {
|
||||
* \"name\":\"My new name\"
|
||||
* }
|
||||
*
|
||||
* You can also set or update one or more properties:
|
||||
* JSON
|
||||
* {
|
||||
* \"properties\":
|
||||
* {
|
||||
* \"cm:title\":\"New title\",
|
||||
* \"cm:description\":\"New description\"
|
||||
* }
|
||||
* }
|
||||
*
|
||||
* **Note:** if you want to add or remove aspects, then you must use **GET /records/{recordId}** first to get the complete set of *aspectNames*.
|
||||
* **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
*
|
||||
* @param recordId The identifier of a record.
|
||||
* @param recordBodyUpdate The record information to update.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<RecordEntry>
|
||||
*/
|
||||
updateRecord(recordId: string, recordBodyUpdate: FilePlanComponentBodyUpdate, opts?: RecordsIncludeQuery): Promise<RecordEntry> {
|
||||
throwIfNotDefined(recordId, 'recordId');
|
||||
throwIfNotDefined(recordBodyUpdate, 'recordBodyUpdate');
|
||||
|
||||
const pathParams = {
|
||||
recordId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/records/{recordId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: recordBodyUpdate,
|
||||
returnType: RecordEntry
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,131 @@
|
||||
/*!
|
||||
* @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 { TransferContainerAssociationPaging } from '../model/transferContainerAssociationPaging';
|
||||
import { TransferContainerBodyUpdate } from '../model/transferContainerBodyUpdate';
|
||||
import { TransferContainerEntry } from '../model/transferContainerEntry';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';
|
||||
|
||||
/**
|
||||
* TransferContainersApi service.
|
||||
*/
|
||||
export class TransferContainersApi extends BaseApi {
|
||||
/**
|
||||
* Get a transfer container
|
||||
*
|
||||
* Mandatory fields and the transfer container's aspects and properties are returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param transferContainerId The identifier of a transfer container. You can also use the -transfers- alias.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<TransferContainerEntry>
|
||||
*/
|
||||
getTransferContainer(transferContainerId: string, opts?: RecordsIncludeQuery): Promise<TransferContainerEntry> {
|
||||
throwIfNotDefined(transferContainerId, 'transferContainerId');
|
||||
|
||||
const pathParams = {
|
||||
transferContainerId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/transfer-containers/{transferContainerId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: TransferContainerEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List transfer container's children
|
||||
*
|
||||
* Minimal information for each child is returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param transferContainerId The identifier of a transfer container. You can also use the -transfers- alias.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<TransferContainerAssociationPaging>
|
||||
*/
|
||||
listTransfers(
|
||||
transferContainerId: string,
|
||||
opts?: RecordsSourceQuery & RecordsIncludeQuery & RecordsPagingQuery
|
||||
): Promise<TransferContainerAssociationPaging> {
|
||||
throwIfNotDefined(transferContainerId, 'transferContainerId');
|
||||
opts = opts || {};
|
||||
|
||||
const pathParams = {
|
||||
transferContainerId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
skipCount: opts?.skipCount,
|
||||
maxItems: opts?.maxItems,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
includeSource: opts?.includeSource,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/transfer-containers/{transferContainerId}/transfers',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: TransferContainerAssociationPaging
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update transfer container
|
||||
*
|
||||
* @param transferContainerId The identifier of a transfer container. You can also use the -transfers- alias.
|
||||
* @param nodeBodyUpdate The node information to update.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<TransferContainerEntry>
|
||||
*/
|
||||
updateTransferContainer(
|
||||
transferContainerId: string,
|
||||
nodeBodyUpdate: TransferContainerBodyUpdate,
|
||||
opts?: RecordsIncludeQuery
|
||||
): Promise<TransferContainerEntry> {
|
||||
throwIfNotDefined(transferContainerId, 'transferContainerId');
|
||||
throwIfNotDefined(nodeBodyUpdate, 'nodeBodyUpdate');
|
||||
opts = opts || {};
|
||||
|
||||
const pathParams = {
|
||||
transferContainerId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/transfer-containers/{transferContainerId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: nodeBodyUpdate,
|
||||
returnType: TransferContainerEntry
|
||||
});
|
||||
}
|
||||
}
|
||||
96
lib/js-api/src/api/gs-core-rest-api/api/transfers.api.ts
Normal file
96
lib/js-api/src/api/gs-core-rest-api/api/transfers.api.ts
Normal file
@@ -0,0 +1,96 @@
|
||||
/*!
|
||||
* @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 { TransferAssociationPaging } from '../model/transferAssociationPaging';
|
||||
import { TransferEntry } from '../model/transferEntry';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';
|
||||
|
||||
/**
|
||||
* Transfers service.
|
||||
*
|
||||
* @module TransfersApi
|
||||
*/
|
||||
export class TransfersApi extends BaseApi {
|
||||
/**
|
||||
* Get a transfer
|
||||
*
|
||||
* Mandatory fields and the transfer's aspects and properties are returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param transferId The identifier of a transfer.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<TransferEntry>
|
||||
*/
|
||||
getTransfer(transferId: string, opts?: RecordsIncludeQuery): Promise<TransferEntry> {
|
||||
throwIfNotDefined(transferId, 'transferId');
|
||||
|
||||
const pathParams = {
|
||||
transferId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/transfers/{transferId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: TransferEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List transfer's children
|
||||
*
|
||||
* Minimal information for each child is returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param transferId The identifier of a transfer.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<TransferAssociationPaging>
|
||||
*/
|
||||
listTransfersChildren(
|
||||
transferId: string,
|
||||
opts?: RecordsSourceQuery & RecordsIncludeQuery & RecordsPagingQuery
|
||||
): Promise<TransferAssociationPaging> {
|
||||
throwIfNotDefined(transferId, 'transferId');
|
||||
|
||||
const pathParams = {
|
||||
transferId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
skipCount: opts?.skipCount,
|
||||
maxItems: opts?.maxItems,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
includeSource: opts?.includeSource,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/transfers/{transferId}/children',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: TransferAssociationPaging
|
||||
});
|
||||
}
|
||||
}
|
||||
59
lib/js-api/src/api/gs-core-rest-api/api/types.ts
Normal file
59
lib/js-api/src/api/gs-core-rest-api/api/types.ts
Normal file
@@ -0,0 +1,59 @@
|
||||
/*!
|
||||
* @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 RecordsPagingQuery = {
|
||||
/**
|
||||
* 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 RecordsIncludeQuery = {
|
||||
/**
|
||||
* Returns additional information about the record. Any optional field from the response model can be requested.
|
||||
*/
|
||||
include?: string[];
|
||||
} & RecordsFieldsQuery;
|
||||
|
||||
export type RecordsFieldsQuery = {
|
||||
/**
|
||||
* 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 RecordsSourceQuery = {
|
||||
/**
|
||||
* Also include **source** (in addition to **entries**)
|
||||
*/
|
||||
includeSource?: boolean;
|
||||
};
|
||||
186
lib/js-api/src/api/gs-core-rest-api/api/unfiledContainers.api.ts
Normal file
186
lib/js-api/src/api/gs-core-rest-api/api/unfiledContainers.api.ts
Normal file
@@ -0,0 +1,186 @@
|
||||
/*!
|
||||
* @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 { RMNodeBodyCreate, UnfiledContainerAssociationPaging, UnfiledContainerEntry, UnfiledRecordContainerBodyUpdate } from '../model';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';
|
||||
|
||||
/**
|
||||
* Unfiled containers service.
|
||||
*
|
||||
* @module UnfiledContainersApi
|
||||
*/
|
||||
export class UnfiledContainersApi extends BaseApi {
|
||||
/**
|
||||
* Creates a record or an unfiled record folder as a primary child of **unfiledContainerId**.
|
||||
*
|
||||
* @param unfiledContainerId The identifier of an unfiled records container. You can use the **-unfiled-** alias.
|
||||
* @param nodeBodyCreate The node information to create.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.autoRename If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
* @returns Promise<UnfiledContainerAssociationPaging>
|
||||
*/
|
||||
createUnfiledContainerChildren(
|
||||
unfiledContainerId: string,
|
||||
nodeBodyCreate: RMNodeBodyCreate,
|
||||
opts?: {
|
||||
autoRename?: boolean;
|
||||
} & RecordsIncludeQuery
|
||||
): Promise<UnfiledContainerAssociationPaging> {
|
||||
throwIfNotDefined(unfiledContainerId, 'unfiledContainerId');
|
||||
throwIfNotDefined(nodeBodyCreate, 'nodeBodyCreate');
|
||||
|
||||
const pathParams = {
|
||||
unfiledContainerId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
autoRename: opts?.autoRename,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
const contentTypes = ['application/json', 'multipart/form-data'];
|
||||
|
||||
return this.post({
|
||||
path: '/unfiled-containers/{unfiledContainerId}/children',
|
||||
pathParams,
|
||||
queryParams,
|
||||
contentTypes,
|
||||
bodyParam: nodeBodyCreate,
|
||||
returnType: UnfiledContainerAssociationPaging
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the unfiled records container
|
||||
*
|
||||
* Gets information for unfiled records container **unfiledContainerId**
|
||||
* Mandatory fields and the unfiled records container's aspects and properties are returned by default.
|
||||
*
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param unfiledContainerId The identifier of an unfiled records container. You can use the **-unfiled-** alias.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<UnfiledContainerEntry>
|
||||
*/
|
||||
getUnfiledContainer(unfiledContainerId: string, opts?: RecordsIncludeQuery): Promise<UnfiledContainerEntry> {
|
||||
throwIfNotDefined(unfiledContainerId, 'unfiledContainerId');
|
||||
|
||||
const pathParams = {
|
||||
unfiledContainerId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/unfiled-containers/{unfiledContainerId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: UnfiledContainerEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List unfiled record container's children
|
||||
*
|
||||
* Returns a list of records or unfiled record folders.
|
||||
*
|
||||
* Minimal information for each child is returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param unfiledContainerId The identifier of an unfiled records container. You can use the **-unfiled-** alias.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.where Optionally filter the list. Here are some examples:
|
||||
* - where=(isRecord=true)
|
||||
* - where=(isUnfiledRecordFolder=false)
|
||||
* - where=(nodeType='cm:content INCLUDESUBTYPES')
|
||||
* @param opts.includeSource Also include **source** (in addition to **entries**) with folder information on the parent node – the specified parent **unfiledContainerId**
|
||||
* @returns Promise<UnfiledContainerAssociationPaging>
|
||||
*/
|
||||
listUnfiledContainerChildren(
|
||||
unfiledContainerId: string,
|
||||
opts?: {
|
||||
where?: string;
|
||||
} & RecordsSourceQuery &
|
||||
RecordsIncludeQuery &
|
||||
RecordsPagingQuery
|
||||
): Promise<UnfiledContainerAssociationPaging> {
|
||||
throwIfNotDefined(unfiledContainerId, 'unfiledContainerId');
|
||||
|
||||
const pathParams = {
|
||||
unfiledContainerId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
skipCount: opts?.skipCount,
|
||||
maxItems: opts?.maxItems,
|
||||
where: opts?.where,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
includeSource: opts?.includeSource,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/unfiled-containers/{unfiledContainerId}/children',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: UnfiledContainerAssociationPaging
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Update an unfiled record container
|
||||
*
|
||||
* **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
*
|
||||
* @param unfiledContainerId The identifier of an unfiled records container. You can use the **-unfiled-** alias.
|
||||
* @param unfiledContainerBodyUpdate The unfiled record container information to update.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<UnfiledContainerEntry>
|
||||
*/
|
||||
updateUnfiledContainer(
|
||||
unfiledContainerId: string,
|
||||
unfiledContainerBodyUpdate: UnfiledRecordContainerBodyUpdate,
|
||||
opts?: RecordsIncludeQuery
|
||||
): Promise<UnfiledContainerEntry> {
|
||||
throwIfNotDefined(unfiledContainerId, 'unfiledContainerId');
|
||||
throwIfNotDefined(unfiledContainerBodyUpdate, 'unfiledContainerBodyUpdate');
|
||||
|
||||
const pathParams = {
|
||||
unfiledContainerId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/unfiled-containers/{unfiledContainerId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: unfiledContainerBodyUpdate,
|
||||
returnType: UnfiledContainerEntry
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,212 @@
|
||||
/*!
|
||||
* @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 { RMNodeBodyCreateWithRelativePath } from '../model/rMNodeBodyCreateWithRelativePath';
|
||||
import { UnfiledRecordFolderAssociationPaging } from '../model/unfiledRecordFolderAssociationPaging';
|
||||
import { UnfiledRecordFolderBodyUpdate } from '../model/unfiledRecordFolderBodyUpdate';
|
||||
import { UnfiledRecordFolderEntry } from '../model/unfiledRecordFolderEntry';
|
||||
import { BaseApi } from './base.api';
|
||||
import { buildCollectionParam } from '../../../alfrescoApiClient';
|
||||
import { throwIfNotDefined } from '../../../assert';
|
||||
import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './types';
|
||||
|
||||
/**
|
||||
* UnfiledRecordFoldersApi service.
|
||||
*
|
||||
* @module UnfiledRecordFoldersApi
|
||||
*/
|
||||
export class UnfiledRecordFoldersApi extends BaseApi {
|
||||
/**
|
||||
* Create a record or an unfiled record folder
|
||||
*
|
||||
* @param unfiledRecordFolderId The identifier of an unfiled record folder.
|
||||
* @param nodeBodyCreate The node information to create.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.autoRename If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
* @returns Promise<UnfiledRecordFolderAssociationPaging>
|
||||
*/
|
||||
createUnfiledRecordFolderChildren(
|
||||
unfiledRecordFolderId: string,
|
||||
nodeBodyCreate: RMNodeBodyCreateWithRelativePath,
|
||||
opts?: {
|
||||
autoRename?: boolean;
|
||||
} & RecordsIncludeQuery
|
||||
): Promise<UnfiledRecordFolderAssociationPaging> {
|
||||
throwIfNotDefined(unfiledRecordFolderId, 'unfiledRecordFolderId');
|
||||
throwIfNotDefined(nodeBodyCreate, 'nodeBodyCreate');
|
||||
|
||||
const pathParams = {
|
||||
unfiledRecordFolderId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
autoRename: opts?.autoRename,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.post({
|
||||
path: '/unfiled-record-folders/{unfiledRecordFolderId}/children',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: nodeBodyCreate,
|
||||
contentTypes: ['application/json', 'multipart/form-data'],
|
||||
returnType: UnfiledRecordFolderAssociationPaging
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an unfiled record folder. Deleted file plan components cannot be recovered, they are deleted permanently.
|
||||
*
|
||||
* @param unfiledRecordFolderId The identifier of an unfiled record folder.
|
||||
* @returns Promise<{}>
|
||||
*/
|
||||
deleteUnfiledRecordFolder(unfiledRecordFolderId: string): Promise<void> {
|
||||
throwIfNotDefined(unfiledRecordFolderId, 'unfiledRecordFolderId');
|
||||
|
||||
const pathParams = {
|
||||
unfiledRecordFolderId
|
||||
};
|
||||
|
||||
return this.delete({
|
||||
path: '/unfiled-record-folders/{unfiledRecordFolderId}',
|
||||
pathParams
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the unfiled record folder
|
||||
*
|
||||
* Mandatory fields and the unfiled record folder's aspects and properties are returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param unfiledRecordFolderId The identifier of an unfiled record folder.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.relativePath Return information on children in the unfiled records container resolved by this path. The path is relative to **unfiledRecordFolderId**.
|
||||
* @returns Promise<UnfiledRecordFolderEntry>
|
||||
*/
|
||||
getUnfiledRecordFolder(
|
||||
unfiledRecordFolderId: string,
|
||||
opts?: {
|
||||
relativePath?: string;
|
||||
} & RecordsIncludeQuery
|
||||
): Promise<UnfiledRecordFolderEntry> {
|
||||
throwIfNotDefined(unfiledRecordFolderId, 'unfiledRecordFolderId');
|
||||
|
||||
const pathParams = {
|
||||
unfiledRecordFolderId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
relativePath: opts?.relativePath,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/unfiled-record-folders/{unfiledRecordFolderId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: UnfiledRecordFolderEntry
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List unfiled record folder's children
|
||||
*
|
||||
* Minimal information for each child is returned by default.
|
||||
* You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
*
|
||||
* @param unfiledRecordFolderId The identifier of an unfiled record folder.
|
||||
* @param opts Optional parameters
|
||||
* @param opts.where Optionally filter the list. Here are some examples:
|
||||
* - where=(isRecord=true)
|
||||
* - where=(isUnfiledRecordFolder=false)
|
||||
* - where=(nodeType='cm:content INCLUDESUBTYPES')
|
||||
* @param opts.relativePath Return information on children in the unfiled records container resolved by this path. The path is relative to **unfiledRecordFolderId**.
|
||||
* @returns Promise<UnfiledRecordFolderAssociationPaging>
|
||||
*/
|
||||
listUnfiledRecordFolderChildren(
|
||||
unfiledRecordFolderId: string,
|
||||
opts?: {
|
||||
where?: string;
|
||||
relativePath?: string[];
|
||||
} & RecordsIncludeQuery &
|
||||
RecordsPagingQuery &
|
||||
RecordsSourceQuery
|
||||
): Promise<UnfiledRecordFolderAssociationPaging> {
|
||||
throwIfNotDefined(unfiledRecordFolderId, 'unfiledRecordFolderId');
|
||||
opts = opts || {};
|
||||
|
||||
const pathParams = {
|
||||
unfiledRecordFolderId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
skipCount: opts?.skipCount,
|
||||
maxItems: opts?.maxItems,
|
||||
where: opts?.where,
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
relativePath: opts?.relativePath,
|
||||
includeSource: opts?.includeSource,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.get({
|
||||
path: '/unfiled-record-folders/{unfiledRecordFolderId}/children',
|
||||
pathParams,
|
||||
queryParams,
|
||||
returnType: UnfiledRecordFolderAssociationPaging
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates unfiled record folder **unfiledRecordFolderId**.
|
||||
* For example, you can rename a record folder:
|
||||
*
|
||||
* @param unfiledRecordFolderId The identifier of an unfiled record folder.
|
||||
* @param unfiledRecordFolderBodyUpdate The record folder information to update.
|
||||
* @param opts Optional parameters
|
||||
* @returns Promise<UnfiledRecordFolderEntry>
|
||||
*/
|
||||
updateUnfiledRecordFolder(
|
||||
unfiledRecordFolderId: string,
|
||||
unfiledRecordFolderBodyUpdate: UnfiledRecordFolderBodyUpdate,
|
||||
opts?: RecordsIncludeQuery & RecordsSourceQuery
|
||||
): Promise<UnfiledRecordFolderEntry> {
|
||||
throwIfNotDefined(unfiledRecordFolderId, 'unfiledRecordFolderId');
|
||||
throwIfNotDefined(unfiledRecordFolderBodyUpdate, 'unfiledRecordFolderBodyUpdate');
|
||||
|
||||
const pathParams = {
|
||||
unfiledRecordFolderId
|
||||
};
|
||||
|
||||
const queryParams = {
|
||||
include: buildCollectionParam(opts?.include, 'csv'),
|
||||
includeSource: opts?.includeSource,
|
||||
fields: buildCollectionParam(opts?.fields, 'csv')
|
||||
};
|
||||
|
||||
return this.put({
|
||||
path: '/unfiled-record-folders/{unfiledRecordFolderId}',
|
||||
pathParams,
|
||||
queryParams,
|
||||
bodyParam: unfiledRecordFolderBodyUpdate,
|
||||
returnType: UnfiledRecordFolderEntry
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
# ChildAssociationInfo
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**assocType** | **string** | | [default to null]
|
||||
**isPrimary** | **boolean** | | [default to null]
|
||||
|
||||
|
||||
11
lib/js-api/src/api/gs-core-rest-api/docs/ContentInfo.md
Normal file
11
lib/js-api/src/api/gs-core-rest-api/docs/ContentInfo.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# ContentInfo
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**mimeType** | **string** | | [default to null]
|
||||
**mimeTypeName** | **string** | | [default to null]
|
||||
**sizeInBytes** | **number** | | [default to null]
|
||||
**encoding** | **string** | | [default to null]
|
||||
|
||||
|
||||
8
lib/js-api/src/api/gs-core-rest-api/docs/Error.md
Normal file
8
lib/js-api/src/api/gs-core-rest-api/docs/Error.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ModelError
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | [**ErrorError**](ErrorError.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
13
lib/js-api/src/api/gs-core-rest-api/docs/Error_error.md
Normal file
13
lib/js-api/src/api/gs-core-rest-api/docs/Error_error.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# 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]
|
||||
**logId** | **string** | | [optional] [default to null]
|
||||
|
||||
|
||||
21
lib/js-api/src/api/gs-core-rest-api/docs/FilePlan.md
Normal file
21
lib/js-api/src/api/gs-core-rest-api/docs/FilePlan.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# FilePlan
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# FilePlanBodyUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**properties** | **{ [key: string]: string; }** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
# FilePlanComponentBodyUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [optional] [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **{ [key: string]: string; }** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# FilePlanEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**FilePlan**](FilePlan.md) | | [default to null]
|
||||
|
||||
|
||||
404
lib/js-api/src/api/gs-core-rest-api/docs/FilePlansApi.md
Normal file
404
lib/js-api/src/api/gs-core-rest-api/docs/FilePlansApi.md
Normal file
@@ -0,0 +1,404 @@
|
||||
# FilePlansApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createFilePlanCategories**](FilePlansApi.md#createFilePlanCategories) | **POST** /file-plans/{filePlanId}/categories | Create record categories for a file plan
|
||||
[**getFilePlan**](FilePlansApi.md#getFilePlan) | **GET** /file-plans/{filePlanId} | Get a file plan
|
||||
[**getFilePlanCategories**](FilePlansApi.md#getFilePlanCategories) | **GET** /file-plans/{filePlanId}/categories | List file plans's children
|
||||
[**updateFilePlan**](FilePlansApi.md#updateFilePlan) | **PUT** /file-plans/{filePlanId} | Update a file plan
|
||||
|
||||
|
||||
<a name="createFilePlanCategories"></a>
|
||||
# **createFilePlanCategories**
|
||||
> RecordCategoryEntry createFilePlanCategories(filePlanIdnodeBodyCreateopts)
|
||||
|
||||
Create record categories for a file plan
|
||||
|
||||
Creates a record category as a primary child of **filePlanId**.
|
||||
|
||||
You can set the **autoRename** boolean field to automatically resolve name clashes. If there is a name clash, then
|
||||
the API method tries to create
|
||||
a unique name using an integer suffix.
|
||||
|
||||
This API method also supports record category creation using application/json.
|
||||
|
||||
You must specify at least a **name**.
|
||||
|
||||
You can create a category like this:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Record Category\"
|
||||
}
|
||||
|
||||
You can set properties when creating a record category:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Record Category\",
|
||||
\"properties\":
|
||||
{
|
||||
\"rma:vitalRecordIndicator\":\"true\",
|
||||
\"rma:reviewPeriod\":\"month|1\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Any missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.
|
||||
|
||||
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 FilePlansApi from 'FilePlansApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let fileplansApi = new FilePlansApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'autoRename': true // | If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
|
||||
'include': // | Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
fileplansApi.createFilePlanCategories(filePlanIdnodeBodyCreateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filePlanId** | **string**| The identifier of a file plan. You can also use the -filePlan- alias. |
|
||||
**nodeBodyCreate** | [**RootCategoryBodyCreate**](RootCategoryBodyCreate.md)| The node information to create. |
|
||||
**autoRename** | **boolean**| If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
| [optional]
|
||||
**include** | [**string**](string.md)| Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordCategoryEntry**](RecordCategoryEntry.md)
|
||||
|
||||
<a name="getFilePlan"></a>
|
||||
# **getFilePlan**
|
||||
> FilePlanEntry getFilePlan(filePlanIdopts)
|
||||
|
||||
Get a file plan
|
||||
|
||||
Gets information for file plan **filePlanId**
|
||||
|
||||
Mandatory fields and the file plan's aspects and properties are returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import FilePlansApi from 'FilePlansApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let fileplansApi = new FilePlansApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the file plan. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
fileplansApi.getFilePlan(filePlanIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filePlanId** | **string**| The identifier of a file plan. You can also use the -filePlan- alias. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the file plan. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**FilePlanEntry**](FilePlanEntry.md)
|
||||
|
||||
<a name="getFilePlanCategories"></a>
|
||||
# **getFilePlanCategories**
|
||||
> RecordCategoryPaging getFilePlanCategories(filePlanIdopts)
|
||||
|
||||
List file plans's children
|
||||
|
||||
Returns a list of record categories.
|
||||
|
||||
Minimal information for each child is returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import FilePlansApi from 'FilePlansApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let fileplansApi = new FilePlansApi(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.
|
||||
'include': // | Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
* properties
|
||||
|
||||
'includeSource': true // | Also include **source** (in addition to **entries**) with folder information on the parent node – the specified parent **filePlanId**
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
fileplansApi.getFilePlanCategories(filePlanIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filePlanId** | **string**| The identifier of a file plan. You can also use the -filePlan- alias. |
|
||||
**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]
|
||||
**include** | [**string**](string.md)| Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
* properties
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** (in addition to **entries**) with folder information on the parent node – the specified parent **filePlanId** | [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
|
||||
|
||||
[**RecordCategoryPaging**](RecordCategoryPaging.md)
|
||||
|
||||
<a name="updateFilePlan"></a>
|
||||
# **updateFilePlan**
|
||||
> FilePlanEntry updateFilePlan(filePlanIdfilePlanBodyUpdateopts)
|
||||
|
||||
Update a file plan
|
||||
|
||||
Updates file plan **filePlanId**.
|
||||
You can only set or update description and title properties:
|
||||
JSON
|
||||
{
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:description\": \"New Description\",
|
||||
\"cm:title\":\"New Title\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
**Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import FilePlansApi from 'FilePlansApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let fileplansApi = new FilePlansApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the file plan. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
fileplansApi.updateFilePlan(filePlanIdfilePlanBodyUpdateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filePlanId** | **string**| The identifier of a file plan. You can also use the -filePlan- alias. |
|
||||
**filePlanBodyUpdate** | [**FilePlanBodyUpdate**](FilePlanBodyUpdate.md)| The file plan information to update. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the file plan. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**FilePlanEntry**](FilePlanEntry.md)
|
||||
|
||||
88
lib/js-api/src/api/gs-core-rest-api/docs/FilesApi.md
Normal file
88
lib/js-api/src/api/gs-core-rest-api/docs/FilesApi.md
Normal file
@@ -0,0 +1,88 @@
|
||||
# FilesApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**declareRecord**](FilesApi.md#declareRecord) | **POST** /files/{fileId}/declare | Declare as record
|
||||
|
||||
|
||||
<a name="declareRecord"></a>
|
||||
# **declareRecord**
|
||||
> RecordEntry declareRecord(fileIdopts)
|
||||
|
||||
Declare as record
|
||||
|
||||
Declares the file **fileId** in the unfiled records container. The original file is moved to the Records Management site and a secondary parent association is created in the file's original site.
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import FilesApi from 'FilesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let filesApi = new FilesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'hideRecord': true // | Flag to indicate whether the record should be hidden from the current parent folder.
|
||||
'include': // | Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
filesApi.declareRecord(fileIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**fileId** | **string**| The identifier of a non-record file. |
|
||||
**hideRecord** | **boolean**| Flag to indicate whether the record should be hidden from the current parent folder. | [optional] [default to false]
|
||||
**include** | [**string**](string.md)| Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordEntry**](RecordEntry.md)
|
||||
|
||||
243
lib/js-api/src/api/gs-core-rest-api/docs/GssitesApi.md
Normal file
243
lib/js-api/src/api/gs-core-rest-api/docs/GssitesApi.md
Normal file
@@ -0,0 +1,243 @@
|
||||
# GssitesApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createRMSite**](GssitesApi.md#createRMSite) | **POST** /gs-sites | Create the Records Management (RM) site
|
||||
[**deleteRMSite**](GssitesApi.md#deleteRMSite) | **DELETE** /gs-sites/rm | Delete the Records Management (RM) site
|
||||
[**getRMSite**](GssitesApi.md#getRMSite) | **GET** /gs-sites/rm | Get the Records Management (RM) site
|
||||
[**updateRMSite**](GssitesApi.md#updateRMSite) | **PUT** /gs-sites/rm | Update the Records Management (RM) site
|
||||
|
||||
|
||||
<a name="createRMSite"></a>
|
||||
# **createRMSite**
|
||||
> RMSiteEntry createRMSite(siteBodyCreateopts)
|
||||
|
||||
Create the Records Management (RM) site
|
||||
|
||||
|
||||
Creates the RM site with the given details.
|
||||
|
||||
**Note:** The default site id is rm and the default site name is Records Management. The id of a site cannot be updated once the site has been created.
|
||||
|
||||
For example, to create an RM site named \"Records Management\" with \"Records Management Description\" as description, the following body could be used:
|
||||
JSON
|
||||
{
|
||||
\"title\": \"Records Management\",
|
||||
\"description\": \"Records Management Description\"
|
||||
}
|
||||
|
||||
|
||||
The creator will be added as a member with Site Manager role.
|
||||
|
||||
When you create the RM site, the **filePlan** structure is also created including special containers, such as containers for transfers, holds and, unfiled records.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import GssitesApi from 'GssitesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let gssitesApi = new GssitesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'skipAddToFavorites': true // | Flag to indicate whether the RM site should not be added to the user's site favorites.
|
||||
};
|
||||
|
||||
gssitesApi.createRMSite(siteBodyCreateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**siteBodyCreate** | [**RMSiteBodyCreate**](RMSiteBodyCreate.md)| The site details |
|
||||
**skipAddToFavorites** | **boolean**| Flag to indicate whether the RM site should not be added to the user's site favorites. | [optional] [default to false]
|
||||
|
||||
### Return type
|
||||
|
||||
[**RMSiteEntry**](RMSiteEntry.md)
|
||||
|
||||
<a name="deleteRMSite"></a>
|
||||
# **deleteRMSite**
|
||||
> deleteRMSite()
|
||||
|
||||
Delete the Records Management (RM) site
|
||||
|
||||
|
||||
Deletes the RM site.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import GssitesApi from 'GssitesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let gssitesApi = new GssitesApi(this.alfrescoApi);
|
||||
|
||||
gssitesApi.deleteRMSite().then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="getRMSite"></a>
|
||||
# **getRMSite**
|
||||
> RMSiteEntry getRMSite(opts)
|
||||
|
||||
Get the Records Management (RM) site
|
||||
|
||||
|
||||
Gets information for RM site.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import GssitesApi from 'GssitesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let gssitesApi = new GssitesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
gssitesApi.getRMSite(opts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**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
|
||||
|
||||
[**RMSiteEntry**](RMSiteEntry.md)
|
||||
|
||||
<a name="updateRMSite"></a>
|
||||
# **updateRMSite**
|
||||
> RMSiteEntry updateRMSite(siteBodyUpdateopts)
|
||||
|
||||
Update the Records Management (RM) site
|
||||
|
||||
|
||||
Update the details for the RM site. Site Manager or other (site) admin can update title or description.
|
||||
|
||||
**Note**: the id, site visibility, or compliance of the RM site cannot be updated once the site has been created.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import GssitesApi from 'GssitesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let gssitesApi = new GssitesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
gssitesApi.updateRMSite(siteBodyUpdateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**siteBodyUpdate** | [**RMSiteBodyUpdate**](RMSiteBodyUpdate.md)| The RM site information to update. |
|
||||
**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
|
||||
|
||||
[**RMSiteEntry**](RMSiteEntry.md)
|
||||
|
||||
23
lib/js-api/src/api/gs-core-rest-api/docs/Pagination.md
Normal file
23
lib/js-api/src/api/gs-core-rest-api/docs/Pagination.md
Normal 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]
|
||||
|
||||
|
||||
9
lib/js-api/src/api/gs-core-rest-api/docs/PathElement.md
Normal file
9
lib/js-api/src/api/gs-core-rest-api/docs/PathElement.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# PathElement
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [optional] [default to null]
|
||||
**name** | **string** | | [optional] [default to null]
|
||||
|
||||
|
||||
10
lib/js-api/src/api/gs-core-rest-api/docs/PathInfo.md
Normal file
10
lib/js-api/src/api/gs-core-rest-api/docs/PathInfo.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# PathInfo
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**elements** | [**PathElement[]**](PathElement.md) | | [optional] [default to null]
|
||||
**name** | **string** | | [optional] [default to null]
|
||||
**isCompleted** | **boolean** | | [optional] [default to null]
|
||||
|
||||
|
||||
13
lib/js-api/src/api/gs-core-rest-api/docs/RMNodeBodyCreate.md
Normal file
13
lib/js-api/src/api/gs-core-rest-api/docs/RMNodeBodyCreate.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# RMNodeBodyCreate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **{ [key: string]: string; }** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
# RMNodeBodyCreateWithRelativePath
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **{ [key: string]: string; }** | | [optional] [default to null]
|
||||
**relativePath** | **string** | | [optional] [default to null]
|
||||
|
||||
|
||||
53
lib/js-api/src/api/gs-core-rest-api/docs/RMSite.md
Normal file
53
lib/js-api/src/api/gs-core-rest-api/docs/RMSite.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# RMSite
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**guid** | **string** | | [default to null]
|
||||
**title** | **string** | | [default to null]
|
||||
**description** | **string** | | [optional] [default to null]
|
||||
**visibility** | **string** | | [default to null]
|
||||
**compliance** | **string** | | [default to null]
|
||||
**role** | **string** | | [optional] [default to null]
|
||||
|
||||
|
||||
<a name="RMSite.VisibilityEnum"></a>
|
||||
## Enum: RMSite.VisibilityEnum
|
||||
|
||||
|
||||
* `PRIVATE` (value: `'PRIVATE'`)
|
||||
|
||||
* `MODERATED` (value: `'MODERATED'`)
|
||||
|
||||
* `PUBLIC` (value: `'PUBLIC'`)
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="RMSite.ComplianceEnum"></a>
|
||||
## Enum: RMSite.ComplianceEnum
|
||||
|
||||
|
||||
* `STANDARD` (value: `'STANDARD'`)
|
||||
|
||||
* `DOD5015` (value: `'DOD5015'`)
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="RMSite.RoleEnum"></a>
|
||||
## Enum: RMSite.RoleEnum
|
||||
|
||||
|
||||
* `SiteConsumer` (value: `'SiteConsumer'`)
|
||||
|
||||
* `SiteCollaborator` (value: `'SiteCollaborator'`)
|
||||
|
||||
* `SiteContributor` (value: `'SiteContributor'`)
|
||||
|
||||
* `SiteManager` (value: `'SiteManager'`)
|
||||
|
||||
|
||||
|
||||
|
||||
21
lib/js-api/src/api/gs-core-rest-api/docs/RMSiteBodyCreate.md
Normal file
21
lib/js-api/src/api/gs-core-rest-api/docs/RMSiteBodyCreate.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# RMSiteBodyCreate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**title** | **string** | | [default to null]
|
||||
**description** | **string** | | [optional] [default to null]
|
||||
**compliance** | **string** | | [optional] [default to null]
|
||||
|
||||
|
||||
<a name="RMSiteBodyCreate.ComplianceEnum"></a>
|
||||
## Enum: RMSiteBodyCreate.ComplianceEnum
|
||||
|
||||
|
||||
* `STANDARD` (value: `'STANDARD'`)
|
||||
|
||||
* `DOD5015` (value: `'DOD5015'`)
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
# RMSiteBodyUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**title** | **string** | | [optional] [default to null]
|
||||
**description** | **string** | | [optional] [default to null]
|
||||
|
||||
|
||||
8
lib/js-api/src/api/gs-core-rest-api/docs/RMSiteEntry.md
Normal file
8
lib/js-api/src/api/gs-core-rest-api/docs/RMSiteEntry.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# RMSiteEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**RMSite**](RMSite.md) | | [default to null]
|
||||
|
||||
|
||||
23
lib/js-api/src/api/gs-core-rest-api/docs/Record.md
Normal file
23
lib/js-api/src/api/gs-core-rest-api/docs/Record.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Record
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isCompleted** | **boolean** | Present only for record nodes. Indicates if the record is completed | [optional] [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**content** | [**ContentInfo**](ContentInfo.md) | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
526
lib/js-api/src/api/gs-core-rest-api/docs/RecordCategoriesApi.md
Normal file
526
lib/js-api/src/api/gs-core-rest-api/docs/RecordCategoriesApi.md
Normal file
@@ -0,0 +1,526 @@
|
||||
# RecordCategoriesApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createRecordCategoryChild**](RecordCategoriesApi.md#createRecordCategoryChild) | **POST** /record-categories/{recordCategoryId}/children | Create a record category or a record folder
|
||||
[**deleteRecordCategory**](RecordCategoriesApi.md#deleteRecordCategory) | **DELETE** /record-categories/{recordCategoryId} | Delete a record category
|
||||
[**getRecordCategory**](RecordCategoriesApi.md#getRecordCategory) | **GET** /record-categories/{recordCategoryId} | Get a record category
|
||||
[**listRecordCategoryChildren**](RecordCategoriesApi.md#listRecordCategoryChildren) | **GET** /record-categories/{recordCategoryId}/children | List record category's children
|
||||
[**updateRecordCategory**](RecordCategoriesApi.md#updateRecordCategory) | **PUT** /record-categories/{recordCategoryId} | Update a record category
|
||||
|
||||
|
||||
<a name="createRecordCategoryChild"></a>
|
||||
# **createRecordCategoryChild**
|
||||
> RecordCategoryChildEntry createRecordCategoryChild(recordCategoryIdnodeBodyCreateopts)
|
||||
|
||||
Create a record category or a record folder
|
||||
|
||||
Create a record category or a record folder as a primary child of **recordCategoryId**.
|
||||
|
||||
You can set the **autoRename** boolean field to automatically resolve name clashes. If there is a name clash, then
|
||||
the API method tries to create
|
||||
a unique name using an integer suffix.
|
||||
|
||||
This API method also supports record category or record folder creation using application/json.
|
||||
|
||||
You must specify at least a **name** and **nodeType**.
|
||||
|
||||
You can create a category like this:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Record Category\",
|
||||
\"nodeType\":\"rma:recordCategory\"
|
||||
}
|
||||
|
||||
|
||||
You can create a record folder like this:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Record Folder\",
|
||||
\"nodeType\":\"rma:recordFolder\"
|
||||
}
|
||||
|
||||
|
||||
You can create a record folder inside a container hierarchy (applies to record categories as well):
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Fileplan Component\",
|
||||
\"nodeType\":\"rma:recordFolder\",
|
||||
\"relativePath\":\"X/Y/Z\"
|
||||
}
|
||||
|
||||
The **relativePath** specifies the container structure to create relative to the node (record category or record folder). Containers in the
|
||||
**relativePath** that do not exist are created before the node is created. The container type is decided considering
|
||||
the type of the parent container and the type of the node to be created.
|
||||
|
||||
You can set properties when creating a record category (applies to record folders as well):
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Record Category\",
|
||||
\"nodeType\":\"rma:recordCategory\",
|
||||
\"properties\":
|
||||
{
|
||||
\"rma:vitalRecordIndicator\":\"true\",
|
||||
\"rma:reviewPeriod\":\"month|1\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Any missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.
|
||||
|
||||
**Note:** You can create more than one child by
|
||||
specifying a list of nodes in the JSON body. For example, the following JSON
|
||||
body creates a record category and a record folder inside the specified **categoryId**:
|
||||
JSON
|
||||
[
|
||||
{
|
||||
\"name\":\"My Record Category\",
|
||||
\"nodeType\":\"rma:recordCategory\"
|
||||
},
|
||||
{
|
||||
\"name\":\"My Record Folder\",
|
||||
\"nodeType\":\"rma:recordFolder\"
|
||||
}
|
||||
]
|
||||
|
||||
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 RecordCategoriesApi from 'RecordCategoriesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordcategoriesApi = new RecordCategoriesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'autoRename': true // | If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
|
||||
'include': // | Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordcategoriesApi.createRecordCategoryChild(recordCategoryIdnodeBodyCreateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordCategoryId** | **string**| The identifier of a record category. |
|
||||
**nodeBodyCreate** | [**RMNodeBodyCreateWithRelativePath**](RMNodeBodyCreateWithRelativePath.md)| The node information to create.
|
||||
|
|
||||
**autoRename** | **boolean**| If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
| [optional]
|
||||
**include** | [**string**](string.md)| Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordCategoryChildEntry**](RecordCategoryChildEntry.md)
|
||||
|
||||
<a name="deleteRecordCategory"></a>
|
||||
# **deleteRecordCategory**
|
||||
> deleteRecordCategory(recordCategoryId)
|
||||
|
||||
Delete a record category
|
||||
|
||||
Deletes record category **recordCategoryId**.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordCategoriesApi from 'RecordCategoriesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordcategoriesApi = new RecordCategoriesApi(this.alfrescoApi);
|
||||
|
||||
|
||||
recordcategoriesApi.deleteRecordCategory(recordCategoryId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordCategoryId** | **string**| The identifier of a record category. |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="getRecordCategory"></a>
|
||||
# **getRecordCategory**
|
||||
> RecordCategoryEntry getRecordCategory(recordCategoryIdopts)
|
||||
|
||||
Get a record category
|
||||
|
||||
Gets information for record category **recordCategoryId**
|
||||
|
||||
Mandatory fields and the record category's aspects and properties are returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordCategoriesApi from 'RecordCategoriesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordcategoriesApi = new RecordCategoriesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
|
||||
'relativePath': relativePath_example // | Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**.
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordcategoriesApi.getRecordCategory(recordCategoryIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordCategoryId** | **string**| The identifier of a record category. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
| [optional]
|
||||
**relativePath** | **string**| Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**.
|
||||
| [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
|
||||
|
||||
[**RecordCategoryEntry**](RecordCategoryEntry.md)
|
||||
|
||||
<a name="listRecordCategoryChildren"></a>
|
||||
# **listRecordCategoryChildren**
|
||||
> RecordCategoryChildPaging listRecordCategoryChildren(recordCategoryIdopts)
|
||||
|
||||
List record category's children
|
||||
|
||||
Returns a list of record categories and/or record folders.
|
||||
|
||||
Minimal information for each child is returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
The list of child nodes includes primary children and secondary children, if there are any.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordCategoriesApi from 'RecordCategoriesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordcategoriesApi = new RecordCategoriesApi(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.
|
||||
'where': where_example // | Optionally filter the list. Here are some examples:
|
||||
|
||||
* where=(nodeType='rma:recordFolder')
|
||||
|
||||
* where=(nodeType='rma:recordCategory')
|
||||
|
||||
* where=(isRecordFolder=true AND isClosed=false)
|
||||
|
||||
'include': // | Returns additional information about the record category child. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* hasRetentionSchedule
|
||||
* isClosed
|
||||
* isRecordCategory
|
||||
* isRecordFolder
|
||||
* path
|
||||
* properties
|
||||
|
||||
'relativePath': relativePath_example // | Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**.
|
||||
|
||||
'includeSource': true // | Also include **source** (in addition to **entries**) with folder information on the parent node – either the specified parent **recordCategoryId**, or as resolved by **relativePath**.
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordcategoriesApi.listRecordCategoryChildren(recordCategoryIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordCategoryId** | **string**| The identifier of a record category. |
|
||||
**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]
|
||||
**where** | **string**| Optionally filter the list. Here are some examples:
|
||||
|
||||
* where=(nodeType='rma:recordFolder')
|
||||
|
||||
* where=(nodeType='rma:recordCategory')
|
||||
|
||||
* where=(isRecordFolder=true AND isClosed=false)
|
||||
| [optional]
|
||||
**include** | [**string**](string.md)| Returns additional information about the record category child. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* hasRetentionSchedule
|
||||
* isClosed
|
||||
* isRecordCategory
|
||||
* isRecordFolder
|
||||
* path
|
||||
* properties
|
||||
| [optional]
|
||||
**relativePath** | **string**| Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**.
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** (in addition to **entries**) with folder information on the parent node – either the specified parent **recordCategoryId**, or as resolved by **relativePath**. | [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
|
||||
|
||||
[**RecordCategoryChildPaging**](RecordCategoryChildPaging.md)
|
||||
|
||||
<a name="updateRecordCategory"></a>
|
||||
# **updateRecordCategory**
|
||||
> RecordCategoryEntry updateRecordCategory(recordCategoryIdrecordCategoryBodyUpdateopts)
|
||||
|
||||
Update a record category
|
||||
|
||||
Updates record category **recordCategoryId**. For example, you can rename a record category:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My new name\"
|
||||
}
|
||||
|
||||
You can also set or update one or more properties:
|
||||
JSON
|
||||
{
|
||||
\"properties\":
|
||||
{
|
||||
\"rma:vitalRecordIndicator\": true,
|
||||
\"rma:reviewPeriod\":\"month|6\"
|
||||
}
|
||||
}
|
||||
|
||||
**Note:** If you want to add or remove aspects, then you must use **GET /record-categories/{recordCategoryId}** first to get the complete set of *aspectNames*.
|
||||
|
||||
**Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordCategoriesApi from 'RecordCategoriesApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordcategoriesApi = new RecordCategoriesApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordcategoriesApi.updateRecordCategory(recordCategoryIdrecordCategoryBodyUpdateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordCategoryId** | **string**| The identifier of a record category. |
|
||||
**recordCategoryBodyUpdate** | [**FilePlanComponentBodyUpdate**](FilePlanComponentBodyUpdate.md)| The record category information to update. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the record category. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* hasRetentionSchedule
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordCategoryEntry**](RecordCategoryEntry.md)
|
||||
|
||||
22
lib/js-api/src/api/gs-core-rest-api/docs/RecordCategory.md
Normal file
22
lib/js-api/src/api/gs-core-rest-api/docs/RecordCategory.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# RecordCategory
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**hasRetentionSchedule** | **boolean** | Indicates if the record category has a retention schedule defined | [optional] [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# RecordCategoryChild
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**hasRetentionSchedule** | **boolean** | Indicates if the record category has a retention schedule defined | [optional] [default to null]
|
||||
**isClosed** | **boolean** | Indicates if the record folder is closed | [optional] [default to null]
|
||||
**isRecordCategory** | **boolean** | | [optional] [default to null]
|
||||
**isRecordFolder** | **boolean** | | [optional] [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# RecordCategoryChildEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**RecordCategoryChild**](RecordCategoryChild.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# RecordCategoryChildPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**RecordCategoryChildPagingList**](RecordCategoryChildPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# RecordCategoryChildPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**RecordCategoryChildEntry[]**](RecordCategoryChildEntry.md) | | [optional] [default to null]
|
||||
**source** | [**RecordCategory**](RecordCategory.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# RecordCategoryEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**RecordCategory**](RecordCategory.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# RecordCategoryPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**RecordCategoryPagingList**](RecordCategoryPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# RecordCategoryPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**RecordCategoryEntry[]**](RecordCategoryEntry.md) | | [optional] [default to null]
|
||||
**source** | [**FilePlan**](FilePlan.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
8
lib/js-api/src/api/gs-core-rest-api/docs/RecordEntry.md
Normal file
8
lib/js-api/src/api/gs-core-rest-api/docs/RecordEntry.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# RecordEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**Record**](Record.md) | | [default to null]
|
||||
|
||||
|
||||
22
lib/js-api/src/api/gs-core-rest-api/docs/RecordFolder.md
Normal file
22
lib/js-api/src/api/gs-core-rest-api/docs/RecordFolder.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# RecordFolder
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isClosed** | **boolean** | Indicates if the record folder is closed | [optional] [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# RecordFolderAssociationPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**RecordFolderAssociationPagingList**](RecordFolderAssociationPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# RecordFolderAssociationPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**RecordFolderChildAssociationEntry[]**](RecordFolderChildAssociationEntry.md) | | [optional] [default to null]
|
||||
**source** | [**RecordFolder**](RecordFolder.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# RecordFolderChildAssociation
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isCompleted** | **boolean** | Present only for record nodes. Indicates if the record is completed | [optional] [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**content** | [**ContentInfo**](ContentInfo.md) | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
**association** | [**ChildAssociationInfo**](ChildAssociationInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# RecordFolderChildAssociationEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**RecordFolderChildAssociation**](RecordFolderChildAssociation.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# RecordFolderEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**RecordFolder**](RecordFolder.md) | | [default to null]
|
||||
|
||||
|
||||
508
lib/js-api/src/api/gs-core-rest-api/docs/RecordFoldersApi.md
Normal file
508
lib/js-api/src/api/gs-core-rest-api/docs/RecordFoldersApi.md
Normal file
@@ -0,0 +1,508 @@
|
||||
# RecordFoldersApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createRecordFolderChild**](RecordFoldersApi.md#createRecordFolderChild) | **POST** /record-folders/{recordFolderId}/records | Create a record
|
||||
[**deleteRecordFolder**](RecordFoldersApi.md#deleteRecordFolder) | **DELETE** /record-folders/{recordFolderId} | Delete a record folder
|
||||
[**getRecordFolder**](RecordFoldersApi.md#getRecordFolder) | **GET** /record-folders/{recordFolderId} | Get a record folder
|
||||
[**listRecordFolderChildren**](RecordFoldersApi.md#listRecordFolderChildren) | **GET** /record-folders/{recordFolderId}/records | List records
|
||||
[**updateRecordFolder**](RecordFoldersApi.md#updateRecordFolder) | **PUT** /record-folders/{recordFolderId} | Update a record folder
|
||||
|
||||
|
||||
<a name="createRecordFolderChild"></a>
|
||||
# **createRecordFolderChild**
|
||||
> RecordEntry createRecordFolderChild(recordFolderIdrecordBodyCreateopts)
|
||||
|
||||
Create a record
|
||||
|
||||
Create a record as a primary child of **recordFolderId**.
|
||||
|
||||
This endpoint supports both JSON and multipart/form-data (file upload).
|
||||
|
||||
**Using multipart/form-data**
|
||||
|
||||
Use the **filedata** field to represent the content to upload, for example, the following curl command will
|
||||
create a node with the contents of test.txt in the test user's home folder.
|
||||
|
||||
curl -utest:test -X POST host:port/alfresco/api/-default-/public/gs/versions/1/record-folders/{recordFolderId}/records -F filedata=@test.txt
|
||||
|
||||
This API method also supports record creation using application/json.
|
||||
|
||||
You must specify at least a **name** and **nodeType**.
|
||||
|
||||
|
||||
You can create a non-electronic record like this:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Non-electronic Record\",
|
||||
\"nodeType\":\"rma:nonElectronicDocument\",
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:description\":\"My Non-electronic Record Description\",
|
||||
\"cm:title\":\"My Non-electronic Record Title\",
|
||||
\"rma:box\":\"My Non-electronic Record Box\",
|
||||
\"rma:file\":\"My Non-electronic Record File\",
|
||||
\"rma:numberOfCopies\":1,
|
||||
\"rma:physicalSize\":30,
|
||||
\"rma:shelf\":\"My Non-electronic Record Shelf\",
|
||||
\"rma:storageLocation\":\"My Non-electronic Record Location\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
You can create an empty electronic record:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Electronic Record\",
|
||||
\"nodeType\":\"cm:content\"
|
||||
}
|
||||
|
||||
|
||||
Any missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.
|
||||
|
||||
**Note:** You can create more than one child by
|
||||
specifying a list of nodes in the JSON body. For example, the following JSON
|
||||
body creates a record category and a record folder inside the specified **categoryId**:
|
||||
JSON
|
||||
[
|
||||
{
|
||||
\"name\":\"Record 1\",
|
||||
\"nodeType\":\"cm:content\"
|
||||
},
|
||||
{
|
||||
\"name\":\"Record 2\",
|
||||
\"nodeType\":\"cm:content\"
|
||||
}
|
||||
]
|
||||
|
||||
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 RecordFoldersApi from 'RecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordfoldersApi = new RecordFoldersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordfoldersApi.createRecordFolderChild(recordFolderIdrecordBodyCreateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordFolderId** | **string**| The identifier of a record folder. |
|
||||
**recordBodyCreate** | [**RMNodeBodyCreate**](RMNodeBodyCreate.md)| The record information to create.
|
||||
|
||||
This field is ignored for multipart/form-data content uploads.
|
||||
|
|
||||
**include** | [**string**](string.md)| Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordEntry**](RecordEntry.md)
|
||||
|
||||
<a name="deleteRecordFolder"></a>
|
||||
# **deleteRecordFolder**
|
||||
> deleteRecordFolder(recordFolderId)
|
||||
|
||||
Delete a record folder
|
||||
|
||||
Deletes record folder **recordFolderId**. Deleted file plan components cannot be recovered, they are deleted permanently.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordFoldersApi from 'RecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordfoldersApi = new RecordFoldersApi(this.alfrescoApi);
|
||||
|
||||
|
||||
recordfoldersApi.deleteRecordFolder(recordFolderId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordFolderId** | **string**| The identifier of a record folder. |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="getRecordFolder"></a>
|
||||
# **getRecordFolder**
|
||||
> RecordFolderEntry getRecordFolder(recordFolderIdopts)
|
||||
|
||||
Get a record folder
|
||||
|
||||
Gets information for record folder **recordFolderId**
|
||||
|
||||
Mandatory fields and the record folder's aspects and properties are returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordFoldersApi from 'RecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordfoldersApi = new RecordFoldersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record folders. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* isClosed
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordfoldersApi.getRecordFolder(recordFolderIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordFolderId** | **string**| The identifier of a record folder. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the record folders. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* isClosed
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordFolderEntry**](RecordFolderEntry.md)
|
||||
|
||||
<a name="listRecordFolderChildren"></a>
|
||||
# **listRecordFolderChildren**
|
||||
> RecordFolderAssociationPaging listRecordFolderChildren(recordFolderIdopts)
|
||||
|
||||
List records
|
||||
|
||||
Gets a list of records.
|
||||
|
||||
Minimal information for each record is returned by default.
|
||||
|
||||
The list of records includes primary children and secondary children, if there are any.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordFoldersApi from 'RecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordfoldersApi = new RecordFoldersApi(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.
|
||||
'where': where_example // | Optionally filter the list. Here are some examples:
|
||||
|
||||
* where=(nodeType='my:specialNodeType')
|
||||
|
||||
* where=(nodeType='my:specialNodeType INCLUDESUBTYPES')
|
||||
|
||||
* where=(isPrimary=true)
|
||||
|
||||
'include': // | Returns additional information about the records. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* association
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
* properties
|
||||
|
||||
'includeSource': true // | Also include **source** (in addition to **entries**) with record information on the parent folder – the specified parent **recordFolderId**
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordfoldersApi.listRecordFolderChildren(recordFolderIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordFolderId** | **string**| The identifier of a record folder. |
|
||||
**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]
|
||||
**where** | **string**| Optionally filter the list. Here are some examples:
|
||||
|
||||
* where=(nodeType='my:specialNodeType')
|
||||
|
||||
* where=(nodeType='my:specialNodeType INCLUDESUBTYPES')
|
||||
|
||||
* where=(isPrimary=true)
|
||||
| [optional]
|
||||
**include** | [**string**](string.md)| Returns additional information about the records. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* association
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
* properties
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** (in addition to **entries**) with record information on the parent folder – the specified parent **recordFolderId** | [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
|
||||
|
||||
[**RecordFolderAssociationPaging**](RecordFolderAssociationPaging.md)
|
||||
|
||||
<a name="updateRecordFolder"></a>
|
||||
# **updateRecordFolder**
|
||||
> RecordFolderEntry updateRecordFolder(recordFolderIdrecordFolderBodyUpdateopts)
|
||||
|
||||
Update a record folder
|
||||
|
||||
Updates record folder **recordFolderId**. For example, you can rename a record folder:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My new name\"
|
||||
}
|
||||
|
||||
You can also set or update one or more properties:
|
||||
JSON
|
||||
{
|
||||
\"properties\":
|
||||
{
|
||||
\"rma:vitalRecordIndicator\": true,
|
||||
\"rma:reviewPeriod\":\"month|6\"
|
||||
}
|
||||
}
|
||||
|
||||
**Note:** if you want to add or remove aspects, then you must use **GET /record-folders/{recordFolderId}** first to get the complete set of *aspectNames*.
|
||||
|
||||
**Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordFoldersApi from 'RecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordfoldersApi = new RecordFoldersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record folders. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* isClosed
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordfoldersApi.updateRecordFolder(recordFolderIdrecordFolderBodyUpdateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordFolderId** | **string**| The identifier of a record folder. |
|
||||
**recordFolderBodyUpdate** | [**FilePlanComponentBodyUpdate**](FilePlanComponentBodyUpdate.md)| The record folder information to update. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the record folders. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* isClosed
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordFolderEntry**](RecordFolderEntry.md)
|
||||
|
||||
465
lib/js-api/src/api/gs-core-rest-api/docs/RecordsApi.md
Normal file
465
lib/js-api/src/api/gs-core-rest-api/docs/RecordsApi.md
Normal file
@@ -0,0 +1,465 @@
|
||||
# RecordsApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**completeRecord**](RecordsApi.md#completeRecord) | **POST** /records/{recordId}/complete | Complete a record
|
||||
[**deleteRecord**](RecordsApi.md#deleteRecord) | **DELETE** /records/{recordId} | Delete a record
|
||||
[**fileRecord**](RecordsApi.md#fileRecord) | **POST** /records/{recordId}/file | File a record
|
||||
[**getRecord**](RecordsApi.md#getRecord) | **GET** /records/{recordId} | Get a record
|
||||
[**getRecordContent**](RecordsApi.md#getRecordContent) | **GET** /records/{recordId}/content | Get record content
|
||||
[**updateRecord**](RecordsApi.md#updateRecord) | **PUT** /records/{recordId} | Update record
|
||||
|
||||
|
||||
<a name="completeRecord"></a>
|
||||
# **completeRecord**
|
||||
> RecordEntry completeRecord(recordIdopts)
|
||||
|
||||
Complete a record
|
||||
|
||||
Completes the record **recordId**.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordsApi from 'RecordsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordsApi = new RecordsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordsApi.completeRecord(recordIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordId** | **string**| The identifier of a record. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordEntry**](RecordEntry.md)
|
||||
|
||||
<a name="deleteRecord"></a>
|
||||
# **deleteRecord**
|
||||
> deleteRecord(recordId)
|
||||
|
||||
Delete a record
|
||||
|
||||
Deletes the record **recordId**. Deleted file plan components cannot be recovered, they are deleted permanently.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordsApi from 'RecordsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordsApi = new RecordsApi(this.alfrescoApi);
|
||||
|
||||
|
||||
recordsApi.deleteRecord(recordId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordId** | **string**| The identifier of a record. |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="fileRecord"></a>
|
||||
# **fileRecord**
|
||||
> RecordEntry fileRecord(recordIdnodeBodyFileopts)
|
||||
|
||||
File a record
|
||||
|
||||
Files the record **recordId** in the target record folder.
|
||||
|
||||
You need to specify the target record folder by providing its id **targetParentId**
|
||||
|
||||
If the record is already filed, a link to the target record folder is created.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordsApi from 'RecordsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordsApi = new RecordsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordsApi.fileRecord(recordIdnodeBodyFileopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordId** | **string**| The identifier of a record. |
|
||||
**nodeBodyFile** | [**RequestBodyFile**](RequestBodyFile.md)| The target record folder id |
|
||||
**include** | [**string**](string.md)| Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordEntry**](RecordEntry.md)
|
||||
|
||||
<a name="getRecord"></a>
|
||||
# **getRecord**
|
||||
> RecordEntry getRecord(recordIdopts)
|
||||
|
||||
Get a record
|
||||
|
||||
Gets information for record **recordId**
|
||||
|
||||
Mandatory fields and the record's aspects and properties are returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordsApi from 'RecordsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordsApi = new RecordsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordsApi.getRecord(recordIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordId** | **string**| The identifier of a record. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordEntry**](RecordEntry.md)
|
||||
|
||||
<a name="getRecordContent"></a>
|
||||
# **getRecordContent**
|
||||
> getRecordContent(recordIdopts)
|
||||
|
||||
Get record content
|
||||
|
||||
|
||||
Gets the content of the record with identifier **recordId**.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordsApi from 'RecordsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordsApi = new RecordsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'attachment': true // | **true** enables a web browser to download the file as an attachment.
|
||||
**false** means a web browser may preview the file in a new tab or window, but not
|
||||
download the file.
|
||||
|
||||
You can only set this parameter to **false** if the content type of the file is in the supported list;
|
||||
for example, certain image files and PDF files.
|
||||
|
||||
If the content type is not supported for preview, then a value of **false** is ignored, and
|
||||
the attachment will be returned in the response.
|
||||
|
||||
'ifModifiedSince': 2013-10-20T19:20:30+01:00 // | Only returns the content if it has been modified since the date provided.
|
||||
Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT.
|
||||
|
||||
};
|
||||
|
||||
recordsApi.getRecordContent(recordIdopts).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordId** | **string**| The identifier of a record. |
|
||||
**attachment** | **boolean**| **true** enables a web browser to download the file as an attachment.
|
||||
**false** means a web browser may preview the file in a new tab or window, but not
|
||||
download the file.
|
||||
|
||||
You can only set this parameter to **false** if the content type of the file is in the supported list;
|
||||
for example, certain image files and PDF files.
|
||||
|
||||
If the content type is not supported for preview, then a value of **false** is ignored, and
|
||||
the attachment will be returned in the response.
|
||||
| [optional] [default to true]
|
||||
**ifModifiedSince** | **Date**| Only returns the content if it has been modified since the date provided.
|
||||
Use the date format defined by HTTP. For example, Wed, 09 Mar 2016 16:56:34 GMT.
|
||||
| [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="updateRecord"></a>
|
||||
# **updateRecord**
|
||||
> RecordEntry updateRecord(recordIdrecordBodyUpdateopts)
|
||||
|
||||
Update record
|
||||
|
||||
Updates the record **recordId**. For example, you can rename a record:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My new name\"
|
||||
}
|
||||
|
||||
You can also set or update one or more properties:
|
||||
JSON
|
||||
{
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:title\":\"New title\",
|
||||
\"cm:description\":\"New description\"
|
||||
}
|
||||
}
|
||||
|
||||
**Note:** if you want to add or remove aspects, then you must use **GET /records/{recordId}** first to get the complete set of *aspectNames*.
|
||||
|
||||
**Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import RecordsApi from 'RecordsApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let recordsApi = new RecordsApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
recordsApi.updateRecord(recordIdrecordBodyUpdateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**recordId** | **string**| The identifier of a record. |
|
||||
**recordBodyUpdate** | [**FilePlanComponentBodyUpdate**](FilePlanComponentBodyUpdate.md)| The record information to update. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the record. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* content
|
||||
* isCompleted
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**RecordEntry**](RecordEntry.md)
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# RequestBodyFile
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**targetParentId** | **string** | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
# RootCategoryBodyCreate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **{ [key: string]: string; }** | | [optional] [default to null]
|
||||
|
||||
|
||||
21
lib/js-api/src/api/gs-core-rest-api/docs/Transfer.md
Normal file
21
lib/js-api/src/api/gs-core-rest-api/docs/Transfer.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Transfer
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**transferPDFIndicator** | **boolean** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**transferLocation** | **string** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**transferAccessionIndicator** | **boolean** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# TransferAssociationPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**TransferAssociationPagingList**](TransferAssociationPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# TransferAssociationPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**TransferChildAssociationEntry[]**](TransferChildAssociationEntry.md) | | [optional] [default to null]
|
||||
**source** | [**Transfer**](Transfer.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
24
lib/js-api/src/api/gs-core-rest-api/docs/TransferChild.md
Normal file
24
lib/js-api/src/api/gs-core-rest-api/docs/TransferChild.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# TransferChild
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isRecordFolder** | **boolean** | | [optional] [default to null]
|
||||
**isRecord** | **boolean** | | [optional] [default to null]
|
||||
**isClosed** | **boolean** | Indicates if the record folder is closed | [optional] [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
# TransferChildAssociation
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isRecordFolder** | **boolean** | | [optional] [default to null]
|
||||
**isRecord** | **boolean** | | [optional] [default to null]
|
||||
**isClosed** | **boolean** | Indicates if the record folder is closed | [optional] [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
**association** | [**ChildAssociationInfo**](ChildAssociationInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# TransferChildAssociationEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**TransferChildAssociation**](TransferChildAssociation.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
# TransferContainer
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# TransferContainerAssociationPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**TransferContainerAssociationPagingList**](TransferContainerAssociationPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# TransferContainerAssociationPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**TransferContainerChildAssociationEntry[]**](TransferContainerChildAssociationEntry.md) | | [optional] [default to null]
|
||||
**source** | [**TransferContainer**](TransferContainer.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# TransferContainerBodyUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [optional] [default to null]
|
||||
**properties** | **{ [key: string]: string; }** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
# TransferContainerChild
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**transferPDFIndicator** | **boolean** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**transferLocation** | **string** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**transferAccessionIndicator** | **boolean** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
# TransferContainerChildAssociation
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**transferPDFIndicator** | **boolean** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**transferLocation** | **string** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**transferAccessionIndicator** | **boolean** | Present only for transfer nodes. | [optional] [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**association** | [**ChildAssociationInfo**](ChildAssociationInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# TransferContainerChildAssociationEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**TransferContainerChildAssociation**](TransferContainerChildAssociation.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# TransferContainerEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**TransferContainer**](TransferContainer.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,272 @@
|
||||
# TransferContainersApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getTransferContainer**](TransferContainersApi.md#getTransferContainer) | **GET** /transfer-containers/{transferContainerId} | Get a transfer container
|
||||
[**listTransfers**](TransferContainersApi.md#listTransfers) | **GET** /transfer-containers/{transferContainerId}/transfers | List transfer container's children
|
||||
[**updateTransferContainer**](TransferContainersApi.md#updateTransferContainer) | **PUT** /transfer-containers/{transferContainerId} | Update transfer container
|
||||
|
||||
|
||||
<a name="getTransferContainer"></a>
|
||||
# **getTransferContainer**
|
||||
> TransferContainerEntry getTransferContainer(transferContainerIdopts)
|
||||
|
||||
Get a transfer container
|
||||
|
||||
Gets information for transfer container **transferContainerId**
|
||||
|
||||
Mandatory fields and the transfer container's aspects and properties are returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import TransferContainersApi from 'TransferContainersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let transfercontainersApi = new TransferContainersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the transfer container. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
transfercontainersApi.getTransferContainer(transferContainerIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**transferContainerId** | **string**| The identifier of a transfer container. You can also use the -transfers- alias. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the transfer container. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**TransferContainerEntry**](TransferContainerEntry.md)
|
||||
|
||||
<a name="listTransfers"></a>
|
||||
# **listTransfers**
|
||||
> TransferContainerAssociationPaging listTransfers(transferContainerIdopts)
|
||||
|
||||
List transfer container's children
|
||||
|
||||
Returns a list of transfers.
|
||||
|
||||
Minimal information for each child is returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import TransferContainersApi from 'TransferContainersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let transfercontainersApi = new TransferContainersApi(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.
|
||||
'include': // | Returns additional information about the transfer folders. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* properties
|
||||
* transferPDFIndicator
|
||||
* transferLocation
|
||||
* transferAccessionIndicator
|
||||
|
||||
'includeSource': true // | Also include **source** (in addition to **entries**) with folder information on the specified parent **transferContainerId**.
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
transfercontainersApi.listTransfers(transferContainerIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**transferContainerId** | **string**| The identifier of a transfer container. You can also use the -transfers- alias. |
|
||||
**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]
|
||||
**include** | [**string**](string.md)| Returns additional information about the transfer folders. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* properties
|
||||
* transferPDFIndicator
|
||||
* transferLocation
|
||||
* transferAccessionIndicator
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** (in addition to **entries**) with folder information on the specified parent **transferContainerId**. | [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
|
||||
|
||||
[**TransferContainerAssociationPaging**](TransferContainerAssociationPaging.md)
|
||||
|
||||
<a name="updateTransferContainer"></a>
|
||||
# **updateTransferContainer**
|
||||
> TransferContainerEntry updateTransferContainer(transferContainerIdnodeBodyUpdateopts)
|
||||
|
||||
Update transfer container
|
||||
|
||||
Updates the transfer container **transferContainerId**. For example, you can rename transfer container:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My new name\"
|
||||
}
|
||||
|
||||
You can also set or update description and title properties:
|
||||
JSON
|
||||
{
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:description\": \"New Description\",
|
||||
\"cm:title\":\"New Title\"
|
||||
}
|
||||
}
|
||||
|
||||
**Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import TransferContainersApi from 'TransferContainersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let transfercontainersApi = new TransferContainersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the transfer container. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
transfercontainersApi.updateTransferContainer(transferContainerIdnodeBodyUpdateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**transferContainerId** | **string**| The identifier of a transfer container. You can also use the -transfers- alias. |
|
||||
**nodeBodyUpdate** | [**TransferContainerBodyUpdate**](TransferContainerBodyUpdate.md)| The node information to update. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the transfer container. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**TransferContainerEntry**](TransferContainerEntry.md)
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# TransferEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**Transfer**](Transfer.md) | | [default to null]
|
||||
|
||||
|
||||
186
lib/js-api/src/api/gs-core-rest-api/docs/TransfersApi.md
Normal file
186
lib/js-api/src/api/gs-core-rest-api/docs/TransfersApi.md
Normal file
@@ -0,0 +1,186 @@
|
||||
# TransfersApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**getTransfer**](TransfersApi.md#getTransfer) | **GET** /transfers/{transferId} | Get a transfer
|
||||
[**listTransfersChildren**](TransfersApi.md#listTransfersChildren) | **GET** /transfers/{transferId}/children | List transfer's children
|
||||
|
||||
|
||||
<a name="getTransfer"></a>
|
||||
# **getTransfer**
|
||||
> TransferEntry getTransfer(transferIdopts)
|
||||
|
||||
Get a transfer
|
||||
|
||||
Gets information for transfer **transferId**
|
||||
|
||||
Mandatory fields and the transfer's aspects and properties are returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import TransfersApi from 'TransfersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let transfersApi = new TransfersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the transfer folder. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* transferPDFIndicator
|
||||
* transferLocation
|
||||
* transferAccessionIndicator
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
transfersApi.getTransfer(transferIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**transferId** | **string**| The identifier of a transfer. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the transfer folder. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* transferPDFIndicator
|
||||
* transferLocation
|
||||
* transferAccessionIndicator
|
||||
| [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
|
||||
|
||||
[**TransferEntry**](TransferEntry.md)
|
||||
|
||||
<a name="listTransfersChildren"></a>
|
||||
# **listTransfersChildren**
|
||||
> TransferAssociationPaging listTransfersChildren(transferIdopts)
|
||||
|
||||
List transfer's children
|
||||
|
||||
Gets a list of transfer's children.
|
||||
|
||||
Minimal information for each child is returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import TransfersApi from 'TransfersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let transfersApi = new TransfersApi(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.
|
||||
'include': // | Returns additional information about the transfer's child. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* isClosed
|
||||
* isRecord
|
||||
* isRecordFolder
|
||||
* path
|
||||
* properties
|
||||
|
||||
'includeSource': true // | Also include **source** (in addition to **entries**) with folder information on the specified parent **transferId**.
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
transfersApi.listTransfersChildren(transferIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**transferId** | **string**| The identifier of a transfer. |
|
||||
**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]
|
||||
**include** | [**string**](string.md)| Returns additional information about the transfer's child. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* isClosed
|
||||
* isRecord
|
||||
* isRecordFolder
|
||||
* path
|
||||
* properties
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** (in addition to **entries**) with folder information on the specified parent **transferId**. | [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
|
||||
|
||||
[**TransferAssociationPaging**](TransferAssociationPaging.md)
|
||||
|
||||
21
lib/js-api/src/api/gs-core-rest-api/docs/UnfiledContainer.md
Normal file
21
lib/js-api/src/api/gs-core-rest-api/docs/UnfiledContainer.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# UnfiledContainer
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# UnfiledContainerAssociationPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**UnfiledContainerAssociationPagingList**](UnfiledContainerAssociationPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# UnfiledContainerAssociationPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**UnfiledContainerChildAssociationEntry[]**](UnfiledContainerChildAssociationEntry.md) | | [optional] [default to null]
|
||||
**source** | [**UnfiledContainer**](UnfiledContainer.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# UnfiledContainerChild
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isUnfiledRecordFolder** | **boolean** | | [default to null]
|
||||
**isRecord** | **boolean** | | [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# UnfiledContainerChildAssociation
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isUnfiledRecordFolder** | **boolean** | | [default to null]
|
||||
**isRecord** | **boolean** | | [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
**association** | [**ChildAssociationInfo**](ChildAssociationInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# UnfiledContainerChildAssociationEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**UnfiledContainerChildAssociation**](UnfiledContainerChildAssociation.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# UnfiledContainerEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**UnfiledContainer**](UnfiledContainer.md) | | [default to null]
|
||||
|
||||
|
||||
467
lib/js-api/src/api/gs-core-rest-api/docs/UnfiledContainersApi.md
Normal file
467
lib/js-api/src/api/gs-core-rest-api/docs/UnfiledContainersApi.md
Normal file
@@ -0,0 +1,467 @@
|
||||
# UnfiledContainersApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createUnfiledContainerChildren**](UnfiledContainersApi.md#createUnfiledContainerChildren) | **POST** /unfiled-containers/{unfiledContainerId}/children | Create a record or an unfiled record folder
|
||||
[**getUnfiledContainer**](UnfiledContainersApi.md#getUnfiledContainer) | **GET** /unfiled-containers/{unfiledContainerId} | Get the unfiled records container
|
||||
[**listUnfiledContainerChildren**](UnfiledContainersApi.md#listUnfiledContainerChildren) | **GET** /unfiled-containers/{unfiledContainerId}/children | List unfiled record container's children
|
||||
[**updateUnfiledContainer**](UnfiledContainersApi.md#updateUnfiledContainer) | **PUT** /unfiled-containers/{unfiledContainerId} | Update an unfiled record container
|
||||
|
||||
|
||||
<a name="createUnfiledContainerChildren"></a>
|
||||
# **createUnfiledContainerChildren**
|
||||
> UnfiledContainerAssociationPaging createUnfiledContainerChildren(unfiledContainerIdnodeBodyCreateopts)
|
||||
|
||||
Create a record or an unfiled record folder
|
||||
|
||||
Creates a record or an unfiled record folder as a primary child of **unfiledContainerId**.
|
||||
|
||||
You can set the **autoRename** boolean field to automatically resolve name clashes. If there is a name clash, then
|
||||
the API method tries to create a unique name using an integer suffix.
|
||||
|
||||
This endpoint supports both JSON and multipart/form-data (file upload).
|
||||
|
||||
**Using multipart/form-data**
|
||||
|
||||
Use the **filedata** field to represent the content to upload, for example, the following curl command will
|
||||
create a node with the contents of test.txt in the test user's home folder.
|
||||
|
||||
curl -utest:test -X POST host:port/alfresco/api/-default-/public/gs/versions/1/unfiled-containers/{unfiledContainerId}/children -F filedata=@test.txt
|
||||
|
||||
This API method also supports record and unfiled record folder creation using application/json.
|
||||
|
||||
You must specify at least a **name** and **nodeType**.
|
||||
|
||||
You can create a non-electronic record like this:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Non-electronic Record\",
|
||||
\"nodeType\":\"rma:nonElectronicDocument\",
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:description\":\"My Non-electronic Record Description\",
|
||||
\"cm:title\":\"My Non-electronic Record Title\",
|
||||
\"rma:box\":\"My Non-electronic Record Box\",
|
||||
\"rma:file\":\"My Non-electronic Record File\",
|
||||
\"rma:numberOfCopies\":1,
|
||||
\"rma:physicalSize\":30,
|
||||
\"rma:shelf\":\"My Non-electronic Record Shelf\",
|
||||
\"rma:storageLocation\":\"My Non-electronic Record Location\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
You can create an empty electronic record:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Electronic Record\",
|
||||
\"nodeType\":\"cm:content\"
|
||||
}
|
||||
|
||||
|
||||
You can create an unfiled record folder like this:
|
||||
JSON
|
||||
{
|
||||
\"name\": \"My Unfiled Record Folder\",
|
||||
\"nodeType\": \"rma:unfiledRecordFolder\",
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:title\": \"My Unfiled Record Folder Title\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Any missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.
|
||||
|
||||
**Note:** You can create more than one child by
|
||||
specifying a list of nodes in the JSON body. For example, the following JSON
|
||||
body creates a record and an unfiled record folder inside the specified **unfiledContainerId**:
|
||||
JSON
|
||||
[
|
||||
{
|
||||
\"name\":\"My Record\",
|
||||
\"nodeType\":\"cm:content\"
|
||||
},
|
||||
{
|
||||
\"name\":\"My Unfiled Record Folder\",
|
||||
\"nodeType\":\"rma:unfiledRecordFolder\"
|
||||
}
|
||||
]
|
||||
|
||||
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 UnfiledContainersApi from 'UnfiledContainersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledcontainersApi = new UnfiledContainersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'autoRename': true // | If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
|
||||
'include': // | Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
unfiledcontainersApi.createUnfiledContainerChildren(unfiledContainerIdnodeBodyCreateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledContainerId** | **string**| The identifier of an unfiled records container. You can use the **-unfiled-** alias. |
|
||||
**nodeBodyCreate** | [**RMNodeBodyCreate**](RMNodeBodyCreate.md)| The node information to create. |
|
||||
**autoRename** | **boolean**| If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
| [optional]
|
||||
**include** | [**string**](string.md)| Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**UnfiledContainerAssociationPaging**](UnfiledContainerAssociationPaging.md)
|
||||
|
||||
<a name="getUnfiledContainer"></a>
|
||||
# **getUnfiledContainer**
|
||||
> UnfiledContainerEntry getUnfiledContainer(unfiledContainerIdopts)
|
||||
|
||||
Get the unfiled records container
|
||||
|
||||
Gets information for unfiled records container **unfiledContainerId**
|
||||
|
||||
Mandatory fields and the unfiled records container's aspects and properties are returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import UnfiledContainersApi from 'UnfiledContainersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledcontainersApi = new UnfiledContainersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
unfiledcontainersApi.getUnfiledContainer(unfiledContainerIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledContainerId** | **string**| The identifier of an unfiled records container. You can use the **-unfiled-** alias. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**UnfiledContainerEntry**](UnfiledContainerEntry.md)
|
||||
|
||||
<a name="listUnfiledContainerChildren"></a>
|
||||
# **listUnfiledContainerChildren**
|
||||
> UnfiledContainerAssociationPaging listUnfiledContainerChildren(unfiledContainerIdopts)
|
||||
|
||||
List unfiled record container's children
|
||||
|
||||
Returns a list of records or unfiled record folders.
|
||||
|
||||
Minimal information for each child is returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import UnfiledContainersApi from 'UnfiledContainersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledcontainersApi = new UnfiledContainersApi(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.
|
||||
'where': where_example // | Optionally filter the list. Here are some examples:
|
||||
|
||||
* where=(isRecord=true)
|
||||
|
||||
* where=(isUnfiledRecordFolder=false)
|
||||
|
||||
* where=(nodeType='cm:content INCLUDESUBTYPES')
|
||||
|
||||
'include': // | Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* association
|
||||
* path
|
||||
* properties
|
||||
|
||||
'includeSource': true // | Also include **source** (in addition to **entries**) with folder information on the parent node – the specified parent **unfiledContainerId**
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
unfiledcontainersApi.listUnfiledContainerChildren(unfiledContainerIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledContainerId** | **string**| The identifier of an unfiled records container. You can use the **-unfiled-** alias. |
|
||||
**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]
|
||||
**where** | **string**| Optionally filter the list. Here are some examples:
|
||||
|
||||
* where=(isRecord=true)
|
||||
|
||||
* where=(isUnfiledRecordFolder=false)
|
||||
|
||||
* where=(nodeType='cm:content INCLUDESUBTYPES')
|
||||
| [optional]
|
||||
**include** | [**string**](string.md)| Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* association
|
||||
* path
|
||||
* properties
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** (in addition to **entries**) with folder information on the parent node – the specified parent **unfiledContainerId** | [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
|
||||
|
||||
[**UnfiledContainerAssociationPaging**](UnfiledContainerAssociationPaging.md)
|
||||
|
||||
<a name="updateUnfiledContainer"></a>
|
||||
# **updateUnfiledContainer**
|
||||
> UnfiledContainerEntry updateUnfiledContainer(unfiledContainerIdunfiledContainerBodyUpdateopts)
|
||||
|
||||
Update an unfiled record container
|
||||
|
||||
Updates unfiled record container **unfiledContainerId**. For example, you can rename an unfiled record container:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My new name\"
|
||||
}
|
||||
|
||||
You can also set or update description and title properties:
|
||||
JSON
|
||||
{
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:description\": \"New Description\",
|
||||
\"cm:title\":\"New Title\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
**Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import UnfiledContainersApi from 'UnfiledContainersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledcontainersApi = new UnfiledContainersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
unfiledcontainersApi.updateUnfiledContainer(unfiledContainerIdunfiledContainerBodyUpdateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledContainerId** | **string**| The identifier of an unfiled records container. You can use the **-unfiled-** alias. |
|
||||
**unfiledContainerBodyUpdate** | [**UnfiledRecordContainerBodyUpdate**](UnfiledRecordContainerBodyUpdate.md)| The unfiled record container information to update. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**UnfiledContainerEntry**](UnfiledContainerEntry.md)
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# UnfiledRecordContainerBodyUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [optional] [default to null]
|
||||
**properties** | **{ [key: string]: string; }** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# UnfiledRecordFolder
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isUnfiledRecordFolder** | **boolean** | | [default to null]
|
||||
**isRecord** | **boolean** | | [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# UnfiledRecordFolderAssociationPaging
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**list** | [**UnfiledRecordFolderAssociationPagingList**](UnfiledRecordFolderAssociationPagingList.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# UnfiledRecordFolderAssociationPagingList
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pagination** | [**Pagination**](Pagination.md) | | [optional] [default to null]
|
||||
**entries** | [**UnfiledRecordFolderChildAssociationEntry[]**](UnfiledRecordFolderChildAssociationEntry.md) | | [optional] [default to null]
|
||||
**source** | [**UnfiledRecordFolder**](UnfiledRecordFolder.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# UnfiledRecordFolderBodyUpdate
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [optional] [default to null]
|
||||
**properties** | **{ [key: string]: string; }** | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# UnfiledRecordFolderChild
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isUnfiledRecordFolder** | **boolean** | | [default to null]
|
||||
**isRecord** | **boolean** | | [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,24 @@
|
||||
# UnfiledRecordFolderChildAssociation
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **string** | | [default to null]
|
||||
**parentId** | **string** | | [default to null]
|
||||
**name** | **string** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
The character . must not be used at the end of the name.
|
||||
| [default to null]
|
||||
**nodeType** | **string** | | [default to null]
|
||||
**isUnfiledRecordFolder** | **boolean** | | [default to null]
|
||||
**isRecord** | **boolean** | | [default to null]
|
||||
**modifiedAt** | [**Date**](Date.md) | | [default to null]
|
||||
**modifiedByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**createdAt** | [**Date**](Date.md) | | [default to null]
|
||||
**createdByUser** | [**UserInfo**](UserInfo.md) | | [default to null]
|
||||
**aspectNames** | **string[]** | | [optional] [default to null]
|
||||
**properties** | **any** | | [optional] [default to null]
|
||||
**allowableOperations** | **string[]** | | [optional] [default to null]
|
||||
**path** | [**PathInfo**](PathInfo.md) | | [optional] [default to null]
|
||||
**association** | [**ChildAssociationInfo**](ChildAssociationInfo.md) | | [optional] [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# UnfiledRecordFolderChildAssociationEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**UnfiledRecordFolderChildAssociation**](UnfiledRecordFolderChildAssociation.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# UnfiledRecordFolderEntry
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**entry** | [**UnfiledRecordFolder**](UnfiledRecordFolder.md) | | [default to null]
|
||||
|
||||
|
||||
@@ -0,0 +1,519 @@
|
||||
# UnfiledRecordFoldersApi
|
||||
|
||||
All URIs are relative to *https://localhost/alfresco/api/-default-/public/gs/versions/1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createUnfiledRecordFolderChildren**](UnfiledRecordFoldersApi.md#createUnfiledRecordFolderChildren) | **POST** /unfiled-record-folders/{unfiledRecordFolderId}/children | Create a record or an unfiled record folder
|
||||
[**deleteUnfiledRecordFolder**](UnfiledRecordFoldersApi.md#deleteUnfiledRecordFolder) | **DELETE** /unfiled-record-folders/{unfiledRecordFolderId} | Delete an unfiled record folder. Deleted file plan components cannot be recovered, they are deleted permanently.
|
||||
[**getUnfiledRecordFolder**](UnfiledRecordFoldersApi.md#getUnfiledRecordFolder) | **GET** /unfiled-record-folders/{unfiledRecordFolderId} | Get the unfiled record folder
|
||||
[**listUnfiledRecordFolderChildren**](UnfiledRecordFoldersApi.md#listUnfiledRecordFolderChildren) | **GET** /unfiled-record-folders/{unfiledRecordFolderId}/children | List unfiled record folder's children
|
||||
[**updateUnfiledRecordFolder**](UnfiledRecordFoldersApi.md#updateUnfiledRecordFolder) | **PUT** /unfiled-record-folders/{unfiledRecordFolderId} | Update an unfiled record folder
|
||||
|
||||
|
||||
<a name="createUnfiledRecordFolderChildren"></a>
|
||||
# **createUnfiledRecordFolderChildren**
|
||||
> UnfiledRecordFolderAssociationPaging createUnfiledRecordFolderChildren(unfiledRecordFolderIdnodeBodyCreateopts)
|
||||
|
||||
Create a record or an unfiled record folder
|
||||
|
||||
Create a record or an unfiled record folder as a primary child of **unfiledRecordFolderId**.
|
||||
|
||||
You can set the **autoRename** boolean field to automatically resolve name clashes. If there is a name clash, then
|
||||
the API method tries to create a unique name using an integer suffix.
|
||||
|
||||
This endpoint supports both JSON and multipart/form-data (file upload).
|
||||
|
||||
**Using multipart/form-data**
|
||||
|
||||
Use the **filedata** field to represent the content to upload, for example, the following curl command will
|
||||
create a node with the contents of test.txt in the test user's home folder.
|
||||
|
||||
curl -utest:test -X POST host:port/alfresco/api/-default-/public/gs/versions/1/unfiled-record-folders/{unfiledRecordFolderId}/children -F filedata=@test.txt
|
||||
|
||||
This API method also supports record and unfiled record folder creation using application/json.
|
||||
|
||||
You must specify at least a **name** and **nodeType**.
|
||||
|
||||
You can create a non-electronic record like this:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Non-electronic Record\",
|
||||
\"nodeType\":\"rma:nonElectronicDocument\",
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:description\":\"My Non-electronic Record Description\",
|
||||
\"cm:title\":\"My Non-electronic Record Title\",
|
||||
\"rma:box\":\"My Non-electronic Record Box\",
|
||||
\"rma:file\":\"My Non-electronic Record File\",
|
||||
\"rma:numberOfCopies\":1,
|
||||
\"rma:physicalSize\":30,
|
||||
\"rma:shelf\":\"My Non-electronic Record Shelf\",
|
||||
\"rma:storageLocation\":\"My Non-electronic Record Location\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
You can create an empty electronic record like this:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My Electronic Record\",
|
||||
\"nodeType\":\"cm:content\"
|
||||
}
|
||||
|
||||
|
||||
You can create an unfiled record folder like this:
|
||||
JSON
|
||||
{
|
||||
\"name\": \"My Unfiled Record Folder\",
|
||||
\"nodeType\": \"rma:unfiledRecordFolder\",
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:title\": \"My Unfiled Record Folder Title\"
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Any missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.
|
||||
|
||||
**Note:** You can create more than one child by
|
||||
specifying a list of nodes in the JSON body. For example, the following JSON
|
||||
body creates a record and an unfiled record folder inside the specified **unfiledRecordFolderId**:
|
||||
JSON
|
||||
[
|
||||
{
|
||||
\"name\":\"My Record\",
|
||||
\"nodeType\":\"cm:content\"
|
||||
},
|
||||
{
|
||||
\"name\":\"My Unfiled Record Folder\",
|
||||
\"nodeType\":\"rma:unfiledRecordFolder\"
|
||||
}
|
||||
]
|
||||
|
||||
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 UnfiledRecordFoldersApi from 'UnfiledRecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledrecordfoldersApi = new UnfiledRecordFoldersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'autoRename': true // | If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
|
||||
'include': // | Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
unfiledrecordfoldersApi.createUnfiledRecordFolderChildren(unfiledRecordFolderIdnodeBodyCreateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledRecordFolderId** | **string**| The identifier of an unfiled record folder. |
|
||||
**nodeBodyCreate** | [**RMNodeBodyCreateWithRelativePath**](RMNodeBodyCreateWithRelativePath.md)| The node information to create. |
|
||||
**autoRename** | **boolean**| If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
|
||||
| [optional]
|
||||
**include** | [**string**](string.md)| Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [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
|
||||
|
||||
[**UnfiledRecordFolderAssociationPaging**](UnfiledRecordFolderAssociationPaging.md)
|
||||
|
||||
<a name="deleteUnfiledRecordFolder"></a>
|
||||
# **deleteUnfiledRecordFolder**
|
||||
> deleteUnfiledRecordFolder(unfiledRecordFolderId)
|
||||
|
||||
Delete an unfiled record folder. Deleted file plan components cannot be recovered, they are deleted permanently.
|
||||
|
||||
Deletes the unfiled record folder **unfiledRecordFolderId**.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import UnfiledRecordFoldersApi from 'UnfiledRecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledrecordfoldersApi = new UnfiledRecordFoldersApi(this.alfrescoApi);
|
||||
|
||||
|
||||
unfiledrecordfoldersApi.deleteUnfiledRecordFolder(unfiledRecordFolderId).then(() => {
|
||||
console.log('API called successfully.');
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledRecordFolderId** | **string**| The identifier of an unfiled record folder. |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
<a name="getUnfiledRecordFolder"></a>
|
||||
# **getUnfiledRecordFolder**
|
||||
> UnfiledRecordFolderEntry getUnfiledRecordFolder(unfiledRecordFolderIdopts)
|
||||
|
||||
Get the unfiled record folder
|
||||
|
||||
Gets information for unfiled record folder id **unfiledRecordFolderId**
|
||||
|
||||
Mandatory fields and the unfiled record folder's aspects and properties are returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import UnfiledRecordFoldersApi from 'UnfiledRecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledrecordfoldersApi = new UnfiledRecordFoldersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'relativePath': relativePath_example // | Return information on children in the unfiled records container resolved by this path. The path is relative to **unfiledRecordFolderId**.
|
||||
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
unfiledrecordfoldersApi.getUnfiledRecordFolder(unfiledRecordFolderIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledRecordFolderId** | **string**| The identifier of an unfiled record folder. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [optional]
|
||||
**relativePath** | **string**| Return information on children in the unfiled records container resolved by this path. The path is relative to **unfiledRecordFolderId**.
|
||||
| [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
|
||||
|
||||
[**UnfiledRecordFolderEntry**](UnfiledRecordFolderEntry.md)
|
||||
|
||||
<a name="listUnfiledRecordFolderChildren"></a>
|
||||
# **listUnfiledRecordFolderChildren**
|
||||
> UnfiledRecordFolderAssociationPaging listUnfiledRecordFolderChildren(unfiledRecordFolderIdopts)
|
||||
|
||||
List unfiled record folder's children
|
||||
|
||||
Returns a list of records or unfiled record folders.
|
||||
|
||||
Minimal information for each child is returned by default.
|
||||
|
||||
You can use the **include** parameter (include=allowableOperations) to return additional information.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import UnfiledRecordFoldersApi from 'UnfiledRecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledrecordfoldersApi = new UnfiledRecordFoldersApi(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.
|
||||
'where': where_example // | Optionally filter the list. Here are some examples:
|
||||
|
||||
* where=(isRecord=true)
|
||||
|
||||
* where=(isUnfiledRecordFolder=false)
|
||||
|
||||
* where=(nodeType='cm:content INCLUDESUBTYPES')
|
||||
|
||||
'include': // | Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* association
|
||||
* path
|
||||
* properties
|
||||
|
||||
'relativePath': relativePath_example // | Return information on children in the unfiled records container resolved by this path. The path is relative to **unfiledRecordFolderId**.
|
||||
|
||||
'includeSource': true // | Also include **source** (in addition to **entries**) with folder information on the parent node – either the specified parent **unfiledRecordFolderId**, or as resolved by **relativePath**.
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
unfiledrecordfoldersApi.listUnfiledRecordFolderChildren(unfiledRecordFolderIdopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledRecordFolderId** | **string**| The identifier of an unfiled record folder. |
|
||||
**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]
|
||||
**where** | **string**| Optionally filter the list. Here are some examples:
|
||||
|
||||
* where=(isRecord=true)
|
||||
|
||||
* where=(isUnfiledRecordFolder=false)
|
||||
|
||||
* where=(nodeType='cm:content INCLUDESUBTYPES')
|
||||
| [optional]
|
||||
**include** | [**string**](string.md)| Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* aspectNames
|
||||
* association
|
||||
* path
|
||||
* properties
|
||||
| [optional]
|
||||
**relativePath** | **string**| Return information on children in the unfiled records container resolved by this path. The path is relative to **unfiledRecordFolderId**.
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** (in addition to **entries**) with folder information on the parent node – either the specified parent **unfiledRecordFolderId**, or as resolved by **relativePath**. | [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
|
||||
|
||||
[**UnfiledRecordFolderAssociationPaging**](UnfiledRecordFolderAssociationPaging.md)
|
||||
|
||||
<a name="updateUnfiledRecordFolder"></a>
|
||||
# **updateUnfiledRecordFolder**
|
||||
> UnfiledRecordFolderEntry updateUnfiledRecordFolder(unfiledRecordFolderIdunfiledRecordFolderBodyUpdateopts)
|
||||
|
||||
Update an unfiled record folder
|
||||
|
||||
Updates unfiled record folder **unfiledRecordFolderId**. For example, you can rename a record folder:
|
||||
JSON
|
||||
{
|
||||
\"name\":\"My new name\"
|
||||
}
|
||||
|
||||
You can also set or update one or more properties:
|
||||
JSON
|
||||
{
|
||||
\"properties\":
|
||||
{
|
||||
\"cm:title\":\"New title\",
|
||||
\"cm:description\":\"New description\"
|
||||
}
|
||||
}
|
||||
|
||||
**Note:** if you want to add or remove aspects, then you must use **GET /unfiled-record-folders/{unfiledRecordFolderId}** first to get the complete set of *aspectNames*.
|
||||
|
||||
**Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order.
|
||||
|
||||
|
||||
### Example
|
||||
```javascript
|
||||
import UnfiledRecordFoldersApi from 'UnfiledRecordFoldersApi';
|
||||
import { AlfrescoApi } from '@alfresco/js-api';
|
||||
|
||||
this.alfrescoApi = new AlfrescoApi();
|
||||
this.alfrescoApi.setConfig({
|
||||
hostEcm: 'http://127.0.0.1:8080'
|
||||
});
|
||||
|
||||
let unfiledrecordfoldersApi = new UnfiledRecordFoldersApi(this.alfrescoApi);
|
||||
|
||||
let opts = {
|
||||
'include': // | Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
|
||||
'includeSource': true // | Also include **source** (in addition to **entries**) with folder information on the parent node – either the specified parent **unfiledRecordFolderId**, or as resolved by **relativePath**.
|
||||
'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.
|
||||
|
||||
};
|
||||
|
||||
unfiledrecordfoldersApi.updateUnfiledRecordFolder(unfiledRecordFolderIdunfiledRecordFolderBodyUpdateopts).then((data) => {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}, function(error) {
|
||||
console.error(error);
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**unfiledRecordFolderId** | **string**| The identifier of an unfiled record folder. |
|
||||
**unfiledRecordFolderBodyUpdate** | [**UnfiledRecordFolderBodyUpdate**](UnfiledRecordFolderBodyUpdate.md)| The record folder information to update. |
|
||||
**include** | [**string**](string.md)| Returns additional information about the unfiled records container's children. Any optional field from the response model can be requested. For example:
|
||||
* allowableOperations
|
||||
* path
|
||||
| [optional]
|
||||
**includeSource** | **boolean**| Also include **source** (in addition to **entries**) with folder information on the parent node – either the specified parent **unfiledRecordFolderId**, or as resolved by **relativePath**. | [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
|
||||
|
||||
[**UnfiledRecordFolderEntry**](UnfiledRecordFolderEntry.md)
|
||||
|
||||
9
lib/js-api/src/api/gs-core-rest-api/docs/UserInfo.md
Normal file
9
lib/js-api/src/api/gs-core-rest-api/docs/UserInfo.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# UserInfo
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**displayName** | **string** | | [default to null]
|
||||
**id** | **string** | | [default to null]
|
||||
|
||||
|
||||
19
lib/js-api/src/api/gs-core-rest-api/index.ts
Normal file
19
lib/js-api/src/api/gs-core-rest-api/index.ts
Normal 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';
|
||||
49
lib/js-api/src/api/gs-core-rest-api/model/filePlan.ts
Normal file
49
lib/js-api/src/api/gs-core-rest-api/model/filePlan.ts
Normal file
@@ -0,0 +1,49 @@
|
||||
/*!
|
||||
* @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 { DateAlfresco } from '../../content-custom-api';
|
||||
import { PathInfo, UserInfo } from '../../content-rest-api';
|
||||
|
||||
export class FilePlan {
|
||||
id: string;
|
||||
parentId: string;
|
||||
/**
|
||||
* The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
* The character . must not be used at the end of the name.
|
||||
*/
|
||||
name: string;
|
||||
nodeType: string;
|
||||
modifiedAt: Date;
|
||||
modifiedByUser: UserInfo;
|
||||
createdAt: Date;
|
||||
createdByUser: UserInfo;
|
||||
aspectNames?: string[];
|
||||
properties?: any;
|
||||
allowableOperations?: string[];
|
||||
path?: PathInfo;
|
||||
|
||||
constructor(input?: Partial<FilePlan>) {
|
||||
if (input) {
|
||||
Object.assign(this, input);
|
||||
this.modifiedAt = input.modifiedAt ? DateAlfresco.parseDate(input.modifiedAt) : undefined;
|
||||
this.modifiedByUser = input.modifiedByUser ? new UserInfo(input.modifiedByUser) : undefined;
|
||||
this.createdAt = input.createdAt ? DateAlfresco.parseDate(input.createdAt) : undefined;
|
||||
this.createdByUser = input.createdByUser ? new UserInfo(input.createdByUser) : undefined;
|
||||
this.path = input.path ? new PathInfo(input.path) : undefined;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
/*!
|
||||
* @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 FilePlanBodyUpdate {
|
||||
properties?: { [key: string]: string };
|
||||
}
|
||||
@@ -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.
|
||||
*/
|
||||
|
||||
export interface FilePlanComponentBodyUpdate {
|
||||
/**
|
||||
* The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
* The character . must not be used at the end of the name.
|
||||
*/
|
||||
name?: string;
|
||||
aspectNames?: string[];
|
||||
properties?: { [key: string]: string };
|
||||
}
|
||||
29
lib/js-api/src/api/gs-core-rest-api/model/filePlanEntry.ts
Normal file
29
lib/js-api/src/api/gs-core-rest-api/model/filePlanEntry.ts
Normal file
@@ -0,0 +1,29 @@
|
||||
/*!
|
||||
* @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 { FilePlan } from './filePlan';
|
||||
|
||||
export class FilePlanEntry {
|
||||
entry: FilePlan;
|
||||
|
||||
constructor(input?: Partial<FilePlanEntry>) {
|
||||
if (input) {
|
||||
Object.assign(this, input);
|
||||
this.entry = input.entry ? new FilePlan(input.entry) : undefined;
|
||||
}
|
||||
}
|
||||
}
|
||||
76
lib/js-api/src/api/gs-core-rest-api/model/index.ts
Normal file
76
lib/js-api/src/api/gs-core-rest-api/model/index.ts
Normal file
@@ -0,0 +1,76 @@
|
||||
/*!
|
||||
* @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 './filePlan';
|
||||
export * from './filePlanBodyUpdate';
|
||||
export * from './filePlanComponentBodyUpdate';
|
||||
export * from './filePlanEntry';
|
||||
export * from './rMNodeBodyCreate';
|
||||
export * from './rMNodeBodyCreateWithRelativePath';
|
||||
export * from './rMSite';
|
||||
export * from './rMSiteBodyCreate';
|
||||
export * from './rMSiteBodyUpdate';
|
||||
export * from './rMSiteEntry';
|
||||
export * from './record';
|
||||
export * from './recordCategory';
|
||||
export * from './recordCategoryChild';
|
||||
export * from './recordCategoryChildEntry';
|
||||
export * from './recordCategoryChildPaging';
|
||||
export * from './recordCategoryChildPagingList';
|
||||
export * from './recordCategoryEntry';
|
||||
export * from './recordCategoryPaging';
|
||||
export * from './recordCategoryPagingList';
|
||||
export * from './recordEntry';
|
||||
export * from './recordFolder';
|
||||
export * from './recordFolderAssociationPaging';
|
||||
export * from './recordFolderAssociationPagingList';
|
||||
export * from './recordFolderChildAssociationEntry';
|
||||
export * from './recordFolderEntry';
|
||||
export * from './requestBodyFile';
|
||||
export * from './rootCategoryBodyCreate';
|
||||
export * from './transfer';
|
||||
export * from './transferAssociationPaging';
|
||||
export * from './transferAssociationPagingList';
|
||||
export * from './transferChild';
|
||||
export * from './transferChildAssociationEntry';
|
||||
export * from './transferContainer';
|
||||
export * from './transferContainerAssociationPaging';
|
||||
export * from './transferContainerAssociationPagingList';
|
||||
export * from './transferContainerBodyUpdate';
|
||||
export * from './transferContainerChild';
|
||||
export * from './transferContainerChildAssociationEntry';
|
||||
export * from './transferContainerEntry';
|
||||
export * from './transferEntry';
|
||||
export * from './unfiledContainer';
|
||||
export * from './unfiledContainerAssociationPaging';
|
||||
export * from './unfiledContainerAssociationPagingList';
|
||||
export * from './unfiledContainerChild';
|
||||
export * from './unfiledContainerChildAssociationEntry';
|
||||
export * from './unfiledContainerEntry';
|
||||
export * from './unfiledRecordContainerBodyUpdate';
|
||||
export * from './unfiledRecordFolder';
|
||||
export * from './unfiledRecordFolderAssociationPaging';
|
||||
export * from './unfiledRecordFolderAssociationPagingList';
|
||||
export * from './unfiledRecordFolderBodyUpdate';
|
||||
export * from './unfiledRecordFolderChild';
|
||||
export * from './unfiledRecordFolderChildAssociationEntry';
|
||||
export * from './unfiledRecordFolderEntry';
|
||||
export * from './recordFolderChildAssociation';
|
||||
export * from './transferChildAssociation';
|
||||
export * from './transferContainerChildAssociation';
|
||||
export * from './unfiledContainerChildAssociation';
|
||||
export * from './unfiledRecordFolderChildAssociation';
|
||||
@@ -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 interface RMNodeBodyCreate {
|
||||
/**
|
||||
* The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
* The character . must not be used at the end of the name.
|
||||
*/
|
||||
name: string;
|
||||
nodeType: string;
|
||||
aspectNames?: string[];
|
||||
properties?: { [key: string]: string };
|
||||
}
|
||||
@@ -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 RMNodeBodyCreateWithRelativePath {
|
||||
/**
|
||||
* The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |.
|
||||
* The character . must not be used at the end of the name.
|
||||
*/
|
||||
name: string;
|
||||
nodeType: string;
|
||||
aspectNames?: string[];
|
||||
properties?: { [key: string]: string };
|
||||
relativePath?: string;
|
||||
}
|
||||
26
lib/js-api/src/api/gs-core-rest-api/model/rMSite.ts
Normal file
26
lib/js-api/src/api/gs-core-rest-api/model/rMSite.ts
Normal 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.
|
||||
*/
|
||||
|
||||
export interface RMSite {
|
||||
id: string;
|
||||
guid: string;
|
||||
title: string;
|
||||
description?: string;
|
||||
visibility: 'PRIVATE' | 'MODERATED' | 'PUBLIC' | string;
|
||||
compliance: 'STANDARD' | 'DOD5015' | string;
|
||||
role?: 'SiteConsumer' | 'SiteCollaborator' | 'SiteContributor' | 'SiteManager' | string;
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user