SystemActor

Read

Retreive a single SystemActor.

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

HTTP Method: GET

Request Parameters: (expand)

Name	Style	Required	Description
projection	Query	Restricted to: BASIC EMPTY EMPTY_WITH_ALL_ADDRESSES EMPTY_WITH_ASSIGNED_ROLES EMPTY_WITH_DEFAULT_ADDRESSES EMPTY_WITH_GROUPS EMPTY_WITH_PREFERENCES EMPTY_WITH_PRIMARY_ADDRESS EMPTY_WITH_PROPERTIES EMPTY_WITH_SNAPSHOTID FULL META SECURITY	a projection to use
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: systemActor

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 SystemActor 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/syac/" + 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;
    }