GET datastore/schemas/:schema name/objects

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
== Description ==
 
== Description ==
  
−
Retorna todos os Objects de um Schema.
+
Returns all Objects from a Schema.
  
 
== 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" | obrigatório
+
| width="200px" | required
−
| nome do schema
+
| schema name.
 
|-
 
|-
 
! align="left" width="200px"  | user_id
 
! align="left" width="200px"  | user_id
−
| width="200px" | opcional
+
| width="200px" | optional
−
| identificador de um usuário para filtrar os resultados
+
| user identifier to filter results.
 
|}
 
|}
  
 
== Authentication ==
 
== Authentication ==
  
−
Esta API exige autenticação do Marketing Account. Ver [[Authentication]].
+
This API requires Marketing Account authentication. See [[Authentication]].
  
 
== Response ==
 
== Response ==
  
−
==== Response Status ====
+
=== Response Status ===
 
{|
 
{|
 
! align="left" width="200px" | ok (200)
 
! align="left" width="200px" | ok (200)
−
| A busca foi realizada com sucesso
+
| The search was performed successfully.
−
|+
+
|-
 
! align="left" width="200px" | unauthorized (401)
 
! align="left" width="200px" | unauthorized (401)
−
| A autenticação está errada. Ver [[Authentication]].
+
| The authentication is wrong. See [[Authentication]].
−
|+
+
|-
 
! align="left" width="200px" | not_found (404)
 
! align="left" width="200px" | not_found (404)
−
| O schema não foi encontrado.
+
| The schema was not found.
−
|+
+
|-
 
! align="left" width="200px" | internal_server_error (500)
 
! align="left" width="200px" | internal_server_error (500)
−
| Um erro desconhecido ocorreu.
+
| An unknown error happened.
 
|}
 
|}
  
−
==== Response Body ====
+
=== Response Body ===
  
−
Uma busca efetuada com sucesso retorna os seguintes campos:
+
A successful search returns the following fields:
  
 
{|
 
{|
 
! align="left" width="200px" | total
 
! align="left" width="200px" | total
−
| o número total de objects encontrados.
+
| total amount of objects found.
−
|+
+
|-
 
! align="left" width="200px" | count
 
! align="left" width="200px" | count
−
| o número de objects retornados na página.
+
| amount of objects returned in this page.
−
|+
+
|-
 
! align="left" width="200px" | offset
 
! align="left" width="200px" | offset
−
| o número de objects descartados inicialmente (início da página).
+
| amount of discarded objects (page start).
−
|+
+
|-
 
! align="left" width="200px" | results
 
! align="left" width="200px" | results
−
| um array contendo os detalhes dos objects encontrados.
+
| array with object details.
 
|}
 
|}
  
−
== Example Request ==
+
== Examples ==
  
−
Retorna todos objects do schema com nome "first_schema".
+
=== Request ===
 +
 
 +
Returns all objects from the schema named "first_schema".
  
 
  curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \
 
  curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \
Line 66: Line 70:
 
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
 
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
  
−
Response:
+
=== Response ===
 +
 
 +
==== Response Headers ====
  
 
  HTTP/1.1 200 Ok
 
  HTTP/1.1 200 Ok
 
  Status: 200
 
  Status: 200
  
−
== Example Response ==
+
==== Response Body ====
  
 
  {
 
  {

Revision as of 16:06, 3 November 2014

Contents

Description

Returns all Objects from a Schema.

Resource URL 

  GET https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects

Parameters

URL Parameters

schema_name required schema name.
user_id optional user identifier to filter results.

Authentication

This API requires Marketing Account authentication. See Authentication.

Response

Response Status

ok (200) The search was performed successfully.
unauthorized (401) The authentication is wrong. See Authentication.
not_found (404) The schema was not found.
internal_server_error (500) An unknown error happened.

Response Body

A successful search returns the following fields:

total total amount of objects found.
count amount of objects returned in this page.
offset amount of discarded objects (page start).
results array with object details.

Examples

Request

Returns all objects from the schema named "first_schema". 

curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \
-H 'Content-type: application/json' \
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf

Response

Response Headers 

HTTP/1.1 200 Ok
Status: 200

Response Body 

{
  "total": 2,
  "count": 2,
  "offset": 0,
  "results": [
    {
      "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
    },
    { ... }
  ]
}
Retrieved from "https://dev.socialidnow.com/index.php?title=GET_datastore/schemas/:schema_name/objects&oldid=1254"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox