PUT datastore/schemas/:schema name/objects/:id

(Difference between revisions)
Jump to: navigation, search
 
Line 1: Line 1:
−
#REDIRECT [[PUT datastore/schemas/:schema name/objects/:id PT-BR]]
+
== Description ==
 +
 
 +
Atualiza um Object.
 +
 
 +
== Resource URL ==
 +
 
 +
  PUT https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects/:id
 +
 
 +
== Parameters ==
 +
 
 +
{|
 +
! align="left" width="200px"  | schema_name (url)
 +
| width="200px" | obrigatório
 +
| nome do schema
 +
|-
 +
! align="left" width="200px"  | id (url)
 +
| width="200px" | obrigatório
 +
| identificador do object
 +
|-
 +
! align="left" width="200px"  | object (json)
 +
| width="200px" | obrigatório
 +
| um hash no formato campo:valor, contendo os campos necessários para atualização do object:
 +
|-
 +
! align="left" width="200px"  style="padding-left: 20px" | user_id
 +
| width="200px" | opcional
 +
| 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" | ok (200)
 +
| O object foi atualizado 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 ou o object 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 ==
 +
 
 +
Atualiza o object "54481188e5cb7cffe4000003" do schema com nome "first_schema".
 +
 
 +
curl -iX PUT 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects/54481188e5cb7cffe4000003' \
 +
-d '{
 +
      "object":{
 +
        "first_field":"New First Object",
 +
        "second_field:321
 +
      }
 +
    }'
 +
-H 'Content-type: application/json' \
 +
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
 +
 
 +
Response:
 +
 
 +
HTTP/1.1 200 Ok
 +
Status: 200

Revision as of 13:03, 3 November 2014

Contents

Description

Atualiza um Object.

Resource URL 

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

Parameters

schema_name (url) obrigatório nome do schema
id (url) obrigatório identificador do object
object (json) obrigatório um hash no formato campo:valor, contendo os campos necessários para atualização do object:
user_id opcional 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

ok (200) O object foi atualizado 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 ou o object não foi encontrado.
unprocessable_entity (422) Erro de validação no campo "object".
internal_server_error (500) Um erro desconhecido ocorreu.

Example Request

Atualiza o object "54481188e5cb7cffe4000003" do schema com nome "first_schema". 

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

Response: 

HTTP/1.1 200 Ok
Status: 200
Retrieved from "https://dev.socialidnow.com/index.php?title=PUT_datastore/schemas/:schema_name/objects/:id&oldid=1182"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox