PUT datastore/schemas/:schema name

From Social ID Developers
Revision as of 20:39, 17 September 2019 by Gabriel.prado (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox