POST datastore/schemas/:schema name/objects

(Difference between revisions)
Jump to: navigation, search
 
Line 1: Line 1:
−
#REDIRECT [[POST datastore/schemas/:schema name/objects PT-BR]]
+
== Description ==
 +
 
 +
Cria um novo Object para um Schema.
 +
 
 +
== Resource URL ==
 +
 
 +
  POST https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects
 +
 
 +
== Parameters ==
 +
 
 +
{|
 +
! align="left" width="200px"  | schema_name (url)
 +
| width="200px" | obrigatório
 +
| nome do schema
 +
|-
 +
! align="left" width="200px"  | object
 +
| width="200px" | obrigatório
 +
| um hash no formato campo:valor, contendo os campos necessários para criação do object:
 +
|-
 +
! align="left" width="200px"  style="padding-left: 20px" | user_id
 +
| width="200px" | obrigatório
 +
| identificador do usuário
 +
|-
 +
! align="left" width="200px"  style="padding-left: 20px" | [fields]
 +
| width="200px" | opcional
 +
| campos customizados definidos no schema
 +
|}
 +
 
 +
== Authentication ==
 +
 
 +
Esta API exige autenticação do Marketing Account. Ver [[#Authentication|Autenticação]].
 +
 
 +
== Response ==
 +
 
 +
==== Response Status ====
 +
{|
 +
! align="left" width="200px" | created (201)
 +
| O object foi criado com sucesso.
 +
|+
 +
! align="left" width="200px" | bad_request (400)
 +
| Algum parâmetro obrigatório não foi informado.
 +
|+
 +
! align="left" width="200px" | unauthorized (401)
 +
| A autenticação está errada. Ver [[#Authentication|Autenticação]].
 +
|+
 +
! align="left" width="200px" | not_found (404)
 +
| O schema não foi encontrado.
 +
|+
 +
! align="left" width="200px" | unprocessable_entity (422)
 +
| Erro de validação no campo "object".
 +
|+
 +
! align="left" width="200px" | internal_server_error (500)
 +
| Um erro desconhecido ocorreu.
 +
|}
 +
 
 +
== Example Request ==
 +
 
 +
Cria um novo object para o schema com nome "first_schema".
 +
 
 +
curl -iX POST 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \
 +
-d '{
 +
      "object": {
 +
        "user_id": 340,
 +
        "first_field": "First Object",
 +
        "second_field": 123
 +
      }
 +
    }' \
 +
-H 'Content-type: application/json' \
 +
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
 +
 
 +
Response:
 +
 
 +
HTTP/1.1 201 Created
 +
Location: 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects/54481188e5cb7cffe4000003'
 +
Status: 201

Revision as of 13:02, 3 November 2014

Contents

Description

Cria um novo Object para um Schema.

Resource URL 

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

Parameters

schema_name (url) obrigatório nome do schema
object obrigatório um hash no formato campo:valor, contendo os campos necessários para criação do object:
user_id obrigatório identificador do usuário
[fields] opcional campos customizados definidos no schema

Authentication

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

Response

Response Status

created (201) O object foi criado com sucesso.
bad_request (400) Algum parâmetro obrigatório não foi informado.
unauthorized (401) A autenticação está errada. Ver Autenticação.
not_found (404) O schema não foi encontrado.
unprocessable_entity (422) Erro de validação no campo "object".
internal_server_error (500) Um erro desconhecido ocorreu.

Example Request

Cria um novo object para o schema com nome "first_schema". 

curl -iX POST 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \
-d '{
      "object": {
        "user_id": 340,
        "first_field": "First Object",
        "second_field": 123
      }
    }' \
-H 'Content-type: application/json' \
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf

Response: 

HTTP/1.1 201 Created
Location: 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects/54481188e5cb7cffe4000003'
Status: 201
Retrieved from "https://dev.socialidnow.com/index.php?title=POST_datastore/schemas/:schema_name/objects&oldid=1180"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox