GET datastore/schemas/:schema name

(Difference between revisions)
Jump to: navigation, search
 
Line 1: Line 1:
−
#REDIRECT [[GET datastore/schemas/:schema name PT-BR]]
+
== Description ==
 +
 
 +
Retorna um Schema específico.
 +
 
 +
== Resource URL ==
 +
 
 +
  GET https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name
 +
 
 +
== Parameters ==
 +
 
 +
{|
 +
! align="left" width="200px"  | schema_name
 +
| width="200px" | obrigatório
 +
| nome do schema
 +
|}
 +
 
 +
== 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 não foi encontrado.
 +
|+
 +
! align="left" width="200px" | internal_server_error (500)
 +
| Um erro desconhecido ocorreu.
 +
|}
 +
 
 +
==== Response Body ====
 +
 
 +
{|
 +
! align="left" width="200px" | name
 +
| nome do schema.
 +
|+
 +
! align="left" width="200px" | fields
 +
| array de hashes contendo a descrição dos fields:
 +
|+
 +
! align="left" width="200px" style="padding-left: 20px" | name
 +
| nome do field
 +
|+
 +
! align="left" width="200px" style="padding-left: 20px" | type
 +
| tipo do field
 +
|+
 +
! align="left" width="200px" | created_at
 +
| data de criação do schema.
 +
|+
 +
! align="left" width="200px" | updated_at
 +
| data da atualização mais recente do schema.
 +
|}
 +
 
 +
== Example Request ==
 +
 
 +
Retorna as informações do schema com nome "first_schema".
 +
 
 +
curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \
 +
-H 'Content-type: application/json' \
 +
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
 +
 
 +
Response:
 +
 
 +
HTTP/1.1 200 Ok
 +
Status: 200
 +
 
 +
== Example Response ==
 +
 
 +
{
 +
  "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 13:00, 3 November 2014

Contents

Description

Retorna um Schema específico.

Resource URL 

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

Parameters

schema_name obrigatório nome do schema

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 não foi encontrado.
internal_server_error (500) Um erro desconhecido ocorreu.

Response Body

name nome do schema.
fields array de hashes contendo a descrição dos fields:
name nome do field
type tipo do field
created_at data de criação do schema.
updated_at data da atualização mais recente do schema.

Example Request

Retorna as informações do schema com nome "first_schema". 

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

Response: 

HTTP/1.1 200 Ok
Status: 200

Example Response 

{
  "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/:schema_name&oldid=1176"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox