PUT datastore/schemas/:schema name

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
(→Request)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
== Description ==
 
== Description ==
  
−
Atualiza um Schema.
+
Updates a Schema.
  
 
== Resource URL ==
 
== Resource URL ==
Line 8: Line 8:
  
 
== Parameters ==
 
== Parameters ==
 +
 +
=== URL Parameters ===
  
 
{|
 
{|
−
! align="left" width="200px"  | schema_name (url)
+
! align="left" width="200px"  | schema_name
−
| width="200px" | obrigatório
+
| style="width:200px" | required
−
| nome do schema
+
| schema name.
 +
|}
 +
 
 +
=== JSON Parameters ===
 +
 
 +
{|
 +
! width="200px" align="left" | schema
 +
| width="200px" | required
 +
| a hash in the format: field:value, with the necessary fields to update the schema:
 +
|-
 +
! align="left" width="180px"  style="padding-left: 20px" | name
 +
| width="200px" | optional
 +
| schema name.
 +
|-
 +
! align="left" width="160px"  style="padding-left: 20px" | fields
 +
| width="200px" | optional
 +
| an array of hashes in the format field:value, with the necessary fields to create a field: ('''Important''': if this field is informed, it will replace all the existing fields of the schema)
 +
|-
 +
! align="left" width="160px"  style="padding-left: 40px" | name
 +
| width="200px" | required
 +
| field name.
 +
|-
 +
! align="left" width="160px"  style="padding-left: 40px" | type
 +
| width="200px" | required
 +
| field type (array, boolean, date, date_time, float, hash, integer, string, time).
 +
|-
 +
! align="left" width="160px"  style="padding-left: 40px" | unique
 +
| width="200px" | optional
 +
| whether the field must be unique or not. Default: false
 +
|-
 +
! align="left" width="160px"  style="padding-left: 20px" | permissions
 +
| width="200px" | optional
 +
| hash with schema permissions:
 
|-
 
|-
−
! align="left" width="200px"  | schema (json)
+
! align="left" width="160px"  style="padding-left: 40px" | write_protected
−
| width="200px" | obrigatório
+
| width="200px" | optional
−
| um hash no formato campo:valor, contendo os campos necessários para atualização do schema:
+
| whether the user is prohibited to write to the given schema or not. Default: false
 
|-
 
|-
−
! align="left" width="200px"  style="padding-left: 20px" | name
+
! align="left" width="160px"  style="padding-left: 40px" | read_protected
−
| width="200px" | opcional
+
| width="200px" | optional
−
| nome do schema
+
| whether the user is prohibited to read from the given schema or not. Default: false
 
|}
 
|}
  
 
== Authentication ==
 
== Authentication ==
  
−
Esta API exige autenticação do Marketing Account. Ver [[#Authentication|Autenticação]].
+
This API requires Account authentication. See [[Authentication]].
  
 
== Response ==
 
== Response ==
  
−
==== Response Status ====
+
=== Response Status ===
 
{|
 
{|
 
! align="left" width="200px" | ok (200)
 
! align="left" width="200px" | ok (200)
−
| O schema foi atualizado com sucesso.
+
| The schema was updated successfully.
−
|+
+
|-
 
! align="left" width="200px" | bad_request (400)
 
! align="left" width="200px" | bad_request (400)
−
| Algum parâmetro obrigatório não foi informado.
+
| Some required parameter was not informed.
−
|+
+
|-
 
! align="left" width="200px" | unauthorized (401)
 
! align="left" width="200px" | unauthorized (401)
−
| A autenticação está errada. Ver [[#Authentication|Autenticação]].
+
| 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" | unprocessable_entity (422)
 
! align="left" width="200px" | unprocessable_entity (422)
−
| Erro de validação no campo "schema".
+
| Validation error in the field "schema".
−
|+
+
|-
 
! align="left" width="200px" | internal_server_error (500)
 
! align="left" width="200px" | internal_server_error (500)
−
| Um erro desconhecido ocorreu.
+
| An unknown error happened.
 
|}
 
|}
  
−
== Example Request ==
+
== Examples ==
  
−
Atualiza o schema com nome "first_schema".
+
=== Request ===
 +
 
 +
Updates the schema named "first_schema".
  
 
  curl -iX PUT 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \
 
  curl -iX PUT 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \
 
  -d '{
 
  -d '{
 
       "schema": {
 
       "schema": {
−
         "name":"new_first_schema"
+
         "name":"new_first_schema",
 +
        "fields":[
 +
          { "name":"new_field", "type":"string" },
 +
        ],
 +
        "permissions": {
 +
          "write_protected": false,
 +
          "read_protected": true
 +
        }
 
       }
 
       }
 
     }' \
 
     }' \
Line 63: Line 106:
 
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
 
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
  
−
Response:
+
=== Response ===
 +
 
 +
==== Response Headers ====
  
 
  HTTP/1.1 200 Ok
 
  HTTP/1.1 200 Ok
 
  Status: 200
 
  Status: 200

Latest revision as of 20:39, 17 September 2019

Contents

Description

Updates a Schema.

Resource URL 

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

Parameters

URL Parameters

schema_name required schema name.

JSON Parameters

schema required a hash in the format: field:value, with the necessary fields to update the schema:
name optional schema name.
fields optional an array of hashes in the format field:value, with the necessary fields to create a field: (Important: if this field is informed, it will replace all the existing fields of the schema)
name required field name.
type required field type (array, boolean, date, date_time, float, hash, integer, string, time).
unique optional whether the field must be unique or not. Default: false
permissions optional hash with schema permissions:
write_protected optional whether the user is prohibited to write to the given schema or not. Default: false
read_protected optional whether the user is prohibited to read from the given schema or not. Default: false

Authentication

This API requires Account authentication. See Authentication.

Response

Response Status

ok (200) The schema was updated successfully.
bad_request (400) Some required parameter was not informed.
unauthorized (401) The authentication is wrong. See Authentication.
not_found (404) The schema was not found.
unprocessable_entity (422) Validation error in the field "schema".
internal_server_error (500) An unknown error happened.

Examples

Request

Updates the schema named "first_schema". 

curl -iX PUT 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \
-d '{
      "schema": {
        "name":"new_first_schema",
        "fields":[
          { "name":"new_field", "type":"string" },
        ],
        "permissions": {
          "write_protected": false,
          "read_protected": true
        }
      }
    }' \
-H 'Content-type: application/json' \
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf

Response

Response Headers 

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