ds.get REST

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 33 Next »

 Table of Contents

Retrieves an object data from Gigya's Data Store.

Note: If you plan on integrating the DS, we highly recommend reading the Data Store Guide.
The DS is a premium platform that requires separate activation. If the DS is not part of your site package please contact your Gigya Account Manager or email support@gigya-inc.com.


Request URL

Where <Data_Center> is:
  • us1.gigya.com - For the US data center.
  • eu1.gigya.com - For the European data center.
  • au1.gigya.com - For the Australian data center.
  • ru1.gigya.com - For the Russian data center.
  • cn1.gigya-api.cn - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.



Required Name Type Description
Required oid string The ID of the object to retrieve.
  type string  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.
Optional fields string A 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.
  UID string If 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.
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 


Response Data

Field Type Description
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
statusReason string A brief explanation of the status code.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or



data JSON object The object data retrieved from Gigya's Data Store.
oid string The ID of the object
UID string If the object is associate with a user, then the ID of the user.
lastUpdated long The time of the latest change in this object, in Java time (number of milliseconds since Jan. 1st 1970).
lastUpdatedTime string The time of the latest change in this object, in ISO 8601 format.
created long The time of this object's creation, in Java time (number of milliseconds since Jan. 1st 1970).
createdTime string The time of this object's creation, in ISO 8601 format.


Response Example


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


  • No labels