Conference

Apply Label

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

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

Sample: (expand)

    // *
    // * This function demonstates applying a label on a single Conference item.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId1" - beeId of an item to be labelled
    // * @param "labelId" - beeId of the label to be applied
    // *
    // * @return The item "LabelApplication" object
    // *
    label: function(
        bhUtils,
        myBeeId1,
        labelId) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/owch/label/apply/" + myBeeId1.id;

        // Build-out query parameters. Note that this is a simple example
        // meant to highlight Beehive code, not javascript best practices.
        // ====
        // Parameter name: labelid
        // Description: null
        // Mandatory: true
        // ====
        // ====
        // Parameter name: type
        // Description: null
        // Mandatory: true
        // Values: PRIVATE, PUBLIC
        // ====
        resourceURI += "?labelid=" + labelId.id
            + "&type=PUBLIC";

        // Create the XMLHttpRequest object. For simplicity, the code within
        // "bhUtils" abstracts the cross-platform differences in creating the
        // XMLHttpRequest object
        var xmlHttpRequest = bhUtils.getXMLHttpRequest();

        // Setup the XMLHttpRequest object for the action required
        // Note that you must use the HTTP POST method for this request
        xmlHttpRequest.open("POST",
            resourceURI,
            false);

        // Tell the server we want the returned object to be in JSON format
        // via the HTTP "Accept" header
        xmlHttpRequest.setRequestHeader("Accept", "application/json");

        // Send the request to the server
        xmlHttpRequest.send(null);

        // Check return code. Anything other than 200 is considered an error
        if (xmlHttpRequest.status != 200) {
            // An error occurred and an object of type "Failure" will be
            // returned. The object will be in JSON format. Deserialize the
            // JSON. Since this is a simple example, the deserialization code
            // has been moved into "bhUtils"
            var failure = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

            // In this simple example, we just throw the failure object
            throw failure;
        }

        // Deserialize the JSON return. Since this is a simple example, the
        // deserialization code has been moved into "bhUtils"
        var result = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

        return result;
    }

Apply Label Batch

Applies label to a collection of entities

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

Sample: (expand)

    // *
    // * This function demonstates application of a label on several Conference
    // * items.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId1" - beeId of an item to label
    // * @param "myBeeId2" - beeId of an item to label
    // * @param "myBeeId3" - beeId of an item to label
    // * @param "labelId" - beeId of the label to be applied
    // *
    // * @return An array containing "LabelApplication" objects
    // *
    labelBatch: function(
        bhUtils,
        myBeeId1,
        myBeeId2,
        myBeeId3,
        labelId) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/owch/label/apply";

        // Build-out query parameters. Note that this is a simple example
        // meant to highlight Beehive code, not javascript best practices.
        // ====
        // Parameter name: labelid
        // Description: null
        // Mandatory: true
        // ====
        // ====
        // Parameter name: type
        // Description: null
        // Mandatory: true
        // Values: PRIVATE, PUBLIC
        // ====
        resourceURI += "?labelid=" + labelId.id
            + "&type=PUBLIC";

        // Create list of IDs to label
        var myIDs = {
            beeType:"beeIdList",
            beeId: [
                {"beeType": "beeId", "id": myBeeId1.id},
                {"beeType": "beeId", "id": myBeeId2.id},
                {"beeType": "beeId", "id": myBeeId3.id}
            ]
        };

        // Create the XMLHttpRequest object. For simplicity, the code within
        // "bhUtils" abstracts the cross-platform differences in creating the
        // XMLHttpRequest object
        var xmlHttpRequest = bhUtils.getXMLHttpRequest();

        // Setup the XMLHttpRequest object for the action required
        // Note that you must use the HTTP POST method for this request
        xmlHttpRequest.open("POST",
            resourceURI,
            false);

        // Set the content type indicating to the server the payload is JSON
        // format
        xmlHttpRequest.setRequestHeader("Content-type", "application/json");

        // Tell the server we want the returned object to be in JSON format
        // via the HTTP "Accept" header
        xmlHttpRequest.setRequestHeader("Accept", "application/json");

        // Serialize payload as JSON. To simplify these examples, JSON
        // serialization is maintained in bhUtils
        var payload = bhUtils.serializeJSON(myIDs);

        // Send the request to the server
        xmlHttpRequest.send(payload);

        // Check return code. Anything other than 200 is considered an error
        if (xmlHttpRequest.status != 200) {
            // An error occurred and an object of type "Failure" will be
            // returned. The object will be in JSON format. Deserialize the
            // JSON. Since this is a simple example, the deserialization code
            // has been moved into "bhUtils"
            var failure = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

            // In this simple example, we just throw the failure object
            throw failure;
        }

        // Deserialize the JSON return. Since this is a simple example, the
        // deserialization code has been moved into "bhUtils"
        var result = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

        return result;
    }

Copy

Copy a Conference object into another Workspace.

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		WorkspaceHandle destination folder handle
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: conference

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
409	Entity state has changed
500	Error occurred processing Conferencing operation
500	Internal error occurred

Create

Create a Conference.

URI: /comb/v1/d/owch

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY FULL META	projection in which created conference artifact should be loaded
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: conferenceCreator

Response Payload: conference

Fault: restFault

Details: (expand)

HTTP Status	Description
400	Entity already exists
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	Error occurred processing Conferencing operation
500	Internal error occurred

Discuss

Discuss an Artifact

URI: /comb/v1/d/owch/discuss/{id}

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
subject	Query		The subject of the first message in the new Topic
projection	Query	Restricted to: BASIC BASIC_WITH_DISC_CHANGE_STATUS EMPTY FULL FULL_WITH_LOCK_SNAPSHOTS META META_WITH_DISC_CHANGE_STATUS	The projection specifying the details that should be returned in the Topic snapshot. Projection.EMPTY is the base case.
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: topicUpdater

Response Payload: topic

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

List Conference objects.

URI: /comb/v1/d/owch/list

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

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

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	Error occurred processing Conferencing operation
500	Internal error occurred

Move

Move a Conference object into another Workspace

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		The destination 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
409	Entity state has changed
500	Error occurred processing Conferencing operation
500	Internal error occurred

Move to Trash

Move the Conference object into the Beehive Trash.

URI: /comb/v1/d/owch/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.
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
409	Entity state has changed
500	Error occurred processing Conferencing operation
500	Internal error occurred

Read

Retreive a single Conference object.

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

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY FULL META	Projection specifying the details that should be returned in the `Conference` snapshot. `null` values are not permitted;
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: conference

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	Error occurred processing Conferencing operation
500	Internal error occurred

Sample: (expand)

    // *
    // * This function demonstates reading a single Conference item.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId" - beeId of an item to read
    // *
    // * @return The item read
    // *
    read: function(
        bhUtils,
        myBeeId) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/owch/" + myBeeId.id;

        // Create the XMLHttpRequest object. For simplicity, the code within
        // "bhUtils" abstracts the cross-platform differences in creating the
        // XMLHttpRequest object
        var xmlHttpRequest = bhUtils.getXMLHttpRequest();

        // Setup the XMLHttpRequest object for the action required
        // Note that you must use the HTTP GET method for this request
        xmlHttpRequest.open("GET",
            resourceURI,
            false);

        // Tell the server we want the returned object to be in JSON format
        // via the HTTP "Accept" header
        xmlHttpRequest.setRequestHeader("Accept", "application/json");

        // Send the request to the server
        xmlHttpRequest.send(null);

        // Check return code. Anything other than 200 is considered an error
        if (xmlHttpRequest.status != 200) {
            // An error occurred and an object of type "Failure" will be
            // returned. The object will be in JSON format. Deserialize the
            // JSON. Since this is a simple example, the deserialization code
            // has been moved into "bhUtils"
            var failure = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

            // In this simple example, we just throw the failure object
            throw failure;
        }

        // Deserialize the JSON return. Since this is a simple example, the
        // deserialization code has been moved into "bhUtils"
        var result = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

        return result;
    }

Read Batch

Retreive one or more Conference objects from the server.

URI: /comb/v1/d/owch/read

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY FULL META	Fixed projection specifying the details that should be returned in the `Conference` snapshot. `null` values are not permitted;
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<conference>

Response Payload: list<conference>

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	Error occurred processing Conferencing operation
500	Internal error occurred

Sample: (expand)

    // *
    // * This function demonstates reading several Conference items.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId1" - beeId of an item to read
    // * @param "myBeeId2" - beeId of an item to read
    // * @param "myBeeId3" - beeId of an item to read
    // *
    // * @return An array containing the items read
    // *
    readBatch: function(
        bhUtils,
        myBeeId1,
        myBeeId2,
        myBeeId3) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/owch/read";

        // Create list of IDs to read
        var myIDs = {
            beeType:"beeIdList",
            beeId: [
                {"beeType": "beeId", "id": myBeeId1.id},
                {"beeType": "beeId", "id": myBeeId2.id},
                {"beeType": "beeId", "id": myBeeId3.id}
            ]
        };

        // Create the XMLHttpRequest object. For simplicity, the code within
        // "bhUtils" abstracts the cross-platform differences in creating the
        // XMLHttpRequest object
        var xmlHttpRequest = bhUtils.getXMLHttpRequest();

        // Setup the XMLHttpRequest object for the action required
        // Note that you must use the HTTP POST method for this request
        xmlHttpRequest.open("POST",
            resourceURI,
            false);

        // Set the content type indicating to the server the payload is JSON
        // format
        xmlHttpRequest.setRequestHeader("Content-type", "application/json");

        // Tell the server we want the returned object to be in JSON format
        // via the HTTP "Accept" header
        xmlHttpRequest.setRequestHeader("Accept", "application/json");

        // Serialize payload as JSON. To simplify these examples, JSON
        // serialization is maintained in bhUtils
        var payload = bhUtils.serializeJSON(myIDs);

        // Send the request to the server
        xmlHttpRequest.send(payload);

        // Check return code. Anything other than 200 is considered an error
        if (xmlHttpRequest.status != 200) {
            // An error occurred and an object of type "Failure" will be
            // returned. The object will be in JSON format. Deserialize the
            // JSON. Since this is a simple example, the deserialization code
            // has been moved into "bhUtils"
            var failure = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

            // In this simple example, we just throw the failure object
            throw failure;
        }

        // Deserialize the JSON return. Since this is a simple example, the
        // deserialization code has been moved into "bhUtils"
        var result = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

        return result;
    }

Remove Label

Remove the label applied from an entity

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

Restore a Conference from the Beehive Trash.

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
new_name	Query		Determine if the entity should always be deleted or if optimistic locking should be used.
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
409	Entity state has changed
500	Error occurred processing Conferencing operation
500	Internal error occurred

Update

Update a Conference.

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

HTTP Method: PUT

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		UpdateMode update mode
projection	Query	Restricted to: BASIC EMPTY FULL META
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: conferenceUpdater

Response Payload: conference

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	Error occurred processing Conferencing operation
500	Internal error occurred

Sample: (expand)

    // *
    // * This function demonstates updating the description of a single
    // * Conference item.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId" - beeId of an item to update
    // * @param "description" - New description to be udpated
    // *
    // * @return The updated item
    // *
    update: function(
        bhUtils,
        myBeeId,
        description) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/owch/" + myBeeId.id;

        var updater = {
            "beeType": "conferenceUpdater",
            "description": description
        };

        // Create the XMLHttpRequest object. For simplicity, the code within
        // "bhUtils" abstracts the cross-platform differences in creating the
        // XMLHttpRequest object
        var xmlHttpRequest = bhUtils.getXMLHttpRequest();

        // Setup the XMLHttpRequest object for the action required
        // Note that you must use the HTTP PUT method for this request
        xmlHttpRequest.open("PUT",
            resourceURI,
            false);

        // Set the content type indicating to the server the payload is JSON
        // format
        xmlHttpRequest.setRequestHeader("Content-type", "application/json");

        // Tell the server we want the returned object to be in JSON format
        // via the HTTP "Accept" header
        xmlHttpRequest.setRequestHeader("Accept", "application/json");

        // Serialize payload as JSON. To simplify these examples, JSON
        // serialization is maintained in bhUtils
        var payload = bhUtils.serializeJSON(updater);

        // Send the request to the server
        xmlHttpRequest.send(payload);

        // Check return code. Anything other than 200 is considered an error
        if (xmlHttpRequest.status != 200) {
            // An error occurred and an object of type "Failure" will be
            // returned. The object will be in JSON format. Deserialize the
            // JSON. Since this is a simple example, the deserialization code
            // has been moved into "bhUtils"
            var failure = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

            // In this simple example, we just throw the failure object
            throw failure;
        }

        // Deserialize the JSON return. Since this is a simple example, the
        // deserialization code has been moved into "bhUtils"
        var result = bhUtils.deserializeJSON(xmlHttpRequest.responseText);

        return result;
    }