Heterogeneous Folder

Apply Label

Applies a label to an entity. Note that the returned LabelApplication uses an EMPTY projection

URI: /comb/v1/d/afrh/label/apply/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
labelid	Query		LabelHandle of the Label to be applied
type	Query	Restricted to: PRIVATE PUBLIC	Label application type
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: labelApplication

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Apply Label Batch

Applies label to a collection of entities

URI: /comb/v1/d/afrh/label/apply

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
labelid	Query		LabelHandle of the Label to be applied
type	Query	Restricted to: PRIVATE PUBLIC	Label application type
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: beeIdList<entity>

Response Payload: listResult<labelApplication>

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Batch size exceeded
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Copy

Copy a single Folder into a different folder/workspace

URI: /comb/v1/d/afrh/copy/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		The destination folder or workspace
conflict_resolution_mode	Query	Restricted to: ABORT CREATE_UNIQUE OVERWRITE VERSION_OVERWRITE	How to resolve name clash on the copy (ConflictResolutionMode.OVERWRITE and ConflictResolutionMode.VERSION_OVERWRITE not supported)
projection	Query	Restricted to: BASIC BASIC_WITH_PATH BASIC_WITH_SUBFOLDERS BASIC_WITH_SUB_FOLDERS EMPTY EMPTY_WITH_NAME_SUB_FOLDERS_ALL EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID EMPTY_WITH_SNAPSHOTID_SUB_FOLDERS_ALL EMPTY_WITH_SUBFOLDERS FULL FULL_WITH_LOCK_SNAPSHOTS META META_WITH_SUBFOLDERS META_WITH_SUB_FOLDERS	Projection to use for the returned snapshot
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: heterogeneousFolder

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Name conflict occurred
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Create

URI: /comb/v1/d/afrh

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC BASIC_WITH_PATH BASIC_WITH_SUBFOLDERS BASIC_WITH_SUB_FOLDERS EMPTY EMPTY_WITH_NAME_SUB_FOLDERS_ALL EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID EMPTY_WITH_SNAPSHOTID_SUB_FOLDERS_ALL EMPTY_WITH_SUBFOLDERS FULL FULL_WITH_LOCK_SNAPSHOTS META META_WITH_SUBFOLDERS META_WITH_SUB_FOLDERS
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: heterogeneousFolderCreator

Response Payload: heterogeneousFolder

Fault: restFault

Details: (expand)

HTTP Status	Description
400
400	Error processing "runas" value
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500
500	Internal error occurred

Delete Batch

Deletes a set of folders and immediately purges them from trash. If a delete triggers a pending workflow, then approval of the workflow will move the folder to the trash, and the purge will need to be completed manually. No exception will be thrown in this case. Rather, the client must reload the folder to check its workflow status. Use the call variant that returns a PendingWorkflowStatus to avoid the extra load call.

URI: /comb/v1/d/afrh/delete

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: beeIdList<heterogeneousFolder>

Response Payload: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status	Description
200	Partial failure of operation on a batch of entities
400	Batch size exceeded
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Get Element Modifications

Returns a list of artifacts that are added, modified or removed from the given folder since the time identified by the specified anchor. Modified artifacts will be loaded with the EMPTY projection.

URI: /comb/v1/d/afrh/gem/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		The starting point to begin search
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: elementModifications

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Given snapshotid is too old
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Get Team Collaboration URL

Return the URL for the specified HeterogeneousFolder.

URI: /comb/v1/d/afrh/teamcollab/{id}

HTTP Method: GET

Request Parameters: (expand)

Name

Style

Required

Description

accept

Header

Restricted to:

application/json
application/xml

Directive to the server, indicating the format of the returned payload (or error class)

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

suppress_20x_code

Query

Restricted to:

false
true

Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.

Request Payload: No Request Payload

Response Payload: teamCollaborationURL

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
406	Unsupported value in Accept header
500	Internal error occurred

List

List the artifacts contained within a heterogeneous folder. EmptySnapshotListFilter allows the count limit to be set. Artifact snapshots will be returned with Projection.Empty and should be loaded via their owning services if required.

URI: /comb/v1/d/afrh/list/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: predicateAndSortListParameters

Predicates Supported: (expand)

Predicate Type
changeStatusPredicate
createdByPredicate
createdOnPredicate
entityTypePredicate
labelPredicate
matchAllPredicate
matchAnyPredicate
matchNotPredicate
modifiedByPredicate
modifiedOnPredicate
namePredicate
ownerPredicate

Sort Criteria Supported: (expand)

Sort Criteria Type
compoundSortCriteria
modifiedOnSortCriteria
nameSortCriteria

Response Payload: listResult<artifact>

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

List Activity Stream

List activities related to given entity

URI: /comb/v1/d/afrh/activity/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: predicateListParameters

Response Payload: listResult<entityActivity>

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

List Subfolders

List subfolders, including those not directly a descendant of the parent

URI: /comb/v1/d/afrh/subfolders/list/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: predicateAndSortListParameters

Response Payload: listResult<heterogeneousFolder>

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Lock

Lock an entity

URI: /comb/v1/d/afrh/lock/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
lock_type	Query	Restricted to: ALL DAV USER_REQUEST VERSION WORKFLOW	The type of lock to acquire.
snapshotid	Query		Can be used to check for optimistic locking on the Lockable entity.
projection	Query	Restricted to: EMPTY FULL_WITH_LOCK_SNAPSHOTS	Projection specifying the attributes to load in the returned Lockable. Whenever Projection.BASIC or higher is passed in, the Lock snapshots for the getLocks() attribute of the Lockable will be loaded with Projection.BASIC, such that the caller can tell the ID of the newly-acquired lock based on its lock type.
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: lockUpdater

Response Payload: Lockable

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
409	Entity state has changed
500	Internal error occurred

Move Batch to Trash

Delete a set of folders.

URI: /comb/v1/d/afrh/trash

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY EMPTY_WITH_DELETEDENTITY FULL META	Projection to use when loading the associated TrashItems
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: beeIdList<heterogeneousFolder>

Response Payload: list<trashItem>

Fault: restFault

Details: (expand)

HTTP Status	Description
200	Partial failure of operation on a batch of entities
400	Batch size exceeded
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
404	No entity exists with the specified ID
406	Unsupported value in Accept header
500	Internal error occurred

Move to Trash

Deletes (move to Trash) the HeterogeneousFolder refereced by the supplied HeterogeneousFolderHandle. No exception will be thrown if this operation requires a workflow, but a null trash item will be returned.

URI: /comb/v1/d/afrh/trash/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		determine if the entity should always be deleted or if optimistic locking should be used.
projection	Query	Restricted to: BASIC EMPTY EMPTY_WITH_DELETEDENTITY FULL META	Projection to use when loading the deleted folder
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: trashItem

Fault: restFault

Details: (expand)

HTTP Status	Description
200	Partial failure of operation on a batch of entities
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Read

Returns a Heterogeneous Folder instance based on the CollabId in the supplied HeterogeneousFolderHandle and with the attributes loaded based on the provided Projection.

If Projection.EMPTY is supplied, the returned HeterogeneousFolder instance will only have the CollabId and the StateId loaded.
If an ArtifactListProjection is supplied, it must contain an EmptySnapshotListFilter. Other ListFilters will not be supported.

URI: /comb/v1/d/afrh/{id}

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC BASIC_WITH_PATH BASIC_WITH_SUBFOLDERS BASIC_WITH_SUB_FOLDERS EMPTY EMPTY_WITH_NAME_SUB_FOLDERS_ALL EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID EMPTY_WITH_SNAPSHOTID_SUB_FOLDERS_ALL EMPTY_WITH_SUBFOLDERS FULL FULL_WITH_LOCK_SNAPSHOTS META META_WITH_SUBFOLDERS META_WITH_SUB_FOLDERS	Projection representing the portion of the HeterogeneousFolder to load.
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.

Request Payload: No Request Payload

Response Payload: heterogeneousFolder

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
406	Unsupported value in Accept header
500	Internal error occurred

Read Access Control

Reads entity access control fields

URI: /comb/v1/d/afrh/ac/{id}

HTTP Method: GET

Request Parameters: (expand)

Name

Style

Required

Description

accept

Header

Restricted to:

application/json
application/xml

Directive to the server, indicating the format of the returned payload (or error class)

runas

Query

Identity under-which to execute this operation. Callers require permission to run as a different identity.

suppress_20x_code

Query

Restricted to:

false
true

Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.

Request Payload: No Request Payload

Response Payload: accessControlFields

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
406	Unsupported value in Accept header
500	Internal error occurred

Read Batch

Load a collection of Heterogeneous Folder instances based on the CollabId of the supplied HeterogeneousFolderHandles and with the attributes loaded based on the provided Projection.

If Projection.EMPTY is supplied, the returned HeterogeneousFolder instances will only have the CollabId and the StateId loaded.
If an ArtifactListProjection is supplied, it must contain an EmptySnapshotListFilter. Other ListFilters will not be supported.

URI: /comb/v1/d/afrh/read

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC BASIC_WITH_PATH BASIC_WITH_SUBFOLDERS BASIC_WITH_SUB_FOLDERS EMPTY EMPTY_WITH_NAME_SUB_FOLDERS_ALL EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID EMPTY_WITH_SNAPSHOTID_SUB_FOLDERS_ALL EMPTY_WITH_SUBFOLDERS FULL FULL_WITH_LOCK_SNAPSHOTS META META_WITH_SUBFOLDERS META_WITH_SUB_FOLDERS	Projection representing the portion to be loaded for each HeterogeneousFolder
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: beeIdList<heterogeneousFolder>

Response Payload: list<heterogeneousFolder>

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Batch size exceeded
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Remove Label

Remove the label applied from an entity

URI: /comb/v1/d/afrh/label/remove/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
labelid	Query		LabelHandle of the Label to be removed
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Remove Label Batch

Removes the label applied from a collection of entities

URI: /comb/v1/d/afrh/label/remove

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
labelid	Query		LabelHandle of the Label to be removed
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: beeIdList<entity>

Response Payload: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Batch size exceeded
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred

Undelete

Undelete/restore the deleted HeterogeneousFolder.

URI: /comb/v1/d/afrh/undelete/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
new_name	Query		Mode to use for the undelete operation
projection	Query	Restricted to: BASIC BASIC_WITH_PATH BASIC_WITH_SUBFOLDERS BASIC_WITH_SUB_FOLDERS EMPTY EMPTY_WITH_NAME_SUB_FOLDERS_ALL EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID EMPTY_WITH_SNAPSHOTID_SUB_FOLDERS_ALL EMPTY_WITH_SUBFOLDERS FULL FULL_WITH_LOCK_SNAPSHOTS META META_WITH_SUBFOLDERS META_WITH_SUB_FOLDERS	Projection to use when loading the snapshot
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: heterogeneousFolder

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Unlock

Remove a user-requested lock from an entity

URI: /comb/v1/d/afrh/unlock/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
lock_type	Query	Restricted to: ALL DAV USER_REQUEST VERSION WORKFLOW	The type of lock to remove from the specified entity.
projection	Query	Restricted to: EMPTY FULL_WITH_LOCK_SNAPSHOTS	Projection specifying the attributes to load in the returned Lockable. The getLocks() attribute will always load the remaining locks with Projection.EMPTY.
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token

Request Payload: No Request Payload

Response Payload: Lockable

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid value specified for query parameter
400	Required header not specified
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Update

Update the Heterogeneous Folder referenced by the supplied HeterogeneousFolderHandle based on attribute values supplied through the HeterogeneousFolderUpdater. The OPTIMISTIC_LOCKING mode is supplied, and Heterogeneous Folder state is not the latest one, the OutdatedStateException will be thrown. If successful, it returns a new HeterogeneousFolder snapshot based on the supplied Projection.

Example:

 HeterogeneousFolderFactory hfFactory = HeterogeneousFolderFactory.getInstance();   
 HeterogeneousFolderControl hfControl = ControlLocator.getInstance().getHeterogeneousFolderControl();  
 
 HeterogeneousFolderCreator updater = hfFactory.createHeterogeneousFolderUpdater();
 updater.setName("name");

 HeterogeneousFolderProjection proj = hfFactory.createHeterogeneousFolderProjection();
 proj.autoSelectAll();
 HeterogeneousFolder updatedFolder = hfControl.updateHeterogeneousFolder(hf.getHandle(), 
                                                   updater,
                                                   UpdateMode.OPTIMISTIC_LOCKING);

URI: /comb/v1/d/afrh/{id}

HTTP Method: PUT

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		determine if the entity should always be updated or if optimistic locking should be used.
projection	Query	Restricted to: BASIC BASIC_WITH_PATH BASIC_WITH_SUBFOLDERS BASIC_WITH_SUB_FOLDERS EMPTY EMPTY_WITH_NAME_SUB_FOLDERS_ALL EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID EMPTY_WITH_SNAPSHOTID_SUB_FOLDERS_ALL EMPTY_WITH_SUBFOLDERS FULL FULL_WITH_LOCK_SNAPSHOTS META META_WITH_SUBFOLDERS META_WITH_SUB_FOLDERS
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: heterogeneousFolderUpdater

Response Payload: heterogeneousFolder

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
409	Entity state has changed
500	Internal error occurred

Update Access Control

Updates entity access control fields

URI: /comb/v1/d/afrh/ac/{id}

HTTP Method: PUT

Request Parameters: (expand)

Name	Style	Required	Description
accept	Header	Restricted to: application/json application/xml	Directive to the server, indicating the format of the returned payload (or error class)
runas	Query		Identity under-which to execute this operation. Callers require permission to run as a different identity.
suppress_20x_code	Query	Restricted to: false true	Indicates if HTTP status codes in the 200-299 range are suppressed and always returned as 200. Required when client technology assumes that any return code other than 200 is a fault.
anticsrf	Query		Specifies the anti-CSRF token
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: accessControlFieldsUpdater

Response Payload: No Response Payload

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
400	Format of ID specified is incorrect
400	Id type is incorrect
400	Invalid header specified
400	Invalid payload specified
400	Invalid value specified for query parameter
400	JSON payload received with a wrong data member type
400	No payload specified
400	Required header not specified
400	Required query parameter not specified
400	Type of payload specified does not match what is expected
406	Unsupported value in Accept header
500	Internal error occurred