| Table of Contents |
|---|
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. |
...
| Type | Description | Example |
|---|---|---|
| Asset List | The keyword must be "name + #ID" of an asset. | "Laptop 1 #167" |
| Asset List by Asset Types | The keyword must be "name + #ID" of an asset. | "Laptop 1 #167" |
| Cascading Dropdown | The keyword must be text. | "1-2" |
| Checkbox | The keyword must be text. | "Ada" |
| Date Picker | The keyword must be Date(without time) in ISO format. | "2020-05-22" |
| Date Time Picker | The keyword must be Date-time(with time) in ISO format. | "2020-05-22T13:18" |
| Dropdown List | The keyword must be text. | "Ada" |
| IP | The keyword must be text. | "192.168.1.1" |
| IPv6 | The keyword must be text. | "2607:f0d0:1002:0051:0000:0000:0000:0004" |
| Jira Organizations | The keyword must be text. | "1" |
| Jira Project | The keyword must be text. | "10000" |
| Jira Project Components | The keyword must be text. | "10000-1" |
| Jira Project Versions | The keyword must be text. | "10000-1" |
| Jira User Picker | The keyword must be a username. | "tyler-durden" |
| List Box | The keyword must be text. | "Mer" |
| List Box - Multiple | The keyword must be text. | "Izm" |
| Number Float(with decimals) | The keyword must be number float(with decimals). | 14.2 |
Number Long(without decimals) | The keyword must be number long(without decimals). | 98 |
| Radio Button | The keyword must be text. | "Can" |
| Text | The keyword must be text. | "Lorem ipsum dolor sit amet, consectetur adipiscing elit." |
| Text Area | The keyword must be text. | "Lorem ipsum dolor sit amet, consectetur adipiscing elit." |
| URL | The keyword must be text. | "https://snapbytes.com/" |
...