PUT datastore/schemas/:schema name
(Difference between revisions)
Line 1: | Line 1: | ||
− | # | + | == Description == |
+ | |||
+ | Atualiza um Schema. | ||
+ | |||
+ | == Resource URL == | ||
+ | |||
+ | PUT https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name | ||
+ | |||
+ | == Parameters == | ||
+ | |||
+ | {| | ||
+ | ! align="left" width="200px" | schema_name (url) | ||
+ | | width="200px" | obrigatório | ||
+ | | nome do schema | ||
+ | |- | ||
+ | ! align="left" width="200px" | schema (json) | ||
+ | | width="200px" | obrigatório | ||
+ | | um hash no formato campo:valor, contendo os campos necessários para atualização do schema: | ||
+ | |- | ||
+ | ! align="left" width="200px" style="padding-left: 20px" | name | ||
+ | | width="200px" | opcional | ||
+ | | nome do schema | ||
+ | |} | ||
+ | |||
+ | == Authentication == | ||
+ | |||
+ | Esta API exige autenticação do Marketing Account. Ver [[#Authentication|Autenticação]]. | ||
+ | |||
+ | == Response == | ||
+ | |||
+ | ==== Response Status ==== | ||
+ | {| | ||
+ | ! align="left" width="200px" | ok (200) | ||
+ | | O schema 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 não foi encontrado. | ||
+ | |+ | ||
+ | ! align="left" width="200px" | unprocessable_entity (422) | ||
+ | | Erro de validação no campo "schema". | ||
+ | |+ | ||
+ | ! align="left" width="200px" | internal_server_error (500) | ||
+ | | Um erro desconhecido ocorreu. | ||
+ | |} | ||
+ | |||
+ | == Example Request == | ||
+ | |||
+ | Atualiza o schema com nome "first_schema". | ||
+ | |||
+ | curl -iX PUT 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \ | ||
+ | -d '{ | ||
+ | "schema": { | ||
+ | "name":"new_first_schema" | ||
+ | } | ||
+ | }' \ | ||
+ | -H 'Content-type: application/json' \ | ||
+ | --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | ||
+ | |||
+ | Response: | ||
+ | |||
+ | HTTP/1.1 200 Ok | ||
+ | Status: 200 |
Revision as of 13:01, 3 November 2014
Contents |
Description
Atualiza um Schema.
Resource URL
PUT https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name
Parameters
schema_name (url) | obrigatório | nome do schema |
---|---|---|
schema (json) | obrigatório | um hash no formato campo:valor, contendo os campos necessários para atualização do schema: |
name | opcional | nome do schema |
Authentication
Esta API exige autenticação do Marketing Account. Ver Autenticação.
Response
Response Status
ok (200) | O schema 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 não foi encontrado. | unprocessable_entity (422) | Erro de validação no campo "schema". | internal_server_error (500) | Um erro desconhecido ocorreu. |
---|
Example Request
Atualiza o schema com nome "first_schema".
curl -iX PUT 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \ -d '{ "schema": { "name":"new_first_schema" } }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response:
HTTP/1.1 200 Ok Status: 200