Wiki Page

Apply Label

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

URI: /comb/v1/d/wiki/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/wiki/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

Cancel Check-out

Cancels the checkout of a checked-out WikiPage.

URI: /comb/v1/d/wiki/checkout/cancel/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		Used to enforce optimistic locking as the family's snapshot id is updated by this operation
projection	Query	Restricted to: BASIC EMPTY FULL	Projection with which to load the returned family versionable
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: Versionable

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Entity not checked-out
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

Check-in

Check-in the WikiPage.

URI: /comb/v1/d/wiki/checkin/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
version_name	Query		Name to assign to the new version
snapshotid	Query		Current snapshot id of the family (not of the Version) on the client to enforce optimistic locking.
projection	Query	Restricted to: BASIC EMPTY FULL	Projection with which to load the updated family versionable 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
content-type	Header	Restricted to: application/json application/xml	The standard HTTP Content-Type Header, indicating the MIME type of the payload

Request Payload: versionUpdater

Response Payload: Versionable

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Entity not checked-out
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

Check-out

Check-out the WikiPage.

URI: /comb/v1/d/wiki/checkout/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
checkout_comments	Query		Comments describing the nature of the checkout
snapshotid	Query
projection	Query	Restricted to: BASIC EMPTY FULL	Projection to use when loading the resultant family 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: Versionable

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Configuration on a scope of folder is not defined
400	Entity is checked-out
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

Copy

Copy a WikiPage into a different folder.

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		Handle to the destination HeterogeneousFolder for this operation
projection	Query	Restricted to: BASIC BASIC_WITH_BONDS BASIC_WITH_LOCKS EMPTY EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID FULL FULL_WITH_LOCK_SNAPSHOTS META RENDER_DATA RENDER_PAGE	The Projection determines which attributes will be returned with the WikiPage
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: wikiPage

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

Create

Create a new Wiki Page. Note there are two components to a page: its metadata and its content. Metadata is represented by the argument payload. The content must have been previously uploaded to the server.

URI: /comb/v1/d/wiki

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
uploadscope	Query		The upload scope string used while uploading the associated content and/or attachment(s)
projection	Query	Restricted to: BASIC BASIC_WITH_BONDS BASIC_WITH_LOCKS EMPTY EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID FULL FULL_WITH_LOCK_SNAPSHOTS META RENDER_DATA RENDER_PAGE	The projection to use for loading the entity
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: wikiPageCreator

Response Payload: wikiPage

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Entity already exists
400	Entity not checked-out
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	Name conflict occurred
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	Operation conflicts with another pending operation
500	Internal error occurred

Delete

Permanently delete a WikiPage.

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

HTTP Method: DELETE

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		The DeleteMode to use when purging the wikipage.
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

Get Default Data Render Context

The default WikiRenderDataContext based on the default Path and HREF contexts and including the information needed for the given WikiRenderDataMode.

URI: /comb/v1/d/wiki/context/data

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
mode	Query	Restricted to: RENDER_ALL RENDER_LINKS RENDER_PLUGINS
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: wikiRenderDataContext

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
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 Default Render Context

The default WikiRenderContext based on the default Path and HREF contexts and including the information needed for the given WikiRenderMode.

URI: /comb/v1/d/wiki/context

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
mode	Query	Restricted to: EDIT_CREOLE EDIT_XHTML FULL STATIC_ONLY	- the WikiRenderMode in which to render the page (either FULL, STATIC_ONLY, EDIT_CREOLE, or EDIT_XHTML)
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: wikiRenderContext

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
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 of the specified WikiPage.

URI: /comb/v1/d/wiki/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 WikiPage objects in a HeterogeneousFolder.

URI: /comb/v1/d/wiki/list

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
parent	Query		Handle of the parent heterogeneous 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
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
createdBySortCriteria
createdOnSortCriteria
modifiedBySortCriteria
modifiedOnSortCriteria
nameSortCriteria

Response Payload: listResult<wikiPage>

Fault: restFault

Details: (expand)

HTTP Status	Description
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	Internal error occurred

List Activity Stream

List activities related to given entity

URI: /comb/v1/d/wiki/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 Orphan WikiPages

List orphan WikiPage objects in a HeterogeneousFolder.

URI: /comb/v1/d/wiki/list/orphan

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
parent	Query		Handle of the parent heterogeneous 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
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
createdBySortCriteria
createdOnSortCriteria
modifiedBySortCriteria
modifiedOnSortCriteria
nameSortCriteria

Response Payload: listResult<wikiPage>

Fault: restFault

Details: (expand)

HTTP Status	Description
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	Internal error occurred

List Wanted WikiPages

List the wanted WikiPage objects in a HeterogeneousFolder.

URI: /comb/v1/d/wiki/list/wanted

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
parent	Query		Handle of the parent heterogeneous 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: listResult<WantedArtifact>

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Error processing "runas" value
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

Lock

Lock an entity

URI: /comb/v1/d/wiki/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

Move a single WikiPage into a different folder.

URI: /comb/v1/d/wiki/move/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		Handle to the destination Heterogeneous Folder for this operation
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

Move to Trash

Move a single WikiPage into the Beehive Trash

URI: /comb/v1/d/wiki/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 TrashItem.
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
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

Retreive a single WikiPage.

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

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC BASIC_WITH_BONDS BASIC_WITH_LOCKS EMPTY EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID FULL FULL_WITH_LOCK_SNAPSHOTS META RENDER_DATA RENDER_PAGE	Projection specifying the attributes to load in the returned WikiPage. See wikiPage for complete semantics of the attributes loaded with each projection.
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: wikiPage

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

Retrieves one or more WikiPage objects from the server.

URI: /comb/v1/d/wiki/read

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC BASIC_WITH_BONDS BASIC_WITH_LOCKS EMPTY EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID FULL FULL_WITH_LOCK_SNAPSHOTS META RENDER_DATA RENDER_PAGE	Projection specifying the attributes to load in the returned WikiPage. See wikiPage for complete semantics of the attributes loaded with each projection.
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<wikiPage>

Response Payload: list<wikiPage>

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

Read Content

Read a Wiki Page content. Unlike many other access points in the API, the return is not structured data in XML/JSON, etc format. The return is the streamed contents of a Wiki Page, unencoded.

URI: /comb/v1/d/wiki/content/{id}

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
preferred_content_type	Query		Use this parameter to specify a Content-Type header in the response headers. If unspecified, the default Content-Type of "application/octet-stream" is used.
preferred_filename	Query		Use this parameter to specify a filename in the Content-Disposition header in the response headers. If unspecified, then no Content-Disposition header is included in the response.
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: Raw Data

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

Remove Label

Remove the label applied from an entity

URI: /comb/v1/d/wiki/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/wiki/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

Render Data

Returns the data portion of the specified WikiPage. The returned data is meant to be used in conjunction with

renderWikiPage(...)

using WikiRenderMode.STATIC_ONLY. Use WikiPage.getRenderedData to fetch the data.

URI: /comb/v1/d/wiki/render/data/{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: wikiRenderDataContext

Response Payload: wikiPage

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

Render Data With Default Context

Returns the data portion of the specified WikiPage. The returned data is meant to be used in conjunction with

renderWikiPage(...)

using WikiRenderMode.STATIC_ONLY. Use WikiPage.getRenderedData to fetch the data.

URI: /comb/v1/d/wiki/render/data/{id}

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
mode	Query	Restricted to: RENDER_ALL RENDER_LINKS RENDER_PLUGINS
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: wikiPage

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

Render Page

Returns the rendered xhtml version of the specified WikiPage. The rendering is based on the specified WikiRenderMode. The rendered page is returned as a part of the WikiPage, which is loaded with Projection.FULL (WikiPage.getRenderedPage())

URI: /comb/v1/d/wiki/render/{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: wikiRenderContext

Response Payload: wikiPage

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

Render Page With Default Context

Returns the rendered xhtml version of the specified WikiPage. The rendering is based on the specified WikiRenderMode. The rendered page is returned as a part of the WikiPage, which is loaded with Projection.FULL (WikiPage.getRenderedPage())

URI: /comb/v1/d/wiki/render/{id}

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
mode	Query	Restricted to: EDIT_CREOLE EDIT_XHTML FULL STATIC_ONLY
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: wikiPage

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

Undelete

Restore a single WikiPage from the Beehive Trash

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
new_name	Query		determine if the entity should be recovered with a new name or parent 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: 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

Unlock

Remove a user-requested lock from an entity

URI: /comb/v1/d/wiki/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 a Wiki Page and optionally, its content. Note there are two components to a page: its metadata and its content. Metadata is represented by the argument payload. The content must have been previously uploaded to the server.

URI: /comb/v1/d/wiki/{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.
uploadscope	Query		The upload scope string used while uploading the associated content and/or attachment(s)
projection	Query	Restricted to: BASIC BASIC_WITH_BONDS BASIC_WITH_LOCKS EMPTY EMPTY_WITH_PATH EMPTY_WITH_SNAPSHOTID FULL FULL_WITH_LOCK_SNAPSHOTS META RENDER_DATA RENDER_PAGE	The projection to use for loading the entity
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: wikiPageUpdater

Response Payload: wikiPage

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Entity not checked-out
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	Name conflict occurred
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	Operation conflicts with another pending operation
500	Internal error occurred

Update Access Control

Updates entity access control fields

URI: /comb/v1/d/wiki/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