GET datastore/schemas/:schema name/objects

From Social ID Developers
Revision as of 13:01, 3 November 2014 by Gabriel.prado (Talk | contribs)
Jump to: navigation, search

Contents

Description

Retorna todos os Objects de um Schema.

Resource URL

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

Parameters

schema_name obrigatório nome do schema
user_id opcional identificador de um usuário para filtrar os resultados

Authentication

Esta API exige autenticação do Marketing Account. Ver Authentication.

Response

Response Status

ok (200) A busca foi realizada com sucesso
unauthorized (401) A autenticação está errada. Ver Authentication.
not_found (404) O schema não foi encontrado.
internal_server_error (500) Um erro desconhecido ocorreu.

Response Body

Uma busca efetuada com sucesso retorna os seguintes campos:

total o número total de objects encontrados.
count o número de objects retornados na página.
offset o número de objects descartados inicialmente (início da página).
results um array contendo os detalhes dos objects encontrados.

Example Request

Retorna todos objects do schema com nome "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:

HTTP/1.1 200 Ok
Status: 200

Example Response

{
  "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
    },
    { ... }
  ]
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox