Search Service

OpenClient endpoint for searching for content

ResourceDescription
Search contentSearches for content
Search placesSearches for places

Search content

Searches for content

GET http://domain:port/application_context/api/core/v2/search/content?q=String&type=Set&from=String&to=String&containerTypeID=Integer&containerID=Long&container=String&user=String&userID=Long&limit=int&offset=int&sort=String&sortOrder=String

Query Parameters

NameTypeDescriptionDefault Value
qStringA text string that will be searched for within Jive.""
typeSetset of content types to include in the search. When not specified all content types available to open client will be searched. 
fromStringolder items in terms of modification time (day granularity) will be excluded from the search results.""
toStringnewer items in terms of modification time (day granularity) will be excluded from the search results.""
containerTypeIDIntegerID of the container type to restrict the search to. If this is specified, then containerID must also be specified, and containerName must not 
containerIDLongID of the container to restrict the search to. If this is specified, then containerTypeID must also be specified, and containerName must not 
containerStringname of the container to search to restrict the search to. If this is specified, then neither containerID nor containerTypeID can be specified 
userStringUsername of the content author to restrict the search to. If this is specified, then userID cannot be specified. 
userIDLongUser ID of the content author to restrict the search to. If this is specified, then username cannot be specified. 
limitintthe maximum number of results to return. If there are fewer results available, then fewer results than the limit will be returned."25"
offsetintthe number of results which should be skipped in the returned array. For instance, if the first 25 results have already been retrieved then results after the 25th result can be retrieved by specifying an offset of 25. The minimum value for the offset is 0, specifying anything less than 0 for the offset will result in an exception."0"
sortStringthe field to sort on ("relevance", "likes", "subject", "modificationDate"). The default if sort is not provided is "relevance""relevance"
sortOrderStringthe desired sort order ("descending", "ascending"). The default order if none is provided is "descending". Please note that ascending and descending do not necessary produce exact opposites of one another. This is because there are often additional criteria that is used to sort items that have matching primary criteria."descending"

Response

TypeDescription
EntityCollectionthe JSON representation of the search results

Example

JSON Response Payload
{
  "data" : [ {
    "type" : "post",
    "subject" : "lion nPsi7QTfmGik0epyWR9lRVWnrTcawd",
    "author" : {
      "name" : "Administrator",
      "username" : "admin",
      "links" : {
        "alt" : "http://localhost:50001/oc/v1/users/1",
        "avatar" : "http://localhost:50001/oc/v1/avatars/default"
      }
    },
    "replyCount" : 0,
    "likeCount" : 0,
    "contentSummary" : "6VhaGwWbXKZsq2wByCrWG4f0GS2FMw",
    "links" : {
      "alt" : "http://localhost:50001/oc/v1/posts/1021"
    }
  }, {
    "type" : "post",
    "subject" : "lion pNFkVbSlmAJecI5CI48TtMAtVAXd3Y",
    "author" : {
      "name" : "Administrator",
      "username" : "admin",
      "links" : {
        "alt" : "http://localhost:50001/oc/v1/users/1",
        "avatar" : "http://localhost:50001/oc/v1/avatars/default"
      }
    },
    "replyCount" : 0,
    "likeCount" : 0,
    "contentSummary" : "lxY0ynTG5IOAs3Nk8OCt6Uc138TsXQ",
    "links" : {
      "alt" : "http://localhost:50001/oc/v1/posts/1033"
    }
  }, {
    "type" : "post",
    "subject" : "lion Utrsw5zX5HxdlXgDsv3iGI0WYPgV9q",
    "author" : {
      "name" : "Administrator",
      "username" : "admin",
      "links" : {
        "alt" : "http://localhost:50001/oc/v1/users/1",
        "avatar" : "http://localhost:50001/oc/v1/avatars/default"
      }
    },
    "replyCount" : 0,
    "likeCount" : 0,
    "contentSummary" : "n084QxUOwtfR4CgHHXIgcGfB05Ehwa",
    "links" : {
      "alt" : "http://localhost:50001/oc/v1/posts/1005"
    }
  }, {
    "type" : "post",
    "subject" : "lion X32T1qP9BOCXpswKkgtxJxiuwtAJO3",
    "author" : {
      "name" : "Administrator",
      "username" : "admin",
      "links" : {
        "alt" : "http://localhost:50001/oc/v1/users/1",
        "avatar" : "http://localhost:50001/oc/v1/avatars/default"
      }
    },
    "replyCount" : 0,
    "likeCount" : 0,
    "contentSummary" : "4pdXSMeFMJqC08heYH58xUvBV1DO7F",
    "links" : {
      "alt" : "http://localhost:50001/oc/v1/posts/1029"
    }
  }, {
    "type" : "discussion",
    "subject" : "lion f3oPJ5PGzFrZvVyQ67TCiRk6GLkIXj",
    "author" : {
      "name" : "user-zE3416YXEi8RG405",
      "username" : "user-ze3416yxei8rg405",
      "links" : {
        "alt" : "http://localhost:50001/oc/v1/users/2000",
        "avatar" : "http://localhost:50001/oc/v1/avatars/default"
      }
    },
    "replyCount" : 0,
    "likeCount" : 0,
    "contentSummary" : "Psauob7SsH5B0EF6INHXCC02GFcFuG",
    "links" : {
      "alt" : "http://localhost:50001/oc/v1/discussions/1000"
    }
  }, {
    "type" : "discussion",
    "subject" : "lion HFc1rR4ZpV1YUhpe3Tobbj7dL1Mw34",
    "author" : {
      "name" : "user-Y5HrCk7462tk94IH",
      "username" : "user-y5hrck7462tk94ih",
      "links" : {
        "alt" : "http://localhost:50001/oc/v1/users/2016",
        "avatar" : "http://localhost:50001/oc/v1/avatars/default"
      }
    },
    "replyCount" : 0,
    "likeCount" : 0,
    "contentSummary" : "xPArVspBs1nX0OzzUuBHANXG6sFazT",
    "links" : {
      "alt" : "http://localhost:50001/oc/v1/discussions/1004"
    }
  } ],
  "links" : {
    "next" : "http://localhost:50001/oc/v1/search/?type=post&type=discussion&q=lion&limit=6&offset=12",
    "previous" : "http://localhost:50001/oc/v1/search/?type=post&type=discussion&q=lion&limit=6"
  }
}

Search places

Searches for places

GET http://domain:port/application_context/api/core/v2/search/places?q=String&type=Set&limit=int&offset=int&from=String&to=String&sort=String&sortOrder=String

Query Parameters

NameTypeDescriptionDefault Value
qStringthe query string""
typeSetset of container types to include in the search. When not specified all container types available to open client will be searched. 
limitintthe maximum number of results to return. If there are fewer results available, then fewer results than the limit will be returned."25"
offsetintthe number of results which should be skipped in the returned array. For instance, if the first 25 results have already been retrieved then results after the 25th result can be retrieved by specifying an offset of 25. The minimum value for the offset is 0, specifying anything less than 0 for the offset will result in an exception."0"
fromStringolder items in terms of modification time (day granularity) will be excluded from the search results.""
toStringnewer items in terms of modification time (day granularity) will be excluded from the search results.""
sortStringthe field to sort on ("relevance", "likes", "subject", "modificationDate"). The default if sort is not provided is "relevance""relevance"
sortOrderStringthe desired sort order ("descending", "ascending"). The default order if none is provided is "descending"."descending"

Response

TypeDescription
EntityCollectionthe JSON representation of the search results

Example

JSON Response Payload
TBD