GET datastore/schemas/:schema name/objects/:id
(Difference between revisions)
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| − | + | Returns a specific Object. | |
== Resource URL == | == Resource URL == | ||
| Line 8: | Line 8: | ||
== Parameters == | == Parameters == | ||
| + | |||
| + | === URL Parameters === | ||
{| | {| | ||
! align="left" width="200px" | schema_name | ! align="left" width="200px" | schema_name | ||
| − | | width="200px" | | + | | width="200px" | required |
| − | | | + | | schema name. |
|- | |- | ||
! align="left" width="200px" | id | ! align="left" width="200px" | id | ||
| − | | width="200px" | | + | | width="200px" | required |
| − | | | + | | object identifier. |
|} | |} | ||
== Authentication == | == Authentication == | ||
| − | + | This API requires Marketing Account authentication. See [[Authentication]]. | |
== Response == | == Response == | ||
| − | + | === Response Status === | |
{| | {| | ||
! align="left" width="200px" | ok (200) | ! align="left" width="200px" | ok (200) | ||
| − | | | + | | The request was successful. |
| − | | | + | |- |
! align="left" width="200px" | unauthorized (401) | ! align="left" width="200px" | unauthorized (401) | ||
| − | | | + | | The authentication is wrong. See [[Authentication]]. |
| − | | | + | |- |
! align="left" width="200px" | not_found (404) | ! align="left" width="200px" | not_found (404) | ||
| − | | | + | | Schema or object not found. |
| − | | | + | |- |
! align="left" width="200px" | internal_server_error (500) | ! align="left" width="200px" | internal_server_error (500) | ||
| − | | | + | | An unknown error happened. |
|} | |} | ||
| − | + | === Response Body === | |
{| | {| | ||
! align="left" width="200px" | object_id | ! align="left" width="200px" | object_id | ||
| − | | | + | | object identifier. |
| − | | | + | |- |
! align="left" width="200px" | user_id | ! align="left" width="200px" | user_id | ||
| − | | | + | | user identifier. |
| − | | | + | |- |
! align="left" width="200px" | created_at | ! align="left" width="200px" | created_at | ||
| − | | | + | | date of object creation. |
| − | | | + | |- |
! align="left" width="200px" | updated_at | ! align="left" width="200px" | updated_at | ||
| − | | | + | | date of object latest update. |
| − | | | + | |- |
! align="left" width="200px" | [fields] | ! align="left" width="200px" | [fields] | ||
| − | | | + | | custom fields defined in the schema. |
|} | |} | ||
| − | == | + | == Examples == |
| − | + | === Request === | |
| + | |||
| + | Returns information of the object "54481188e5cb7cffe4000003" from the schema named "first_schema". | ||
curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects/54481188e5cb7cffe4000003' \ | curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects/54481188e5cb7cffe4000003' \ | ||
| Line 67: | Line 71: | ||
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | ||
| − | Response | + | === Response === |
| + | |||
| + | ==== Response Headers ==== | ||
HTTP/1.1 200 Ok | HTTP/1.1 200 Ok | ||
Status: 200 | Status: 200 | ||
| − | == | + | ==== Response Body ==== |
{ | { | ||
Revision as of 16:17, 3 November 2014
Contents |
Description
Returns a specific Object.
Resource URL
GET https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects/:id
Parameters
URL Parameters
| schema_name | required | schema name. |
|---|---|---|
| id | required | object identifier. |
Authentication
This API requires Marketing Account authentication. See Authentication.
Response
Response Status
| ok (200) | The request was successful. |
|---|---|
| unauthorized (401) | The authentication is wrong. See Authentication. |
| not_found (404) | Schema or object not found. |
| internal_server_error (500) | An unknown error happened. |
Response Body
| object_id | object identifier. |
|---|---|
| user_id | user identifier. |
| created_at | date of object creation. |
| updated_at | date of object latest update. |
| [fields] | custom fields defined in the schema. |
Examples
Request
Returns information of the object "54481188e5cb7cffe4000003" from the schema named "first_schema".
curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects/54481188e5cb7cffe4000003' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{
"object_id": "54481188e5cb7cffe4000003",
"user_id": 340,
"created_at": "2014-10-24T14:48:00Z",
"updated_at": "2014-10-24T14:48:00Z",
"first_field": "First Object",
"second_field": 123
}
