Versions Compared

Old Version 8

changes.mady.by.user Former user

Saved on

compared with

New Version 9

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoint ID:

9005

Method:

URL:

POST /data/content/search

Request body:

JSON data with information about the content to be searched.

Required fields:
 

compareValue1:

Required if "compare" has value. Possible valid values of "compare" are ["=", "<", ">", "<=", ">=", "between"]

 

compareValue2:

Required if "compare" has value "between"

Optional fields:
 tags:JSON array of Tags.
 fromDate:Date value defining content active start date. The date must be in UTC, for example "2014-01-01T01:00Z".
 limit:The maximum number of content to return. If omitted, limit is set to 1
 offset:The offset in search results from where to return data. If omitted, offset is set to 0
 compare:
Defines logical operator to be applied for search criteria. Possible valid values are ["=", "<", ">", "<=", ">=","between", "empty", "notempty"].
Code Block
titleExample
{
   "tags": [ "tag1", "tag2" ],
   "fromDate": "2014-01-01T01:00Z",            // optional - ISO UTC date
   "limit": 2,                                 // optional - default to 1
   "offset": 10,                               // optional - default to 0
   "compare": "between",                       // optional ["=", "<", ">", "<=", ">=",
                                               //    "between", "empty", "notempty"]
   "compareValue1": 5.1,                       // required for "compare":
                                               //    ["=", "<", ">", "<=", ">=", "between"]
   "compareValue2": 5.9                        // required for "compare": "between"
}

Response body:

JSON data with information about the content searched.

Code Block
titleExample
{
   "content": [
      {
         "tags": [ "tag1", "tag2" ],
         "contentType": "text/html",
         "content": "base64 encoded content string",
         "created": "2014-02-10T12:53Z",
         "value": 19.5
      },
      {
         "tags": [ "tag1", "tag2" ],
         "contentType": "text/html",
         "content": "base64 encoded content string",
         "created": "2014-02-02T15:02Z"
      }
   ],
   "paging": {
      "offset": 10,
      "count": 2,
      "more": true
   }
}
Status codes:200OK
 400.4 No content 404.1User not found
 404.2External user could not be found