Jump to

• Request
• Response
• Examples

View individual records

get

/gsdata/v1/{appName}/{recordCollectionType}/{recordCollection}/{recordId}

Returns a single record from the specified record collection if it exists or a corresponding error message.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".
• recordCollection: string
  Name of the record collection. A valid record collection name is defined by the regular expression "^[a-zA-Z0-9._-]+$" and cannot exceed 128 characters.
• recordCollectionType: string
  Type of record collection, can be either "data" or "dimvals".
• recordId: string
  id of the record

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The specified record.

Body ()

Root Schema : RecordList

Type: object

Represents a list of guided search records.

Show Source

• items(optional): array items
• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RecordItem"
            }
        }
    },
    "description":"Represents a list of guided search records."
}

Nested Schema : items

Type: array

Show Source

• Array of: object RecordItem
  Represents a record from a Guided Search record collection. As well as the properties listed below a record will also have 1 or more additional properties.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RecordItem"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Represents a link to a gsdata resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : RecordItem

Type: object

Represents a record from a Guided Search record collection. As well as the properties listed below a record will also have 1 or more additional properties.

Show Source

• record.action(optional): string
  Allowed Values: [ "upsert", "delete" ]
• record.collection(optional): string
• record.id(optional): string
• record.locale(optional): string
• record.urn(optional): string

{
    "type":"object",
    "properties":{
        "record.id":{
            "type":"string"
        },
        "record.action":{
            "type":"string",
            "enum":[
                "upsert",
                "delete"
            ]
        },
        "record.collection":{
            "type":"string"
        },
        "record.urn":{
            "type":"string"
        },
        "record.locale":{
            "type":"string"
        }
    },
    "description":"Represents a record from a Guided Search record collection. As well as the properties listed below a record will also have 1 or more additional properties."
}

Nested Schema : Link

Type: object

Represents a link to a gsdata resource.

Show Source

• href(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "description":"Represents a link to a gsdata resource."
}

Back to Top

Examples

The following example shows how to view a single record in the specified collection using the record ID:

curl -H "Authorization:Bearer <token>" -X GET http://host:port/gsdata/v1/cloud/data/buyingGuides/guide1001 

Back to Top