GET datastore/schemas
From Social ID Developers
(Difference between revisions)
(→Response Body) |
|||
(4 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
== Description == | == Description == | ||
− | + | Returns all Schemas from the Account. | |
== Resource URL == | == Resource URL == | ||
Line 9: | Line 9: | ||
== Authentication == | == Authentication == | ||
− | + | This API requires Account authentication. See [[Authentication]]. | |
== Response == | == Response == | ||
− | + | === Response Status === | |
{| | {| | ||
! align="left" width="200px" | ok (200) | ! align="left" width="200px" | ok (200) | ||
− | | | + | | The search was performed successfully. |
− | | | + | |- |
! align="left" width="200px" | unauthorized (401) | ! align="left" width="200px" | unauthorized (401) | ||
− | | | + | | The authentication is wrong. See [[Authentication]]. |
− | | | + | |- |
! align="left" width="200px" | internal_server_error (500) | ! align="left" width="200px" | internal_server_error (500) | ||
− | | | + | | An unknown error happened. |
|} | |} | ||
− | + | === Response Body === | |
− | + | A successful search returns the following fields: | |
{| | {| | ||
! align="left" width="200px" | total | ! align="left" width="200px" | total | ||
− | | | + | | total amount of schemas found. |
− | | | + | |- |
! align="left" width="200px" | count | ! align="left" width="200px" | count | ||
− | | | + | | amount of schemas returned in this page. |
− | | | + | |- |
! align="left" width="200px" | offset | ! align="left" width="200px" | offset | ||
− | | | + | | amount of discarded schemas (page start). |
− | | | + | |- |
! align="left" width="200px" | results | ! align="left" width="200px" | results | ||
− | | | + | | array with schema details. |
|} | |} | ||
− | == | + | == Examples == |
+ | |||
+ | === Request === | ||
curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas' \ | curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas' \ | ||
Line 49: | Line 51: | ||
--user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf | ||
− | Response | + | === Response === |
+ | |||
+ | ==== Response Headers ==== | ||
HTTP/1.1 200 Ok | HTTP/1.1 200 Ok | ||
Status: 200 | Status: 200 | ||
− | == | + | ==== Response Body ==== |
{ | { | ||
Line 62: | Line 66: | ||
"results": [ | "results": [ | ||
{ | { | ||
− | "name": " | + | "name": "first_schema", |
"fields": [ | "fields": [ | ||
{ | { | ||
"name": "first_field", | "name": "first_field", | ||
− | "type": "string" | + | "type": "string", |
+ | "unique": false | ||
}, | }, | ||
{ | { | ||
"name": "second_field", | "name": "second_field", | ||
− | "type": "integer" | + | "type": "integer", |
+ | "unique": true | ||
+ | }, | ||
+ | { | ||
+ | "name": "third_field", | ||
+ | "type": "date_time", | ||
+ | "unique": false | ||
} | } | ||
− | ] | + | ], |
+ | "permissions": { | ||
+ | "write_protected": true, | ||
+ | "read_protected": false | ||
+ | }, | ||
"created_at": "2014-10-24T12:15:00Z", | "created_at": "2014-10-24T12:15:00Z", | ||
− | "updated_at": "2014-10-24T12:15:00Z" | + | "updated_at": "2014-10-24T12:15:00Z" |
}, | }, | ||
{ ... } | { ... } | ||
] | ] | ||
} | } |
Latest revision as of 20:41, 17 September 2019
Contents |
Description
Returns all Schemas from the Account.
Resource URL
GET https://api.socialidnow.com/v1/marketing/datastore/schemas
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
ok (200) | The search was performed successfully. |
---|---|
unauthorized (401) | The authentication is wrong. See Authentication. |
internal_server_error (500) | An unknown error happened. |
Response Body
A successful search returns the following fields:
total | total amount of schemas found. |
---|---|
count | amount of schemas returned in this page. |
offset | amount of discarded schemas (page start). |
results | array with schema details. |
Examples
Request
curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 2, "count": 2, "offset": 0, "results": [ { "name": "first_schema", "fields": [ { "name": "first_field", "type": "string", "unique": false }, { "name": "second_field", "type": "integer", "unique": true }, { "name": "third_field", "type": "date_time", "unique": false } ], "permissions": { "write_protected": true, "read_protected": false }, "created_at": "2014-10-24T12:15:00Z", "updated_at": "2014-10-24T12:15:00Z" }, { ... } ] }