Merge branch 'feature/RM-5087_UpdateNotesForGETEndpoints' into 'master'

RM-5087 - Updated yaml file for include parameter

See merge request !254
This commit is contained in:
Ramona Popa
2017-05-19 08:38:39 +01:00
4 changed files with 219 additions and 117 deletions

View File

@@ -40,6 +40,7 @@ import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionSchedul
import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionService; import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionService;
import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel; import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
import org.alfresco.rest.api.Nodes; import org.alfresco.rest.api.Nodes;
import org.alfresco.rest.api.model.AssocChild;
import org.alfresco.rest.api.model.ContentInfo; import org.alfresco.rest.api.model.ContentInfo;
import org.alfresco.rest.api.model.Node; import org.alfresco.rest.api.model.Node;
import org.alfresco.rest.api.model.UserInfo; import org.alfresco.rest.api.model.UserInfo;
@@ -61,7 +62,9 @@ import org.alfresco.rm.rest.api.model.UnfiledRecordFolder;
import org.alfresco.rm.rest.api.model.UnfiledRecordFolderChild; import org.alfresco.rm.rest.api.model.UnfiledRecordFolderChild;
import org.alfresco.service.ServiceRegistry; import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.model.FileInfo; import org.alfresco.service.cmr.model.FileInfo;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.ContentData; import org.alfresco.service.cmr.repository.ContentData;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService; import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.security.PersonService; import org.alfresco.service.cmr.security.PersonService;
import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.NamespaceService;
@@ -466,10 +469,6 @@ public class ApiNodesModelFactory
{ {
transferChild.setIsClosed((Boolean) nodeService.getProperty(info.getNodeRef(), RecordsManagementModel.PROP_IS_CLOSED)); transferChild.setIsClosed((Boolean) nodeService.getProperty(info.getNodeRef(), RecordsManagementModel.PROP_IS_CLOSED));
} }
if(isMinimalInfo && includeParam.contains(TransferChild.PARAM_IS_COMPLETED))
{
transferChild.setIsCompleted(null);
}
} }
else else
{ {
@@ -485,10 +484,6 @@ public class ApiNodesModelFactory
{ {
transferChild.setIsClosed(null); transferChild.setIsClosed(null);
} }
if(isMinimalInfo && includeParam.contains(TransferChild.PARAM_IS_COMPLETED))
{
transferChild.setIsCompleted(nodeService.hasAspect(info.getNodeRef(), RecordsManagementModel.ASPECT_DECLARED_RECORD));
}
} }
} }
@@ -520,7 +515,7 @@ public class ApiNodesModelFactory
{ {
recordCategoryChild.setIsClosed((Boolean) nodeService.getProperty(info.getNodeRef(), RecordsManagementModel.PROP_IS_CLOSED)); recordCategoryChild.setIsClosed((Boolean) nodeService.getProperty(info.getNodeRef(), RecordsManagementModel.PROP_IS_CLOSED));
} }
if((!isMinimalInfo && propertyFilter.isAllowed(RMNode.PARAM_HAS_RETENTION_SCHEDULE)) || (isMinimalInfo && includeParam.contains(RMNode.PARAM_HAS_RETENTION_SCHEDULE))) if (includeParam.contains(RMNode.PARAM_HAS_RETENTION_SCHEDULE))
{ {
recordCategoryChild.setHasRetentionSchedule(null); recordCategoryChild.setHasRetentionSchedule(null);
} }
@@ -535,7 +530,7 @@ public class ApiNodesModelFactory
{ {
recordCategoryChild.setIsRecordCategory(true); recordCategoryChild.setIsRecordCategory(true);
} }
if((!isMinimalInfo && propertyFilter.isAllowed(RMNode.PARAM_HAS_RETENTION_SCHEDULE)) || (isMinimalInfo && includeParam.contains(RMNode.PARAM_HAS_RETENTION_SCHEDULE))) if (includeParam.contains(RMNode.PARAM_HAS_RETENTION_SCHEDULE))
{ {
DispositionSchedule ds = dispositionService.getDispositionSchedule(info.getNodeRef()); DispositionSchedule ds = dispositionService.getDispositionSchedule(info.getNodeRef());
recordCategoryChild.setHasRetentionSchedule(ds !=null ? true : false); recordCategoryChild.setHasRetentionSchedule(ds !=null ? true : false);
@@ -600,6 +595,48 @@ public class ApiNodesModelFactory
return nodes.mapFromNodeProperties(properties, new ArrayList<>(), new HashMap<>(), EXCLUDED_NS, EXCLUDED_PROPS); return nodes.mapFromNodeProperties(properties, new ArrayList<>(), new HashMap<>(), EXCLUDED_NS, EXCLUDED_PROPS);
} }
/**
* Utility method that maps associations, applicable only for records
*
* @param rmNode
* @param info
* @param includeParam
*/
private void mapAssociations(RMNode rmNode, FileInfo info, List<String> includeParam)
{
if (includeParam.contains(RMNode.PARAM_INCLUDE_ASSOCIATION))
{
NodeRef nodeRef = info.getNodeRef();
ChildAssociationRef parentAssocRef = nodeService.getPrimaryParent(nodeRef);
if ((parentAssocRef == null) || (parentAssocRef.getParentRef() == null)
|| (!parentAssocRef.getParentRef().equals(rmNode.getParentId())))
{
List<ChildAssociationRef> parentAssocRefs = nodeService.getParentAssocs(nodeRef);
for (ChildAssociationRef pAssocRef : parentAssocRefs)
{
if (pAssocRef.getParentRef().equals(rmNode.getParentId()))
{
// for now, assume same parent/child cannot appear more than once (due to unique name)
parentAssocRef = pAssocRef;
break;
}
}
}
if (parentAssocRef != null)
{
QName assocTypeQName = parentAssocRef.getTypeQName();
if ((assocTypeQName != null) && (!EXCLUDED_NS.contains(assocTypeQName.getNamespaceURI())))
{
AssocChild childAssoc = new AssocChild(assocTypeQName.toPrefixString(namespaceService), parentAssocRef.isPrimary());
rmNode.setAssociation(childAssoc);
}
}
}
}
/** /**
* Creates an object of type FilePlan * Creates an object of type FilePlan
* *
@@ -760,6 +797,10 @@ public class ApiNodesModelFactory
mapBasicInfo(unfiledContainerChild, info, parameters.getFilter(), mapUserInfo, isMinimalInfo); mapBasicInfo(unfiledContainerChild, info, parameters.getFilter(), mapUserInfo, isMinimalInfo);
mapOptionalInfo(unfiledContainerChild, info, parameters.getInclude(), isMinimalInfo); mapOptionalInfo(unfiledContainerChild, info, parameters.getInclude(), isMinimalInfo);
mapUnfiledChildInfo(unfiledContainerChild, info, parameters.getFilter()); mapUnfiledChildInfo(unfiledContainerChild, info, parameters.getFilter());
if (unfiledContainerChild.getIsRecord())
{
mapAssociations(unfiledContainerChild, info, parameters.getInclude());
}
return unfiledContainerChild; return unfiledContainerChild;
} }
@@ -797,6 +838,10 @@ public class ApiNodesModelFactory
mapBasicInfo(unfiledRecordFolderChild, info, parameters.getFilter(), mapUserInfo, isMinimalInfo); mapBasicInfo(unfiledRecordFolderChild, info, parameters.getFilter(), mapUserInfo, isMinimalInfo);
mapOptionalInfo(unfiledRecordFolderChild, info, parameters.getInclude(), isMinimalInfo); mapOptionalInfo(unfiledRecordFolderChild, info, parameters.getInclude(), isMinimalInfo);
mapUnfiledChildInfo(unfiledRecordFolderChild, info, parameters.getFilter()); mapUnfiledChildInfo(unfiledRecordFolderChild, info, parameters.getFilter());
if (unfiledRecordFolderChild.getIsRecord())
{
mapAssociations(unfiledRecordFolderChild, info, parameters.getInclude());
}
return unfiledRecordFolderChild; return unfiledRecordFolderChild;
} }
@@ -834,6 +879,7 @@ public class ApiNodesModelFactory
mapBasicInfo(record, info, parameters.getFilter(), mapUserInfo, isMinimalInfo); mapBasicInfo(record, info, parameters.getFilter(), mapUserInfo, isMinimalInfo);
mapOptionalInfo(record, info, parameters.getInclude(), isMinimalInfo); mapOptionalInfo(record, info, parameters.getInclude(), isMinimalInfo);
mapRecordInfo(record, info, parameters.getInclude()); mapRecordInfo(record, info, parameters.getInclude());
mapAssociations(record, info, parameters.getInclude());
return record; return record;
} }
} }

View File

@@ -31,6 +31,7 @@ import java.util.Date;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.alfresco.rest.api.model.Assoc;
import org.alfresco.rest.api.model.PathInfo; import org.alfresco.rest.api.model.PathInfo;
import org.alfresco.rest.api.model.UserInfo; import org.alfresco.rest.api.model.UserInfo;
import org.alfresco.rest.framework.resource.UniqueId; import org.alfresco.rest.framework.resource.UniqueId;
@@ -65,6 +66,7 @@ public abstract class RMNode
public static final String PARAM_HAS_RETENTION_SCHEDULE = "hasRetentionSchedule"; public static final String PARAM_HAS_RETENTION_SCHEDULE = "hasRetentionSchedule";
public static final String PARAM_IS_CLOSED = "isClosed"; public static final String PARAM_IS_CLOSED = "isClosed";
public static final String PARAM_INCLUDE_ASSOCIATION = "association";
public static final String FILE_PLAN_TYPE = "rma:filePlan"; public static final String FILE_PLAN_TYPE = "rma:filePlan";
public static final String RECORD_CATEGORY_TYPE = "rma:recordCategory"; public static final String RECORD_CATEGORY_TYPE = "rma:recordCategory";
@@ -94,6 +96,7 @@ public abstract class RMNode
protected Map<String, Object> properties; protected Map<String, Object> properties;
protected PathInfo path; protected PathInfo path;
protected List<String> allowableOperations; protected List<String> allowableOperations;
protected Assoc association;
public RMNode() public RMNode()
{ {
@@ -221,4 +224,14 @@ public abstract class RMNode
this.allowableOperations = allowableOperations; this.allowableOperations = allowableOperations;
} }
public Assoc getAssociation()
{
return association;
}
public void setAssociation(Assoc association)
{
this.association = association;
}
} }

View File

@@ -39,7 +39,6 @@ public class TransferChild extends RMNode
public static final String PARAM_IS_RECORD_FOLDER = "isRecordFolder"; public static final String PARAM_IS_RECORD_FOLDER = "isRecordFolder";
public static final String PARAM_IS_RECORD = "isRecord"; public static final String PARAM_IS_RECORD = "isRecord";
protected Boolean isCompleted;
protected Boolean isClosed; protected Boolean isClosed;
protected Boolean isRecordFolder; protected Boolean isRecordFolder;
protected Boolean isRecord; protected Boolean isRecord;
@@ -48,16 +47,6 @@ public class TransferChild extends RMNode
{ {
} }
public Boolean getIsCompleted()
{
return isCompleted;
}
public void setIsCompleted(Boolean isCompleted)
{
this.isCompleted = isCompleted;
}
public Boolean getIsClosed() public Boolean getIsClosed()
{ {
return isClosed; return isClosed;

View File

@@ -208,6 +208,8 @@ paths:
Get information for file plan **filePlanId** Get information for file plan **filePlanId**
Besides mandatory fields the file plan's aspects and properties are returned by default. Besides mandatory fields the file plan's aspects and properties are returned by default.
You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: getFilePlan operationId: getFilePlan
parameters: parameters:
- $ref: '#/parameters/filePlanIdWithAliasParam' - $ref: '#/parameters/filePlanIdWithAliasParam'
@@ -296,10 +298,8 @@ paths:
Minimal information for each child is returned by default. Minimal information for each child is returned by default.
You can use the **include** parameter to return additional information. You can use the **include** parameter (include=allowableOperations) to return additional information.
You can use the **include** parameter (include=association) to return child association details
for each child, including the **assocType** and the **isPrimary** flag.
operationId: getFilePlanCategories operationId: getFilePlanCategories
produces: produces:
- application/json - application/json
@@ -307,14 +307,14 @@ paths:
- $ref: '#/parameters/filePlanIdWithAliasParam' - $ref: '#/parameters/filePlanIdWithAliasParam'
- $ref: '#/parameters/skipCountParam' - $ref: '#/parameters/skipCountParam'
- $ref: '#/parameters/maxItemsParam' - $ref: '#/parameters/maxItemsParam'
- $ref: '#/parameters/recordCategoryEntryIncludeParam' - $ref: '#/parameters/filePlanCategoriesEntryIncludeParam'
- $ref: '#/parameters/filePlanIncludeSourceParam' - $ref: '#/parameters/filePlanIncludeSourceParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
responses: responses:
'200': '200':
description: Successful response description: Successful response
schema: schema:
$ref: '#/definitions/RecordCategoryAssociationPaging' $ref: '#/definitions/RecordCategoryPaging'
'401': '401':
description: If authentication fails description: If authentication fails
'403': '403':
@@ -336,8 +336,6 @@ paths:
the API method tries to create the API method tries to create
a unique name using an integer suffix. a unique name using an integer suffix.
Any field in the JSON body defined below can also be passed as a form-data field.
This API method also supports record category creation using application/json. This API method also supports record category creation using application/json.
You must specify at least a **name**. You must specify at least a **name**.
@@ -434,6 +432,8 @@ paths:
Get information for unfiled records contianer **unfiledContainerId** Get information for unfiled records contianer **unfiledContainerId**
Besides mandatory fields the unfiled records container's aspects and properties are returned by default. Besides mandatory fields the unfiled records container's aspects and properties are returned by default.
You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: getUnfiledContainer operationId: getUnfiledContainer
parameters: parameters:
- $ref: '#/parameters/unfiledContainerIdParam' - $ref: '#/parameters/unfiledContainerIdParam'
@@ -527,7 +527,7 @@ paths:
Minimal information for each child is returned by default. Minimal information for each child is returned by default.
You can use the **include** parameter to return additional information. You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: listUnfiledContainerChildren operationId: listUnfiledContainerChildren
produces: produces:
- application/json - application/json
@@ -536,7 +536,7 @@ paths:
- $ref: '#/parameters/skipCountParam' - $ref: '#/parameters/skipCountParam'
- $ref: '#/parameters/maxItemsParam' - $ref: '#/parameters/maxItemsParam'
- $ref: '#/parameters/unfiledRecordFolderAndContainerWhereParam' - $ref: '#/parameters/unfiledRecordFolderAndContainerWhereParam'
- $ref: '#/parameters/unfiledContainerEntryIncludeParam' - $ref: '#/parameters/unfiledContainerChildEntryIncludeParam'
- $ref: '#/parameters/unfiledContainerIncludeSourceParam' - $ref: '#/parameters/unfiledContainerIncludeSourceParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
responses: responses:
@@ -664,7 +664,7 @@ paths:
parameters: parameters:
- $ref: '#/parameters/unfiledContainerIdParam' - $ref: '#/parameters/unfiledContainerIdParam'
- $ref: '#/parameters/autoRenameParam' - $ref: '#/parameters/autoRenameParam'
- $ref: '#/parameters/unfiledContainerEntryIncludeParam' - $ref: '#/parameters/unfiledRecordFolderEntryIncludeParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
- in: body - in: body
name: nodeBodyCreate name: nodeBodyCreate
@@ -705,6 +705,8 @@ paths:
Get information for unfiled record folder id **unfiledRecordFolderId** Get information for unfiled record folder id **unfiledRecordFolderId**
Besides mandatory fields the unfiled record folder's aspects and properties are returned by default. Besides mandatory fields the unfiled record folder's aspects and properties are returned by default.
You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: getUnfiledRecordFolder operationId: getUnfiledRecordFolder
parameters: parameters:
- $ref: '#/parameters/unfiledRecordFolderIdParam' - $ref: '#/parameters/unfiledRecordFolderIdParam'
@@ -758,6 +760,7 @@ paths:
operationId: updateUnfiledRecordFolder operationId: updateUnfiledRecordFolder
parameters: parameters:
- $ref: '#/parameters/unfiledRecordFolderIdParam' - $ref: '#/parameters/unfiledRecordFolderIdParam'
- $ref: '#/parameters/unfiledRecordFolderEntryIncludeParam'
- $ref: '#/parameters/unfiledRecordFolderIncludeSourceParam' - $ref: '#/parameters/unfiledRecordFolderIncludeSourceParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
- in: body - in: body
@@ -829,7 +832,7 @@ paths:
Minimal information for each child is returned by default. Minimal information for each child is returned by default.
You can use the **include** parameter to return additional information. You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: listUnfiledRecordFolderChildren operationId: listUnfiledRecordFolderChildren
produces: produces:
- application/json - application/json
@@ -838,7 +841,7 @@ paths:
- $ref: '#/parameters/skipCountParam' - $ref: '#/parameters/skipCountParam'
- $ref: '#/parameters/maxItemsParam' - $ref: '#/parameters/maxItemsParam'
- $ref: '#/parameters/unfiledRecordFolderAndContainerWhereParam' - $ref: '#/parameters/unfiledRecordFolderAndContainerWhereParam'
- $ref: '#/parameters/unfiledRecordFolderEntryIncludeParam' - $ref: '#/parameters/unfiledRecordFolderChildEntryIncludeParam'
- $ref: '#/parameters/unfiledRecordFolderRelativePathParam' - $ref: '#/parameters/unfiledRecordFolderRelativePathParam'
- $ref: '#/parameters/unfiledRecordFolderIncludeSourceParam' - $ref: '#/parameters/unfiledRecordFolderIncludeSourceParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
@@ -1008,6 +1011,8 @@ paths:
Get information for record category **recordCategoryId** Get information for record category **recordCategoryId**
Besides mandatory fields the record category's aspects and properties are returned by default. Besides mandatory fields the record category's aspects and properties are returned by default.
You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: getRecordCategory operationId: getRecordCategory
parameters: parameters:
- $ref: '#/parameters/recordCategoryIdParam' - $ref: '#/parameters/recordCategoryIdParam'
@@ -1132,12 +1137,9 @@ paths:
Minimal information for each child is returned by default. Minimal information for each child is returned by default.
You can use the **include** parameter to return additional information. 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. The list of child nodes includes primary children and secondary children, if there are any.
You can use the **include** parameter (include=association) to return child association details
for each child, including the **assocType** and the **isPrimary** flag.
operationId: listRecordCategoryChildren operationId: listRecordCategoryChildren
produces: produces:
- application/json - application/json
@@ -1146,7 +1148,7 @@ paths:
- $ref: '#/parameters/skipCountParam' - $ref: '#/parameters/skipCountParam'
- $ref: '#/parameters/maxItemsParam' - $ref: '#/parameters/maxItemsParam'
- $ref: '#/parameters/recordCategoryWhereParam' - $ref: '#/parameters/recordCategoryWhereParam'
- $ref: '#/parameters/recordCategoryChildIncludeParam' - $ref: '#/parameters/recordCategoryChildEntryIncludeParam'
- $ref: '#/parameters/recordCategoryRelativePathParam' - $ref: '#/parameters/recordCategoryRelativePathParam'
- $ref: '#/parameters/recordCategoryIncludeSourceParam' - $ref: '#/parameters/recordCategoryIncludeSourceParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
@@ -1154,7 +1156,7 @@ paths:
'200': '200':
description: Successful response description: Successful response
schema: schema:
$ref: '#/definitions/RecordCategoryAssociationPaging' $ref: '#/definitions/RecordCategoryChildPaging'
'401': '401':
description: If authentication fails description: If authentication fails
'403': '403':
@@ -1176,8 +1178,6 @@ paths:
the API method tries to create the API method tries to create
a unique name using an integer suffix. a unique name using an integer suffix.
Any field in the JSON body defined below can also be passed as a form-data field.
This API method also supports record category or record folder creation using application/json. This API method also supports record category or record folder creation using application/json.
You must specify at least a **name** and **nodeType**. You must specify at least a **name** and **nodeType**.
@@ -1271,7 +1271,7 @@ paths:
parameters: parameters:
- $ref: '#/parameters/recordCategoryIdParam' - $ref: '#/parameters/recordCategoryIdParam'
- $ref: '#/parameters/autoRenameParam' - $ref: '#/parameters/autoRenameParam'
- $ref: '#/parameters/recordCategoryChildEntryIncludeParam' - $ref: '#/parameters/recordCategoryEntryIncludeParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
- in: body - in: body
name: nodeBodyCreate name: nodeBodyCreate
@@ -1313,6 +1313,8 @@ paths:
Get information for record folder **recordFolderId** Get information for record folder **recordFolderId**
Besides mandatory fields the record folder's aspects and properties are returned by default. Besides mandatory fields the record folder's aspects and properties are returned by default.
You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: getRecordFolder operationId: getRecordFolder
parameters: parameters:
- $ref: '#/parameters/recordFolderIdParam' - $ref: '#/parameters/recordFolderIdParam'
@@ -1436,12 +1438,9 @@ paths:
Minimal information for each record is returned by default. Minimal information for each record is returned by default.
You can use the **include** parameter to return additional information.
The list of records includes primary children and secondary children, if there are any. The list of records includes primary children and secondary children, if there are any.
You can use the **include** parameter (include=association) to return child association details You can use the **include** parameter (include=allowableOperations) to return additional information.
for each child, including the **assocType** and the **isPrimary** flag.
operationId: listRecordFolderChildren operationId: listRecordFolderChildren
produces: produces:
- application/json - application/json
@@ -1563,7 +1562,7 @@ paths:
operationId: createRecordFolderChild operationId: createRecordFolderChild
parameters: parameters:
- $ref: '#/parameters/recordFolderIdParam' - $ref: '#/parameters/recordFolderIdParam'
- $ref: '#/parameters/recordFolderChildEntryIncludeParam' - $ref: '#/parameters/recordEntryIncludeParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
- in: body - in: body
name: recordBodyCreate name: recordBodyCreate
@@ -1605,6 +1604,8 @@ paths:
Get information for record **recordId** Get information for record **recordId**
Besides mandatory fields the record's aspects and properties are returned by default. Besides mandatory fields the record's aspects and properties are returned by default.
You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: getRecord operationId: getRecord
parameters: parameters:
- $ref: '#/parameters/recordIdParam' - $ref: '#/parameters/recordIdParam'
@@ -1759,6 +1760,8 @@ paths:
You can specify the target record folder by providing its id **targetParentId** You can 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. 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.
operationId: fileRecord operationId: fileRecord
parameters: parameters:
- $ref: '#/parameters/recordIdParam' - $ref: '#/parameters/recordIdParam'
@@ -1854,6 +1857,8 @@ paths:
Get information for transfer container **transferContainerId** Get information for transfer container **transferContainerId**
Besides mandatory fields the transfer container's aspects and properties are returned by default. Besides mandatory fields the transfer container's aspects and properties are returned by default.
You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: getTransferContainer operationId: getTransferContainer
parameters: parameters:
- $ref: '#/parameters/transferContainerIdWithAliasParam' - $ref: '#/parameters/transferContainerIdWithAliasParam'
@@ -1946,10 +1951,7 @@ paths:
Minimal information for each child is returned by default. Minimal information for each child is returned by default.
You can use the **include** parameter to return additional information. You can use the **include** parameter (include=allowableOperations) to return additional information.
You can use the **include** parameter (include=association) to return child association details
for each child, including the **assocType** and the **isPrimary** flag.
operationId: listTransfers operationId: listTransfers
produces: produces:
- application/json - application/json
@@ -1957,7 +1959,7 @@ paths:
- $ref: '#/parameters/transferContainerIdWithAliasParam' - $ref: '#/parameters/transferContainerIdWithAliasParam'
- $ref: '#/parameters/skipCountParam' - $ref: '#/parameters/skipCountParam'
- $ref: '#/parameters/maxItemsParam' - $ref: '#/parameters/maxItemsParam'
- $ref: '#/parameters/transferEntryIncludeParam' - $ref: '#/parameters/transferContainerChildEntryIncludeParam'
- $ref: '#/parameters/transferContainerIncludeSourceParam' - $ref: '#/parameters/transferContainerIncludeSourceParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
responses: responses:
@@ -1985,6 +1987,8 @@ paths:
Get information for transfer **transferId** Get information for transfer **transferId**
Besides mandatory fields the transfer's aspects and properties are returned by default. Besides mandatory fields the transfer's aspects and properties are returned by default.
You can use the **include** parameter (include=allowableOperations) to return additional information.
operationId: getTransfer operationId: getTransfer
parameters: parameters:
- $ref: '#/parameters/transferIdParam' - $ref: '#/parameters/transferIdParam'
@@ -2020,10 +2024,7 @@ paths:
Minimal information for each child is returned by default. Minimal information for each child is returned by default.
You can use the **include** parameter to return additional information. You can use the **include** parameter (include=allowableOperations) to return additional information.
You can use the **include** parameter (include=association) to return child association details
for each child, including the **assocType** and the **isPrimary** flag.
operationId: listTransfersChildren operationId: listTransfersChildren
produces: produces:
- application/json - application/json
@@ -2063,6 +2064,21 @@ parameters:
items: items:
type: string type: string
collectionFormat: csv collectionFormat: csv
filePlanCategoriesEntryIncludeParam:
name: include
in: query
description: |
Returns additional information about the record category. Any optional field from the response model can be requested. For example:
* allowableOperations
* aspectNames
* hasRetentionSchedule
* path
* properties
required: false
type: array
items:
type: string
collectionFormat: csv
filePlanIdWithAliasParam: filePlanIdWithAliasParam:
name: filePlanId name: filePlanId
in: path in: path
@@ -2095,6 +2111,21 @@ parameters:
items: items:
type: string type: string
collectionFormat: csv collectionFormat: csv
unfiledContainerChildEntryIncludeParam:
name: include
in: query
description: |
Returns additional information about the unfiled records container children. Any optional field from the response model can be requested. For example:
* allowableOperations
* aspectNames
* association
* path
* properties
required: false
type: array
items:
type: string
collectionFormat: csv
unfiledContainerIncludeSourceParam: unfiledContainerIncludeSourceParam:
name: includeSource name: includeSource
in: query in: query
@@ -2121,6 +2152,21 @@ parameters:
items: items:
type: string type: string
collectionFormat: csv collectionFormat: csv
unfiledRecordFolderChildEntryIncludeParam:
name: include
in: query
description: |
Returns additional information about the unfiled records container children. Any optional field from the response model can be requested. For example:
* allowableOperations
* aspectNames
* association
* path
* properties
required: false
type: array
items:
type: string
collectionFormat: csv
unfiledRecordFolderRelativePathParam: unfiledRecordFolderRelativePathParam:
name: relativePath name: relativePath
in: query in: query
@@ -2161,21 +2207,8 @@ parameters:
in: query in: query
description: | description: |
Returns additional information about the record category. Any optional field from the response model can be requested. For example: Returns additional information about the record category. Any optional field from the response model can be requested. For example:
* allowableOperations
* hasRetentionSchedule * hasRetentionSchedule
* isRecordCategory
* allowableOperations
* path
required: false
type: array
items:
type: string
collectionFormat: csv
recordCategoryChildEntryIncludeParam:
name: include
in: query
description: |
Returns additional information about the record category. Any optional field from the response model can be requested. For example:
* allowableOperations
* path * path
required: false required: false
type: array type: array
@@ -2195,19 +2228,19 @@ parameters:
description: Also include **source** in addition to **entries** with folder information on the parent node either the specified parent **recordCategoryId**, or as resolved by **relativePath**. description: Also include **source** in addition to **entries** with folder information on the parent node either the specified parent **recordCategoryId**, or as resolved by **relativePath**.
required: false required: false
type: boolean type: boolean
recordCategoryChildIncludeParam: recordCategoryChildEntryIncludeParam:
name: include name: include
in: query in: query
description: | description: |
Returns additional information about the record category. Any optional field from the response model can be requested. For example: Returns additional information about the record category child. Any optional field from the response model can be requested. For example:
* properties * allowableOperations
* aspectNames * aspectNames
* hasRetentionSchedule * hasRetentionSchedule
* isClosed * isClosed
* isRecordCategory * isRecordCategory
* isRecordFolder * isRecordFolder
* allowableOperations
* path * path
* properties
required: false required: false
type: array type: array
items: items:
@@ -2240,10 +2273,8 @@ parameters:
in: query in: query
description: | description: |
Returns additional information about the record folders. Any optional field from the response model can be requested. For example: Returns additional information about the record folders. Any optional field from the response model can be requested. For example:
* properties
* aspectNames
* isClosed
* allowableOperations * allowableOperations
* isClosed
* path * path
required: false required: false
type: array type: array
@@ -2261,11 +2292,13 @@ parameters:
in: query in: query
description: | description: |
Returns additional information about the records. Any optional field from the response model can be requested. For example: Returns additional information about the records. Any optional field from the response model can be requested. For example:
* properties
* aspectNames
* isCompleted
* allowableOperations * allowableOperations
* aspectNames
* association
* content
* isCompleted
* path * path
* properties
required: false required: false
type: array type: array
items: items:
@@ -2304,6 +2337,22 @@ parameters:
items: items:
type: string type: string
collectionFormat: csv collectionFormat: csv
transferContainerChildEntryIncludeParam:
name: include
in: query
description: |
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
required: false
type: array
items:
type: string
collectionFormat: csv
transferContainerIncludeSourceParam: transferContainerIncludeSourceParam:
name: includeSource name: includeSource
in: query in: query
@@ -2316,12 +2365,10 @@ parameters:
in: query in: query
description: | description: |
Returns additional information about the transfer folder. Any optional field from the response model can be requested. For example: Returns additional information about the transfer folder. Any optional field from the response model can be requested. For example:
* allowableOperations
* transferPDFIndicator * transferPDFIndicator
* transferLocation * transferLocation
* transferAccessionIndicator * transferAccessionIndicator
* properties
* aspectNames
* allowableOperations
required: false required: false
type: array type: array
items: items:
@@ -2344,14 +2391,13 @@ parameters:
in: query in: query
description: | description: |
Returns additional information about the transfer's child. Any optional field from the response model can be requested. For example: Returns additional information about the transfer's child. Any optional field from the response model can be requested. For example:
* properties
* aspectNames
* isCompleted
* isRecord
* isClosed
* isRecordFolder
* allowableOperations * allowableOperations
* aspectNames
* isClosed
* isRecord
* isRecordFolder
* path * path
* properties
required: false required: false
type: array type: array
items: items:
@@ -2369,9 +2415,9 @@ parameters:
in: query in: query
description: | description: |
Returns additional information about the record. Any optional field from the response model can be requested. For example: Returns additional information about the record. Any optional field from the response model can be requested. For example:
* isCompleted
* content
* allowableOperations * allowableOperations
* content
* isCompleted
* path * path
required: false required: false
type: array type: array
@@ -2525,12 +2571,6 @@ definitions:
FilePlanBodyUpdate: FilePlanBodyUpdate:
type: object type: object
properties: properties:
name:
type: string
pattern: "^(?!(.*[\\\"\\*\\\\\\>\\<\\?\\/\\:\\|]+.*)|(.*[\\.]?.*[\\.]+$)|(.*[ ]+$))"
description: |
The name must not contain spaces or the following special characters: * " < > \ / ? : and |.
The character . must not be used at the end of the name.
properties: properties:
type: object type: object
additionalProperties: additionalProperties:
@@ -2617,6 +2657,8 @@ definitions:
- id - id
- name - name
- nodeType - nodeType
- isUnfiledRecordFolder
- isRecord
- createdAt - createdAt
- createdByUser - createdByUser
- modifiedAt - modifiedAt
@@ -2635,6 +2677,10 @@ definitions:
The character . must not be used at the end of the name. The character . must not be used at the end of the name.
nodeType: nodeType:
type: string type: string
isUnfiledRecordFolder:
type: boolean
isRecord:
type: boolean
modifiedAt: modifiedAt:
type: string type: string
format: date-time format: date-time
@@ -2705,6 +2751,8 @@ definitions:
- id - id
- name - name
- nodeType - nodeType
- isUnfiledRecordFolder
- isRecord
- createdAt - createdAt
- createdByUser - createdByUser
- modifiedAt - modifiedAt
@@ -2723,6 +2771,10 @@ definitions:
The character . must not be used at the end of the name. The character . must not be used at the end of the name.
nodeType: nodeType:
type: string type: string
isUnfiledRecordFolder:
type: boolean
isRecord:
type: boolean
modifiedAt: modifiedAt:
type: string type: string
format: date-time format: date-time
@@ -2758,6 +2810,8 @@ definitions:
- id - id
- name - name
- nodeType - nodeType
- isUnfiledRecordFolder
- isRecord
- createdAt - createdAt
- createdByUser - createdByUser
- modifiedAt - modifiedAt
@@ -2776,6 +2830,10 @@ definitions:
The character . must not be used at the end of the name. The character . must not be used at the end of the name.
nodeType: nodeType:
type: string type: string
isUnfiledRecordFolder:
type: boolean
isRecord:
type: boolean
modifiedAt: modifiedAt:
type: string type: string
format: date-time format: date-time
@@ -2963,7 +3021,7 @@ definitions:
properties: properties:
entry: entry:
$ref: '#/definitions/RecordCategoryChild' $ref: '#/definitions/RecordCategoryChild'
RecordCategoryAssociationPaging: RecordCategoryPaging:
type: object type: object
properties: properties:
list: list:
@@ -2974,23 +3032,23 @@ definitions:
entries: entries:
type: array type: array
items: items:
$ref: '#/definitions/RecordCategoryChildAssociationEntry' $ref: '#/definitions/RecordCategoryEntry'
source:
$ref: '#/definitions/FilePlan'
RecordCategoryChildPaging:
type: object
properties:
list:
type: object
properties:
pagination:
$ref: '#/definitions/Pagination'
entries:
type: array
items:
$ref: '#/definitions/RecordCategoryChildEntry'
source: source:
$ref: '#/definitions/RecordCategory' $ref: '#/definitions/RecordCategory'
RecordCategoryChildAssociationEntry:
type: object
required:
- entry
properties:
entry:
$ref: '#/definitions/RecordCategoryChildAssociation'
RecordCategoryChildAssociation:
allOf:
- $ref: '#/definitions/RecordCategoryChild'
- type: object
properties:
association:
$ref: '#/definitions/ChildAssociationInfo'
## Record folder ## Record folder
RecordFolder: RecordFolder:
type: object type: object
@@ -3368,10 +3426,6 @@ definitions:
type: boolean type: boolean
default: false default: false
description: Indicates if the record folder is closed description: Indicates if the record folder is closed
isCompleted:
type: boolean
default: false
description: Present only for record nodes. Indicates if the record has a retention schedule defined
modifiedAt: modifiedAt:
type: string type: string
format: date-time format: date-time