Versions Compared

Version Old Version 1 New Version Current
Changes made by

Leo Barrameda

Leo Barrameda

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Request

HTTP ELEMENT

Value

URI

/rest/crud/1.0/$tableKey/$id or /rest/crud/1.0/$tableKey/$key

METHOD

PUT

Content-Type

application/json

BODY

name - name of the Data - REQUIRED

spaceKey - space where Data will be attached - REQUIRED

column.keys - This is the field defined on CREATE Table

SAMPLE

Code Block
{
    "name": "name3", 
	"spaceKey": "DEMO", 
	//json element name is base from column.key on database 
    "field-currency": 200, //currency must be a number 
    "field-number": "1", //number must be a number 
    "field-percent": "2", //percent must be a number
    "field-required": "required", //if field is required, should be required
    "field-checkbox": "false", // must be true/false 
    "field-ipaddress": "121212121", //must be a ipv4 ip-address
    "field-hyperlink": "https://google.com.ph?q=yes", // must be a http or https url 
    "field-type": {
    	"id": "56", // for field of type Type, id is mandatory/required
    	"name": "wtf"
    }
}

Response

HTTP ELEMENT

VALUE

BODY

Return JSON depends on the HTTP STATUS

HTTP STATUS CODEBODY200KeyDescriptionnamename

STATUS

BODY

200

id - id of the Data which is System Generated and cannot be change

key - key of the Data which is User Defined and cannot be change

name - name of the Data the same as what you put on the

requestspaceKeyspace

request

spaceKey - space where Data will be attached same as what you put on the

requestcolumn.keysThis

request

column.keys - This is the field

define

defined on CREATE TABLE same as what you put on the

request400KeyDescriptionerrormain

request

400

error - main category of the

errormessageerror message404

error

message - error message

404

Scenario and Possible Response

Scenario

Response

POSITIVE/Good Request

Code Block
{
    "field-percent": "2",
    "field-required": "required",
    "field-currency": "200",
    "field-checkbox": "false",
    "name": "name3",
    "key": "name3",
    "field-number": "1",
    "field-ipaddress": "121212121",
    "id": 61,
    "field-type": {
        "id": 56,
        "name": "name3"
    },
    "field-hyperlink": "https://google.com.ph?q=yes"
}

$key is not specify

Code Block
{
	"spaceKey": "DEMO",
	"name": "name3",
    "field-type": {
        "id": 56,
        "name": "name3"
    },
    "field-hyperlink": "https://google.com.ph?q=yes"
}

HTTP STATUS: 400

Code Block
{
    "error": "REQUIRED",
    "message": "key is required"
}

$key is not unique within the table

Code Block
{
    "error": "VALUE_NOT_VALID",
    "message": "key[sixth-entity] on table[name-one] already exist - key should be unique within a table"
}

$name is not specify

Code Block
{
	"spaceKey": "DEMO",
    "field-type": {
        "id": 56,
        "name": "name3"
    },
    "field-hyperlink": "https://google.com.ph?q=yes"
}

HTTP STATUS: 400

Code Block
{
    "error": "REQUIRED",
    "message": "name is required"
}

$spaceKey is not specified

Code Block
{
	"name": "Row 1st",
    "field-type": {
        "id": 56,
        "name": "name3"
    },
    "field-hyperlink": "https://google.com.ph?q=yes"
}

HTTP STATUS: 400

Code Block
{
    "error": "REQUIRED",
    "message": "spaceKey is required"
}

$spaceKey is non-existing

HTTP STATUS: 400

Code Block
{
    "error": "NON_EXISTING",
    "message": "Space[DEM] does not exists"
}

$tableKey is non-existing

HTTP STATUS: 404

Code Block

HTTP STATUS: 404

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

row is non-existing

$row[0].id is non-existing

Code Block
{
    "name": "second Entity",
    "key": "sixthz-entity",
    "field-fk": [{
    	"id": "14700"
    }],
    "spaceKey": "CIA2"
}

Code Block
{
    "error": "VALUE_NOT_VALID",
    "message": "value.id[14700] of field[field-fk] refer to non-existing Row"
}

$row[0].key is non-existing

Code Block
{
    "name": "second Entity",
    "key": "sixthz-entity",
    "field-fk": [{
    	"key": "keyvalue1"
    }],
    "spaceKey": "CIA2"
}

Code Block
{
    "error": "VALUE_NOT_VALID",
    "message": "value.id[keyvalue1] of field[field-fk] refer to non-existing Row"
}

$row identified by id or key existing but it’s Table is not the same as defined in the Column

Code Block
{
    "name": "second Entity",
    "key": "sixthz-entity",
    "field-fk": [{
    	"id": "19104",
    	"key": "open"
    }],
    "spaceKey": "CIA2"
}

Code Block
{
    "error": "VALUE_NOT_VALID",
    "message": "value.id[19104] entity type doesn't match with what is defined."
}

column is required

Code Block
{
    "name": "second Entity",
    "key": "sixthzz-entity",
    "spaceKey": "CIA2"
}
Code Block
{
    "error": "REQUIRED",
    "message": "
Not Found
field-required is required"
}

  • field-required is the column name mark as Required