GroupContact

Apply Label

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

URI: /comb/v1/d/gcon/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 GroupContact
    // * 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/gcon/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/gcon/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
    // * GroupContact 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/gcon/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

Copies the given group contact to the target address book.

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		The target address book where the group contact needs to be copied
projection	Query	Restricted to: BASIC BASIC_WITH_MEMBERS EMPTY EMPTY_WITH_ALL_ADDRESSES EMPTY_WITH_DEFAULT_ADDRESSES EMPTY_WITH_PRIMARY_ADDRESS FULL META	Projection to be used for the snapshot returned
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: groupContact

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 copying a single GroupContact item.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId" - beeId of an item to copy
    // * @param "copyTarget" - Destination of the copy
    // *
    // * @return The item created by the copy
    // *
    copy: function(
        bhUtils,
        myBeeId,
        copyTarget) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/copy/" + myBeeId.id;

        // Build-out query parameters. Note that this is a simple example
        // meant to highlight Beehive code, not javascript best practices.
        // ====
        // Parameter name: conflictresolutionmode
        // Description: null
        // Mandatory: true
        // Values: OVERWRITE, ABORT, CREATE_UNIQUE, VERSION_OVERWRITE
        // ====
        // ====
        // Parameter name: target
        // Description: null
        // Mandatory: true
        // ====
        resourceURI += "?" +
            "target=" + copyTarget.id +
            "&conflictresolutionmode=ABORT";

        // 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;
    }

Copy Batch

Copies the given group contacts to the target address book.

URI: /comb/v1/d/gcon/copy

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		The target address book where the group contact needs to be copied
projection	Query	Restricted to: BASIC BASIC_WITH_MEMBERS EMPTY EMPTY_WITH_ALL_ADDRESSES EMPTY_WITH_DEFAULT_ADDRESSES EMPTY_WITH_PRIMARY_ADDRESS FULL META	Projection to be used for the snapshot returned
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<groupContact>

Response Payload: list<groupContact>

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 copying several GroupContact items.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId1" - beeId of an item to copy
    // * @param "myBeeId2" - beeId of an item to copy
    // * @param "myBeeId3" - beeId of an item to copy
    // * @param "copyTarget" - Destination of the copy
    // *
    // * @return An array containing the items created by the copy
    // *
    copyBatch: function(
        bhUtils,
        myBeeId1,
        myBeeId2,
        myBeeId3,
        copyTarget) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/copy";

        // Build-out query parameters. Note that this is a simple example
        // meant to highlight Beehive code, not javascript best practices.
        // ====
        // Parameter name: conflictresolutionmode
        // Description: null
        // Mandatory: true
        // Values: OVERWRITE, ABORT, CREATE_UNIQUE, VERSION_OVERWRITE
        // ====
        // ====
        // Parameter name: target
        // Description: null
        // Mandatory: true
        // ====
        resourceURI += "?" +
            "target=" + copyTarget.id +
            "&conflictresolutionmode=ABORT";

        // Create list of IDs to copy
        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;
    }

Create

Create a groupContact.

URI: /comb/v1/d/gcon

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_MEMBERS EMPTY EMPTY_WITH_ALL_ADDRESSES EMPTY_WITH_DEFAULT_ADDRESSES EMPTY_WITH_PRIMARY_ADDRESS FULL META	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: groupContactCreator

Response Payload: groupContact

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	Internal error occurred

Sample: (expand)

    // *
    // * This function demonstates creating a GroupContact item.
    // *
    // * @param "bhUtils" - Helper object
    // *
    // * @return The newly created item
    // *
    create: function(
        bhUtils,
        bookmark,
        addressBook) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon";

        var creator = {
            "beeType": "groupContactCreator",
            "bookmark": bookmark,
            "addressBook": addressBook
        }

        // 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(creator);

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

        // Check return code. Anything other than 201 is considered an error
        if (xmlHttpRequest.status != 201) {
            // 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;
    }

Delete

Purge the specified group contact.

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

HTTP Method: DELETE

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		Delete mode
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

Sample: (expand)

    // *
    // * This function demonstates purging a single GroupContact item.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId" - beeId of an item to delete
    // *
    // * @return This function does not return anything
    // *
    deleteMethod: function(
        bhUtils,
        myBeeId) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/" + 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 DELETE method for this request
        xmlHttpRequest.open("DELETE",
            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 204 is considered an error
        if (xmlHttpRequest.status != 204) {
            // 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;
        }
        return;
    }

Delete Batch

Purge the specified group contacts

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

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

Sample: (expand)

    // *
    // * This function demonstates purging several GroupContact items.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId1" - beeId of an item to delete
    // * @param "myBeeId2" - beeId of an item to delete
    // * @param "myBeeId3" - beeId of an item to delete
    // *
    // * @return This function does not return anything
    // *
    deleteBatch: function(
        bhUtils,
        myBeeId1,
        myBeeId2,
        myBeeId3) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/delete";

        // Create list of IDs to delete
        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 204 is considered an error
        if (xmlHttpRequest.status != 204) {
            // 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;
        }
        return;
    }

Discuss

Discuss an Artifact

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

Searches the address book for group contacts matching a specified pattern.

URI: /comb/v1/d/gcon/list

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
parent	Query		The AddressBook to be searched. Note: for all the predicates in filter, % and _ are the wild cards supported. % is to substitute one or more characters, and _ to substitute single character. Examples foo%, fo_.
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
namePredicate

Sort Criteria Supported: (expand)

Sort Criteria Type
nameSortCriteria

Response Payload: listResult<groupContact>

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

Move

Moves the given group contact to the target address book.

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		The target address book where the group contact needs to be moved.
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

Sample: (expand)

    // *
    // * This function demonstates moving a single GroupContact item.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId" - beeId of an item to move
    // * @param "moveTarget" - Destination of the move
    // *
    // * @return This function does not return anything
    // *
    move: function(
        bhUtils,
        myBeeId,
        moveTarget) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/move/" + myBeeId.id;

        // Build-out query parameters. Note that this is a simple example
        // meant to highlight Beehive code, not javascript best practices.
        // ====
        // Parameter name: conflictresolutionmode
        // Description: null
        // Mandatory: true
        // Values: OVERWRITE, ABORT, CREATE_UNIQUE, VERSION_OVERWRITE
        // ====
        // ====
        // Parameter name: target
        // Description: null
        // Mandatory: true
        // ====
        resourceURI += "?" +
            "target=" + moveTarget.id +
            "&conflictresolutionmode=ABORT";

        // 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 204 is considered an error
        if (xmlHttpRequest.status != 204) {
            // 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;
        }
        return;
    }

Move Batch

Moves the given group contacts to the target address book.

URI: /comb/v1/d/gcon/move

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
destination	Query		The target address book where the group contact needs to be moved.
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<groupContact>

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

Sample: (expand)

    // *
    // * This function demonstates moving several GroupContact items.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId1" - beeId of an item to move
    // * @param "myBeeId2" - beeId of an item to move
    // * @param "myBeeId3" - beeId of an item to move
    // * @param "moveTarget" - Destination of the move
    // *
    // * @return This function does not return anything
    // *
    moveBatch: function(
        bhUtils,
        myBeeId1,
        myBeeId2,
        myBeeId3,
        moveTarget) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/move";

        // Build-out query parameters. Note that this is a simple example
        // meant to highlight Beehive code, not javascript best practices.
        // ====
        // Parameter name: conflictresolutionmode
        // Description: null
        // Mandatory: true
        // Values: OVERWRITE, ABORT, CREATE_UNIQUE, VERSION_OVERWRITE
        // ====
        // ====
        // Parameter name: target
        // Description: null
        // Mandatory: true
        // ====
        resourceURI += "?" +
            "target=" + moveTarget.id +
            "&conflictresolutionmode=ABORT";

        // Create list of IDs to move
        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 204 is considered an error
        if (xmlHttpRequest.status != 204) {
            // 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;
        }
        return;
    }

Move Batch to Trash

Moves one or more GroupContact objects from their current location into the Beehive Trash. Returns the IDs of the Trash Items resulting from the operation.

URI: /comb/v1/d/gcon/trash

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY EMPTY_WITH_DELETEDENTITY FULL META	Projection with which trash items are 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: beeIdList<groupContact>

Response Payload: list<trashItem>

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 deleting several GroupContact items.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId1" - beeId of an item to trash
    // * @param "myBeeId2" - beeId of an item to trash
    // * @param "myBeeId3" - beeId of an item to trash
    // *
    // *
    trashBatch: function(
        bhUtils,
        myBeeId1,
        myBeeId2,
        myBeeId3) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/trash";

        // Create list of IDs to trash
        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;
    }

Move to Trash

Move a single GroupContact object into the Trash.

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		Delete mode
projection	Query	Restricted to: BASIC EMPTY EMPTY_WITH_DELETEDENTITY FULL META	Projection with which the trash item is 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

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

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

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC BASIC_WITH_MEMBERS EMPTY EMPTY_WITH_ALL_ADDRESSES EMPTY_WITH_DEFAULT_ADDRESSES EMPTY_WITH_PRIMARY_ADDRESS FULL META	The projection specifying the attributes to be loaded for the group contact.
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: groupContact

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

Sample: (expand)

    // *
    // * This function demonstates reading a single GroupContact 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/gcon/" + 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 Attachment

Read the content of an attachment. Unlike many other access points in the API, the returned data is not structured data in XML/JSON format. The returned data is the streamed contents of a given attachment.

URI: /comb/v1/d/gcon/attachment/{id}

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
streamid	Query		The content stream id of an attachment
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
400	Required query parameter not specified
406	Unsupported value in Accept header
500	Internal error occurred

Read Batch

Retrieves one or more GroupContact objects from the server

URI: /comb/v1/d/gcon/read

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC BASIC_WITH_MEMBERS EMPTY EMPTY_WITH_ALL_ADDRESSES EMPTY_WITH_DEFAULT_ADDRESSES EMPTY_WITH_PRIMARY_ADDRESS FULL META	The projection specifying the attributes to be loaded for the group contacts.
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<groupContact>

Response Payload: list<groupContact>

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 reading several GroupContact 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/gcon/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/gcon/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/gcon/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

Undeletes/restores the deleted group contact.

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

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
new_name	Query		The undelete mode.
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

Sample: (expand)

    // *
    // * This function demonstates undeleting a single GroupContact item.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId" - beeId of an item to undelete
    // * @param "newlocation" - Location where undeleted item is to be restored
    // *
    // * @return The undeleted item
    // *
    undelete: function(
        bhUtils,
        myBeeId,
        newlocation) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/undelete/" + myBeeId.id;

        // Build-out query parameters. Note that this is a simple example
        // meant to highlight Beehive code, not javascript best practices.
        // ====
        // Parameter name: newlocation
        // Description: null
        // Mandatory: false
        // ====
        // ====
        // Parameter name: newname
        // Description: null
        // Mandatory: false
        // ====
        resourceURI += "?newlocation=" +
            newlocation.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);

        // 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;
    }

Undelete Batch

Undeletes/restores the deleted group contacts.

URI: /comb/v1/d/gcon/undelete

HTTP Method: POST

Request Parameters: (expand)

Name	Style	Required	Description
new_name	Query		The undelete mode.
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<groupContact>

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

Sample: (expand)

    // *
    // * This function demonstates undeleting several GroupContact items.
    // *
    // * @param "bhUtils" - Helper object
    // * @param "myBeeId1" - beeId of an item to undelete
    // * @param "myBeeId2" - beeId of an item to undelete
    // * @param "myBeeId3" - beeId of an item to undelete
    // * @param "newlocation" - Location where the undelete items to be restored
    // *
    // * @return An array containing the undeleted items
    // *
    undeleteBatch: function(
        bhUtils,
        myBeeId1,
        myBeeId2,
        myBeeId3,
        newlocation) {
        // The URI for this resource
        var resourceURI = "/comb/v1/d/gcon/undelete";

        // Build-out query parameters. Note that this is a simple example
        // meant to highlight Beehive code, not javascript best practices.
        // ====
        // Parameter name: newlocation
        // Description: null
        // Mandatory: false
        // ====
        // ====
        // Parameter name: newname
        // Description: null
        // Mandatory: false
        // ====
        resourceURI += "?newlocation=" +
            newlocation.id;

        // Create list of IDs to undelete
        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;
    }

Update

Update groupContact. Attachments could, optionally, be updated too.

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

HTTP Method: PUT

Request Parameters: (expand)

Name	Style	Required	Description
snapshotid	Query		The update mode
uploadscope	Query		The upload scope string used while uploading the associated content and/or attachment(s)
projection	Query	Restricted to: BASIC BASIC_WITH_MEMBERS EMPTY EMPTY_WITH_ALL_ADDRESSES EMPTY_WITH_DEFAULT_ADDRESSES EMPTY_WITH_PRIMARY_ADDRESS FULL META	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: groupContactUpdater

Response Payload: groupContact

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

Sample: (expand)

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

        var updater = {
            "beeType": "groupContactUpdater",
            "groupName": groupName
        };

        // 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;
    }