GET datastore/schemas/:schema name
(Difference between revisions)
(→Response Body) |
|||
| Line 52: | Line 52: | ||
! align="left" width="180px" style="padding-left: 20px" | type | ! align="left" width="180px" style="padding-left: 20px" | type | ||
| field type. | | field type. | ||
| + | |- | ||
| + | ! align="left" width="180px" style="padding-left: 20px" | unique | ||
| + | | whether the field is unique. | ||
|- | |- | ||
! align="left" width="180px" | created_at | ! align="left" width="180px" | created_at | ||
Revision as of 23:02, 3 October 2017
Contents |
Description
Returns a specific Schema.
Resource URL
GET https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name
Parameters
URL Parameters
| schema_name | required | schema name. |
|---|
Authentication
This API requires Marketing Account authentication. See Authentication.
Response
Response Status
| ok (200) | The request was successful. |
|---|---|
| unauthorized (401) | The authentication is wrong. See Authentication. |
| not_found (404) | The schema was not found. |
| internal_server_error (500) | An unknown error happened. |
Response Body
| name | schema name. |
|---|---|
| fields | array of hashes with fields description: |
| name | field name. |
| type | field type. |
| unique | whether the field is unique. |
| created_at | date of schema creation. |
| updated_at | date of schema latest update. |
Examples
Request
Returns information of the schema named "first_schema".
curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{
"name": "First Schema",
"fields": [
{
"name": "first_field",
"type": "string"
},
{
"name": "second_field",
"type": "integer"
}
],
"created_at": "2014-10-24T12:15:00Z",
"updated_at": "2014-10-24T12:15:00Z"
}
