GET datastore/schemas/:schema name

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
== Description ==
 
== Description ==
  
−
Retorna um Schema específico.
+
Returns a specific 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.
 
|}
 
|}
  
 
== 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 requisição foi realizada com sucesso
+
| The request was successful.
−
|+
+
|-
 
! 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 ===
  
 
{|
 
{|
−
! align="left" width="200px" | name
+
! align="left" width="180px" | name
−
| nome do schema.
+
| schema name.
−
|+
+
|-
−
! align="left" width="200px" | fields
+
! align="left" width="180px" | fields
−
| array de hashes contendo a descrição dos fields:
+
| array of hashes with fields description:
−
|+
+
|-
−
! align="left" width="200px" style="padding-left: 20px" | name
+
! align="left" width="180px" style="padding-left: 20px" | name
−
| nome do field
+
| field name.
−
|+
+
|-
−
! align="left" width="200px" style="padding-left: 20px" | type
+
! align="left" width="180px" style="padding-left: 20px" | type
−
| tipo do field
+
| field type.
−
|+
+
|-
−
! align="left" width="200px" | created_at
+
! align="left" width="180px" | created_at
−
| data de criação do schema.
+
| date of schema creation.
−
|+
+
|-
−
! align="left" width="200px" | updated_at
+
! align="left" width="180px" | updated_at
−
| data da atualização mais recente do schema.
+
| date of schema latest update.
 
|}
 
|}
  
−
== Example Request ==
+
== Examples ==
  
−
Retorna as informações do schema com nome "first_schema".
+
=== Request ===
 +
 
 +
Returns information of the schema named "first_schema".
  
 
  curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \
 
  curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \
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 15:35, 3 November 2014

Contents

Description

Returns a specific Schema.

Resource URL 

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

Parameters

URL Parameters

schema_name required schema name.

Authentication

This API requires Marketing Account authentication. See Authentication.

Response

Response Status

ok (200) The request was successful.
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

name schema name.
fields array of hashes with fields description:
name field name.
type field type.
created_at date of schema creation.
updated_at date of schema latest update.

Examples

Request

Returns information of the schema named "first_schema". 

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

Response

Response Headers 

HTTP/1.1 200 Ok
Status: 200

Response Body 

{
  "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=1247"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox