Jump to

• Request
• Response

Get Rows

get

/mobile/platform/database/objects/{table}

Retrieves a set of rows from the table. You can filter which columns and rows to include in the response.

The Database_MaxRows environment policy restricts the number of rows that MCS returns for this request. The default value is 1000. Ensure that this policy is set to a value that's sufficient for your needs. If your request doesn't return all the rows that you expected, ask your mobile cloud administrator to increase the Database_MaxRows value.

For security reasons, you can call this operation only from custom API implementations by using the custom code SDK. You can't make direct requests from client applications. This API is included in this reference merely to describe the request and response bodies for the custom code SDK calls.

Request

Path Parameters

• table: string
  The name of the database table.

Query Parameters

• column-name(optional): string

  When you want to filter which rows to retrieve, use the column name for the parameter. When present, only the rows where the named column equals the supplied value are returned. Otherwise, it returns all the rows in the table. You can have multiple column-name parameters. For example, if the URI is /mobile/platform/database/objects/Movies?director=Allan+Smithee&year=1992, then only the movies that Allan Smithee directed and that were released in 1992 are included in the response.

• fields(optional): string

  Use this parameter to specify which columns to include in the response. If this query parameter is not included in the request, then all columns are returned. For example, if the URI is /mobile/platform/database/objects/Movies?fields=director,title,total_gross, then the response will include only the director, title, and total_gross columns.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : Row Items

Type: object

Title: Row Items

Show Source

• items(optional): array Table Data
  Title: Table Data

  Minimum Number of Items: 1

  Unique Items Required: true

{
    "title":"Row Items",
    "properties":{
        "items":{
            "$ref":"#/definitions/tableData"
        }
    },
    "type":"object"
}

Nested Schema : Table Data

Type: array

Title: Table Data

Minimum Number of Items: 1

Unique Items Required: true

Show Source

• Array of: object Columns
  Title: Columns

  Additional Properties Allowed: additionalProperties

  Column names and values. For example `{ "title" : "The Imitation Game"}`. String values can't exceed 4000 characters. Binary types aren't supported.

{
    "title":"Table Data",
    "items":{
        "$ref":"#/definitions/rowData"
    },
    "minItems":1,
    "uniqueItems":true,
    "type":"array"
}

Nested Schema : Columns

Type: object

Title: Columns

Additional Properties Allowed

Show Source

• string

{
    "title":"Columns",
    "description":"Column names and values. For example `{ \"title\" : \"The Imitation Game\"}`. String values can't exceed 4000 characters. Binary types aren't supported.",
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}

Column names and values. For example `{ "title" : "The Imitation Game"}`. String values can't exceed 4000 characters. Binary types aren't supported.

Example Response (application/json)

{
    "items":[
        {
            "title":"The Imitation Game"
        }
    ]
}

Back to Top