GET datastore/schemas/:schema name/objects/:id
(Difference between revisions)
(moved GET datastore/schemas/:schema name/objects/:id to GET datastore/schemas/:schema name/objects/:id PT-BR) |
|||
Line 1: | Line 1: | ||
− | + | == Description == | |
+ | |||
+ | Retorna um Object específico. | ||
+ | |||
+ | == Resource URL == | ||
+ | |||
+ | GET https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects/:id | ||
+ | |||
+ | == Parameters == | ||
+ | |||
+ | {| | ||
+ | ! align="left" width="200px" | schema_name | ||
+ | | width="200px" | obrigatório | ||
+ | | nome do schema | ||
+ | |- | ||
+ | ! align="left" width="200px" | id | ||
+ | | width="200px" | obrigatório | ||
+ | | identificador do object | ||
+ | |} | ||
+ | |||
+ | == Authentication == | ||
+ | |||
+ | Esta API exige autenticação do Marketing Account. Ver [[Authentication]]. | ||
+ | |||
+ | == Response == | ||
+ | |||
+ | ==== Response Status ==== | ||
+ | {| | ||
+ | ! align="left" width="200px" | ok (200) | ||
+ | | A requisição foi realizada com sucesso | ||
+ | |+ | ||
+ | ! align="left" width="200px" | unauthorized (401) | ||
+ | | A autenticação está errada. Ver [[Authentication]]. | ||
+ | |+ | ||
+ | ! align="left" width="200px" | not_found (404) | ||
+ | | O schema ou o object não foi encontrado. | ||
+ | |+ | ||
+ | ! align="left" width="200px" | internal_server_error (500) | ||
+ | | Um erro desconhecido ocorreu. | ||
+ | |} | ||
+ | |||
+ | ==== Response Body ==== | ||
+ | |||
+ | {| | ||
+ | ! align="left" width="200px" | object_id | ||
+ | | identificador do object. | ||
+ | |+ | ||
+ | ! align="left" width="200px" | user_id | ||
+ | | identificador do usuário. | ||
+ | |+ | ||
+ | ! align="left" width="200px" | created_at | ||
+ | | data de criação do object. | ||
+ | |+ | ||
+ | ! align="left" width="200px" | updated_at | ||
+ | | data da atualização mais recente do object. | ||
+ | |+ | ||
+ | ! align="left" width="200px" | [fields] | ||
+ | | campos customizados definidos no schema. | ||
+ | |} | ||
+ | |||
+ | == Example Request == | ||
+ | |||
+ | Retorna as informações do object "54481188e5cb7cffe4000003" do schema com nome "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: | ||
+ | |||
+ | HTTP/1.1 200 Ok | ||
+ | Status: 200 | ||
+ | |||
+ | == Example Response == | ||
+ | |||
+ | { | ||
+ | "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 | ||
+ | } |
Revision as of 13:02, 3 November 2014
Contents |
Description
Retorna um Object específico.
Resource URL
GET https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects/:id
Parameters
schema_name | obrigatório | nome do schema |
---|---|---|
id | obrigatório | identificador do object |
Authentication
Esta API exige autenticação do Marketing Account. Ver Authentication.
Response
Response Status
ok (200) | A requisição foi realizada com sucesso | unauthorized (401) | A autenticação está errada. Ver Authentication. | not_found (404) | O schema ou o object não foi encontrado. | internal_server_error (500) | Um erro desconhecido ocorreu. |
---|
Response Body
object_id | identificador do object. | user_id | identificador do usuário. | created_at | data de criação do object. | updated_at | data da atualização mais recente do object. | [fields] | campos customizados definidos no schema. |
---|
Example Request
Retorna as informações do object "54481188e5cb7cffe4000003" do schema com nome "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:
HTTP/1.1 200 Ok Status: 200
Example Response
{ "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 }