| Table of Contents |
|---|
User of the Rest API caller needs the Browse Asset permission to fetch results.
API Definition
Method | POST |
|---|---|
| URL | /rest/jip-api/1.0/index/query.json |
Request Headers:
- Content-Type: application/json
- Authorization: Basic hash of user name and password. Example: Basic YWRtaW46YWRtaW4=
Post parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
searchType | String | basic | Fixed value |
listType | String | detail | Fixed value |
genericKeyword | String | For advanced manual Lucene Query. Leave it null to use queryIndexSearchParams | |
queryIndexSearchParams | List of QueryIndexSearchParam | List of search criteria | |
mandatoryQueryIndexSearchParams | List of QueryIndexSearchParam | These search criteria will be "AND" with queryIndexSearchParams | |
orForQueryIndexSearchParams | Boolean | true/false | Decides whether there will be "OR" or "AND" between queryIndexSearchParams. |
orForMandatoryQueryIndexSearchParams | Boolean | true/false | Decides whether there will be "OR" or "AND" between mandatoryQueryIndexSearchParams. |
pageNumber | Integer | 1 | Page number of the results. Results will return as paged. |
pageSize | Integer | 15 | Size of page |
sortDirection | String | asc/desc | asc or desc |
sortField | String | Field to sort. Use system fields or attribute names. | |
sortType | String | STRING | Use one of search field types. |
...