Jump to

• Request
• Response
• Examples

View data record collections

get

/gsdata/v1/{appName}/data

Returns the data record collections currently setup for this application.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The record collections and their URL's.

Body ()

Root Schema : RecordCollectionList

Type: object

Represents a list of guided search record collections.

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RecordCollectionItem"
            }
        },
        "rsDigest":{
            "type":"string"
        }
    },
    "description":"Represents a list of guided search record collections."
}

Nested Schema : items

Type: array

Show Source

• Array of: object RecordCollectionItem
  Represents a guided search record collection.

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

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 : RecordCollectionItem

Type: object

Represents a guided search record collection.

Show Source

• links(optional): array links
• name(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Represents a guided search record collection."
}

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 : 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 the data record collections currently setup for the cloud application:

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

Back to Top