/entityType
Return a JSON representation of an existing entityType.
URL
https://{yourdomain}.com/entityType
Request
| Parameter | Required | Description |
|---|---|---|
client_idstring | Yes | The client identifier. |
client_secretstring | Yes | The shared secret paired with the client_id. |
type_namestring | Yes | The name of the entityType. |
Example Response
https://yourdomain.com/entityType?type_name=Person&client_id=12345678912345678912345678912345&client_secret=98765432198765432198765432198765
Display the JSON representation of a Person entity.
{
"schema":
{ "attr_defs":[
{"name":"id", "type":"id"},
{"name":"lastUpdated","type":"version"},
{"name":"birthday", "type":"string", "length":10},
{"name":"zipcode", "type":"string", "length":5},
{"name":"name",
"type":"object",
"attr_defs":[ {"name":"id", "type":"id"},
{"name":"firstName","type":"string", "length":128},
{"name":"lastName", "type":"string", "length":128}
]
}
],
"name":"user"}
,
"stat":"ok"
}
Example Error Response
{"stat": "error",
"error": {
"code":...,
"msg":...,
}
}