PUT datastore/schemas/:schema name

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
 
(→Request)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
#REDIRECT [[PUT datastore/schemas/:schema name PT-BR]]
+
== Description ==
 +
 
 +
Updates a Schema.
 +
 
 +
== Resource URL ==
 +
 
 +
  PUT https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name
 +
 
 +
== Parameters ==
 +
 
 +
=== URL Parameters ===
 +
 
 +
{|
 +
! align="left" width="200px"  | schema_name
 +
| style="width:200px" | required
 +
| 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="160px"  style="padding-left: 40px" | write_protected
 +
| width="200px" | optional
 +
| whether the user is prohibited to write to the given schema or not. Default: false
 +
|-
 +
! align="left" width="160px"  style="padding-left: 40px" | read_protected
 +
| width="200px" | 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 ===
 +
{|
 +
! align="left" width="200px" | ok (200)
 +
| The schema was updated successfully.
 +
|-
 +
! align="left" width="200px" | bad_request (400)
 +
| Some required parameter was not informed.
 +
|-
 +
! align="left" width="200px" | unauthorized (401)
 +
| The authentication is wrong. See [[Authentication]].
 +
|-
 +
! align="left" width="200px" | not_found (404)
 +
| The schema was not found.
 +
|-
 +
! align="left" width="200px" | unprocessable_entity (422)
 +
| Validation error in the field "schema".
 +
|-
 +
! align="left" width="200px" | 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

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