Page History

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
SEO Metadata

Retrieves an object or the specified datum from the Gigya Data Store.

Description

Retrieves an object's or the specified datum from Gigya's Data Store.

Include Page
Template_DS API activation note
Template_DS API activation note

 

Include Page
Template_gs rest api header url - ds
Template_gs rest api header url - ds

Parameters

RequiredNameTypeDescription
Yes
oidstringThe ID of the object to retrieve.
Yes
typestring A string indicating the type of the object, equivalent to a name classifying objects as being of the same type; used in searches and when applying schemas.
No
fieldsstringA comma separated list of fields to retrieve. Acceptable values for this parameter:
  • Data field names, specifying the the complete path, i.e. album.photo.photoTitle_t
  • Partial field names (fields that contain only a part of the path to sub-objects, i.e. album.photo) - indicate to retrieve everything below that path.
  • "*" - indicates to retrieve the entire stored object.
No
UIDstringIf the object is associate with a user, then the ID of the user should be specified and forms a compound key together with the oid.
If you call this method through an external OAuth2 SDK, then the UID may be passed implicitly within the access_token.
Include Page
Template_gs REST api common optional parameters new
Template_gs REST api common optional parameters new

Include Page
Template_gs rest api Auth parameters
Template_gs rest api Auth parameters

Sample Requests

HTML
<script>
var dsGetCodeExampleParams = {
	"api":"ds.get",
	"langs":"nojs",
	"useUserKey":false,
	"containerId":"dsGetCodeExampleContainer",
	"params": {
		"oid":"0123",
		"type":"closets"
	}
}
</script>
<div id="dsGetCodeExampleContainer"></div>

 

Include Page
Template_rest api header response
Template_rest api header response

FieldTypeDescription
Include Page
Template_gs REST api common response fields
Template_gs REST api common response fields
dataJSON objectThe object data retrieved from Gigya's Data Store.
oidstringThe ID of the object
UIDstringIf the object is associate with a user, then the ID of the user.
lastUpdatedlongThe time of the latest change in this object, in Java time (number of milliseconds since Jan. 1st 1970).
lastUpdatedTimestringThe time of the latest change in this object, in ISO 8601 format.
createdlongThe time of this object's creation, in Java time (number of milliseconds since Jan. 1st 1970).
createdTimestringThe time of this object's creation, in ISO 8601 format.

 

Include Page
Template_rest api header response xml
Template_rest api header response xml

Code Block
languagejs
linenumberstrue
{
        "data": {
            "BloodType": "A",
            "Dislikes": "Evil",
            "EyeColor": "Brown",
            "HairColor": "Brown",
            "Height": "179 cms",
            "Likes": "Justice",
            "Occupation": "QA",
            "Weight": "94.1 kgs"
        },
        "oid": "8b8972c3b3114db2a0acdfa2617693bf",
        "lastUpdatedTime": "2012-08-08T12:16:24Z",
        "lastUpdated": 1344428184385,
        "createdTime": "2012-08-08T12:16:24Z",
        "created": 1344428184385,
        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "d02ada709b494be18d47cab5a23c3470",
        "time": "2015-03-22T11:42:25.943Z"
    }

 

Include Page
LSSDK JS
LSSDK JS

Include Page
CEG EXT JS
CEG EXT JS

HTML
<script>
$(document).ready(function() {
    lssdk.tableFixer();
    lssdk.ceg.run(dsGetCodeExampleParams);
});
</script>