Skip to content
This repository was archived by the owner on Jun 11, 2025. It is now read-only.

RecordsApi.md

Latest commit

 

History

History
465 lines (330 loc) · 13.6 KB

RecordsApi.md

File metadata and controls

465 lines (330 loc) · 13.6 KB

RecordsApi

All URIs are relative to https://localhost/alfresco/api/-default-/public/gs/versions/1

Method HTTP request Description
completeRecord POST /records/{recordId}/complete Complete a record
deleteRecord DELETE /records/{recordId} Delete a record
fileRecord POST /records/{recordId}/file File a record
getRecord GET /records/{recordId} Get a record
getRecordContent GET /records/{recordId}/content Get record content
updateRecord PUT /records/{recordId} Update record

completeRecord

RecordEntry completeRecord(recordIdopts)

Complete a record

Completes the record recordId.

Example

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

deleteRecord

deleteRecord(recordId)

Delete a record

Deletes the record recordId. Deleted file plan components cannot be recovered, they are deleted permanently.

Example

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)

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

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 The target record folder id
include string 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| 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

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

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

getRecordContent

getRecordContent(recordIdopts)

Get record content

Gets the content of the record with identifier recordId.

Example

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)

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

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 The record information to update.
include string 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| 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