GET datastore/schemas

(Difference between revisions)
Jump to: navigation, search
 
Line 1: Line 1:
−
#REDIRECT [[GET datastore/schemas PT-BR]]
+
== Description ==
 +
 
 +
Retorna todos os Schemas do Marketing Account.
 +
 
 +
== Resource URL ==
 +
 
 +
  GET https://api.socialidnow.com/v1/marketing/datastore/schemas
 +
 
 +
== Authentication ==
 +
 
 +
Esta API exige autenticação do Marketing Account. Ver [[Authentication]].
 +
 
 +
== Response ==
 +
 
 +
==== Response Status ====
 +
{|
 +
! align="left" width="200px" | ok (200)
 +
| A busca foi realizada com sucesso
 +
|+
 +
! align="left" width="200px" | unauthorized (401)
 +
| A autenticação está errada. Ver [[Authentication]].
 +
|+
 +
! align="left" width="200px" | internal_server_error (500)
 +
| Um erro desconhecido ocorreu.
 +
|}
 +
 
 +
==== Response Body ====
 +
 
 +
Uma busca efetuada com sucesso retorna os seguintes campos:
 +
 
 +
{|
 +
! align="left" width="200px" | total
 +
| o número total de schemas encontrados.
 +
|+
 +
! align="left" width="200px" | count
 +
| o número de schemas retornados na página.
 +
|+
 +
! align="left" width="200px" | offset
 +
| o número de schemas descartados inicialmente (início da página).
 +
|+
 +
! align="left" width="200px" | results
 +
| um array contendo os detalhes dos schemas encontrados.
 +
|}
 +
 
 +
== Example Request ==
 +
 
 +
curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas' \
 +
-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": [
 +
      {
 +
        "name": "First Schema",
 +
        "fields": [
 +
          {
 +
            "name": "first_field",
 +
            "type": "string"
 +
          },
 +
          {
 +
            "name": "second_field",
 +
            "type": "integer"
 +
          }
 +
        ]
 +
        "created_at": "2014-10-24T12:15:00Z",
 +
        "updated_at": "2014-10-24T12:15:00Z",
 +
      },
 +
      { ... }
 +
    ]
 +
  }

Revision as of 12:53, 3 November 2014

Contents

Description

Retorna todos os Schemas do Marketing Account.

Resource URL 

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

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.
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 schemas encontrados.
count o número de schemas retornados na página.
offset o número de schemas descartados inicialmente (início da página).
results um array contendo os detalhes dos schemas encontrados.

Example Request 

curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas' \
-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": [
      {
        "name": "First Schema",
        "fields": [
          {
            "name": "first_field",
            "type": "string"
          },
          {
            "name": "second_field",
            "type": "integer"
          }
        ]
        "created_at": "2014-10-24T12:15:00Z",
        "updated_at": "2014-10-24T12:15:00Z",
      },
      { ... }
    ]
 }
Retrieved from "https://dev.socialidnow.com/index.php?title=GET_datastore/schemas&oldid=1156"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox