GET datastore/schemas/:schema name/objects

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
 
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
−
#REDIRECT [[GET datastore/schemas/:schema name/objects PT-BR]]
+
== Description ==
 +
 
 +
Returns all Objects from a Schema.
 +
 
 +
== Resource URL ==
 +
 
 +
  GET 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.
 +
|-
 +
! align="left" width="200px"  | user_id
 +
| width="200px" | optional
 +
| user identifier to filter results.
 +
|}
 +
 
 +
== Authentication ==
 +
 
 +
This API requires Account authentication. See [[Authentication]].
 +
 
 +
== Response ==
 +
 
 +
=== Response Status ===
 +
{|
 +
! align="left" width="200px" | ok (200)
 +
| The search was performed successfully.
 +
|-
 +
! 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" | internal_server_error (500)
 +
| An unknown error happened.
 +
|}
 +
 
 +
=== Response Body ===
 +
 
 +
A successful search returns the following fields:
 +
 
 +
{|
 +
! align="left" width="200px" | total
 +
| total amount of objects found.
 +
|-
 +
! align="left" width="200px" | count
 +
| amount of objects returned in this page.
 +
|-
 +
! align="left" width="200px" | offset
 +
| amount of discarded objects (page start).
 +
|-
 +
! align="left" width="200px" | results
 +
| array with object details.
 +
|}
 +
 
 +
== Examples ==
 +
 
 +
=== Request ===
 +
 
 +
Returns all objects from the schema named "first_schema".
 +
 
 +
curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \
 +
-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": [
 +
    {
 +
      "object_id": "54481188e5cb7cffe4000003",
 +
      "user_id": 340,
 +
      "created_at": "2014-10-24T14:48:00Z",
 +
      "updated_at": "2014-10-24T14:48:00Z",
 +
      "first_field": "First Object",
 +
      "second_field": 123
 +
    },
 +
    { ... }
 +
  ]
 +
}

Latest revision as of 19:21, 10 May 2019

Contents

Description

Returns all Objects from a Schema.

Resource URL 

  GET https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects

Parameters

URL Parameters

schema_name required schema name.
user_id optional user identifier to filter results.

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.
not_found (404) The schema was not found.
internal_server_error (500) An unknown error happened.

Response Body

A successful search returns the following fields:

total total amount of objects found.
count amount of objects returned in this page.
offset amount of discarded objects (page start).
results array with object details.

Examples

Request

Returns all objects from the schema named "first_schema". 

curl -iX GET 'https://api.socialidnow.com/v1/marketing/datastore/schemas/first_schema/objects' \
-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": [
    {
      "object_id": "54481188e5cb7cffe4000003",
      "user_id": 340,
      "created_at": "2014-10-24T14:48:00Z",
      "updated_at": "2014-10-24T14:48:00Z",
      "first_field": "First Object",
      "second_field": 123
    },
    { ... }
  ]
}
Retrieved from "https://dev.socialidnow.com/index.php?title=GET_datastore/schemas/:schema_name/objects&oldid=2838"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox