GET ALL Data

REQUEST

HTTP ELEMENT

Value

URI

/rest/crud/1.0/$tableKey

METHOD

GET

QueryParams

item-per-page - limit of number of page returned by this resource - NOT REQUIRED - DEFAULT: 100

page-index - what page to display, identified by a number starts with 1 - NOT REQUIRED - DEFAULT: 1

?item-per-page=25&page-index=2 
//this will display items: 26 to 50 if total rows count is 125

RESPONSE

HTTP STATUS

BODY

200

currentItemCount - number of rows/item returned result set

itemsPerPage - number of rows per page, value is always the same as query string “item-per-page” in the request

startIndex - index of the first row of the returned result set

totalItems - total rows counts

pageIndex - index of the current page, the value is always the same as the query string “page-index” in the request

totalPages - total number of page

data - returned result set

404

{
    "error": "NOT FOUND",
    "message": "URL doesn't point to existing table"
}

SCENARIO

RESPONSE

POSITIVE

{
    "currentItemCount": 1,
    "itemsPerPage": 100,
    "startIndex": 1,
    "totalItems": 1,
    "pageIndex": 1,
    "totalPages": 1,
    "data": [
        {
            "field-integer": 2,
            "field-number": 2.05,
            "name": "Put Integer to Number = should be an error",
            "id": 3
        }
    ]
}

$tableKey is not found

$tableKey is not defined

STATUS CODE: 404

{
    "error": "NOT FOUND",
    "message": "URL doesn't point to existing table"
}