Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
This page is about Assets & Inventory Plugin for Jira DC. Using Cloud? Click here. |
User of the Rest API caller needs the Browse Asset permission to fetch results.
On this page:
|
---|
API Definition
Method | POST |
---|---|
URL | /rest/jip-api/1.0/index/query.json |
Request Headers:
Content-Type: application/json
Authorization: Basic Basic hash of user name and password. Example:For example,
Basic YWRtaW46YWRtaW4=
.
Post parameters
Parameter | Type | Example | Description |
---|---|---|---|
| String | basic | Fixed value. |
| String | detail | Fixed value. |
| String | For advanced manual Lucene Query. Leave it null to use | |
| List of | List of search criteria. | |
| List of | These search criteria will be " | |
| Boolean | true/false | Decides whether there will be " |
| Boolean | true/false | Decides whether there will be " |
| Integer | 1 | Page number of the results. Results will return as paged. |
| Integer | 15 | Size of page. |
| String | asc/desc | asc or desc. |
| String | asset.name | Field to sort. Use system fields System Fields or attribute Attribute names. |
| String |
| Use one of search field types. |
QueryIndexSearchParam
Parameter | Type | Example | Description |
---|---|---|---|
| String | External System Id | Field to search. Attribute name or System Fields are valid. |
| String | AB001 | Wildcard search is supported. i.e For example, |
| List of String | ["AB", "XDVl", "DRR"] | Use this field for |
| Float | 1 or 10.5 | Use this field for |
| Float | 1 or 10.5 | Use this field for |
| String | 2019-05-29T11:49 or 2019-05-29 | Use this field for For exact search, set range to |
| String | 2019-05-29T11:49 or 2019-05-29 | Use this field for For exact search, set range to |
| String | 1d or -2w | Use this field for
|
| String | 3y or -4m | Use this field for
|
| String | STRING | One of Search Field Types. |
| boolean | true/false | For relative date search, set " |
| boolean | true/false | For date and numeric RANGE searches. Set " |
| boolean | true/false | Set this field " |
| boolean | true/false | Set this field " |
Search Field Types
Field Type (use capital case) | |
---|---|
| List type of attributesAttributes. |
| List of long. |
| Text field. |
| Jira User's user key or $currentUser. |
| Date field without time. |
| Date field with time. |
| Numeric long value, i.e. 1001. For example, |
| Numeric Double/Float value, i.e. . For example, |
| Asset reference attribute Attribute type. |
| Asset reference filtered with asset type attribute type. |
| URL field. |
System Fields
These fields are available to search and sort.
System Field Name | Field Type | Description |
---|---|---|
| STRING | Any field. Search for any field including system fields and attributes. |
| LONG | Asset type scheme idID. |
| LIST | Asset type scheme name. |
| LONG | Asset type ID (formerly FORM). |
| LIST | Asset type name (formerly FORM). |
| LONG | Asset ID. |
| STRING | Asset name. |
| STRING | Attachment filename (not content of the file). |
| STRING | User name of the user how who created the asset. |
| DATE_TIME | Create date The asset’s time of assetcreation. |
| STRING | The keyword must be a status key. |
| STRING | The keyword must be a substatus key. |
| JIRA_USER | The keyword must be a user key. |
| JIRA_USER | The keyword must be a user key. |
| JIRA_USER | The keyword must be a user key. |
| JIRA_USER | The keyword must be a user key. |
| LONG | The keyword must be a number long (without decimals). |
| STRING | The keyword must be text. |
| STRING | The keyword must be text. |
| LONG | The keyword must be a location ID. |
| STRING | The keyword must be a List of Jira Group in JSON format. |
| DATE | The keyword must be Date (without time) in ISO format. |
| DOUBLE | The keyword must be a number float (with decimals). |
| STRING | The keyword must be one of the currencies. |
| STRING | The keyword must be text. |
Attributes
Type | Description | Example |
---|---|---|
Asset List | The keyword must be |
|
Asset List by Asset Types | The keyword must be |
|
Cascading Dropdown | The keyword must be text. |
|
Checkbox | The keyword must be text. |
|
Date Picker | The keyword must be Date (without time) in ISO format. |
|
Date Time Picker | The keyword must be Date-time (with time) in ISO format. |
|
Dropdown List | The keyword must be text. |
|
IP | The keyword must be text. |
|
IPv6 | The keyword must be text. |
|
Jira Organizations | The keyword must be text. |
|
Jira Project | The keyword must be text. |
|
Jira Project Components | The keyword must be text. |
|
Jira Project Versions | The keyword must be text. |
|
Jira User Picker | The keyword must be a username. |
|
List Box | The keyword must be text. |
|
List Box - Multiple | The keyword must be text. |
|
Number Float(with decimals) | The keyword must be number float (with decimals). |
|
Number Long(without decimals) | The keyword must be number long (without decimals). |
|
Radio Button | The keyword must be text. |
|
Text | The keyword must be text. |
|
Text Area | The keyword must be text. |
|
URL | The keyword must be text. |
|
Status and Substatus Keys
Status Keys
Display Name | Key |
---|---|
In stock | 1 |
In use | 2 |
In transit | 3 |
On order | 4 |
In maintenance | 5 |
Retired | 6 |
Missing | 7 |
Substatus Keys
Display Name | Key |
---|---|
Available | 1 |
Reserved | 2 |
Defective | 3 |
Pending repair | 4 |
Pending install | 5 |
Pending disposal | 6 |
Pending transfer | 7 |
Pre-allocated | 8 |
Lost | 9 |
Stolen | 10 |
Examples
For more examples, you can use the Asset Navigator UI to search conduct on-screen searches and then inspect on the corresponding page. Locate "the query" Network call and see examine both its Request and Responses. So first do Begin by conducting a screen search and find to pinpoint the real specific example meeting that aligns with your system and required fields.
Search for one String field
Request BodyExpand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Search for Asset Type Scheme, Asset Type, Asset Name, Asset ID
Expand | ||
---|---|---|
|
| ||
|
Expand | ||
---|---|---|
| ||
|
Search for any field including all attributes and system fields
Expand | ||
---|---|---|
|
| ||
|
Expand | ||
---|---|---|
| ||
|
Search for one asset with asset ID
Expand | ||
---|---|---|
|
| ||
|
Expand | ||
---|---|---|
|
| ||
|
Search for Asset Reference Type
Request BodyExpand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
| ||
|
Search for Status and Substatus (System Field)
Expand | ||
---|---|---|
|
| ||
|
Expand | ||
---|---|---|
|
| ||
|
Search for All Fields
Request BodyExpand | ||
---|---|---|
| ||
|
Expand | ||
---|---|---|
| ||
|