POST datastore/schemas/:schema name/objects
From Social ID Developers
(Difference between revisions)
(moved POST datastore/schemas/:schema name/objects to POST datastore/schemas/:schema name/objects PT-BR) |
|||
(2 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
− | + | == Description == | |
+ | |||
+ | Creates a new Object for a Schema. | ||
+ | |||
+ | == Resource URL == | ||
+ | |||
+ | POST https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects | ||
+ | |||
+ | == Parameters == | ||
+ | |||
+ | === URL Parameters === | ||
+ | |||
+ | {| | ||
+ | ! align="left" width="200px" | schema_name | ||
+ | | width="200px" | required | ||
+ | | schema name. | ||
+ | |} | ||
+ | |||
+ | === JSON Parameters === | ||
+ | |||
+ | {| | ||
+ | ! align="left" width="200px" | object | ||
+ | | width="200px" | required | ||
+ | | a hash in the format field:value, with the necessary fields to create an object: | ||
+ | |- | ||
+ | ! align="left" width="180px" style="padding-left: 20px" | user_id | ||
+ | | width="200px" | required | ||
+ | | user identifier. | ||
+ | |- | ||
+ | ! align="left" width="180px" style="padding-left: 20px" | [fields] | ||
+ | | width="200px" | optional | ||
+ | | custom fields defined in the schema. | ||
+ | |} | ||
+ | |||
+ | == Authentication == | ||
+ | |||
+ | This API requires Account authentication. See [[Authentication]]. | ||
+ | |||
+ | == Response == | ||
+ | |||
+ | === Response Status === | ||
+ | {| | ||
+ | ! align="left" width="200px" | created (201) | ||
+ | | The object was created 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 "object". | ||
+ | |- | ||
+ | ! align="left" width="200px" | internal_server_error (500) | ||
+ | | An unknown error happened. | ||
+ | |} | ||
+ | |||
+ | == Examples == | ||
+ | |||
+ | === Request === | ||
+ | |||
+ | Creates a new object for the schema named "first_schema". | ||
+ | |||
+ | curl -iX POST 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \ | ||
+ | -d '{ | ||
+ | "object": { | ||
+ | "user_id": 340, | ||
+ | "first_field": "First Object", | ||
+ | "second_field": 123 | ||
+ | } | ||
+ | }' \ | ||
+ | -H 'Content-type: application/json' \ | ||
+ | --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | ||
+ | |||
+ | === Response === | ||
+ | |||
+ | ==== Response Headers ==== | ||
+ | |||
+ | HTTP/1.1 201 Created | ||
+ | Location: 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects/54481188e5cb7cffe4000003' | ||
+ | Status: 201 |
Latest revision as of 19:21, 10 May 2019
Contents |
Description
Creates a new Object for a Schema.
Resource URL
POST https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects
Parameters
URL Parameters
schema_name | required | schema name. |
---|
JSON Parameters
object | required | a hash in the format field:value, with the necessary fields to create an object: |
---|---|---|
user_id | required | user identifier. |
[fields] | optional | custom fields defined in the schema. |
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
created (201) | The object was created 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 "object". |
internal_server_error (500) | An unknown error happened. |
Examples
Request
Creates a new object for the schema named "first_schema".
curl -iX POST 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \ -d '{ "object": { "user_id": 340, "first_field": "First Object", "second_field": 123 } }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Location: 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects/54481188e5cb7cffe4000003' Status: 201