TransfersApi.md

TransfersApi

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

Method	HTTP request	Description
getTransfer	GET /transfers/{transferId}	Get a transfer
listTransfersChildren	GET /transfers/{transferId}/children	List transfer's children

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

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

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

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