REST Request Section | Description |
Types | Objects for which you want to perform the search operation. You can specify one or more of the listed objects. Note: When you specify Users and User Groups in the Types section to return the list of users and user groups from Integration Server respectively, you need not specify any search criteria. |
Scope | Search Criteria. You must specify your search attribute and a keyword (value of the attribute) or one of the following as your search criteria: Time range - to retrieve results for a date range (from and to values), from a specified date to current date, till a specified date, or since the given amount of time (seconds, minutes, hours, days, weeks, months, quarters, or years). Value range - to retrieve results for a integer value range (from and to values), from a given value to the maximum value, and from 0 to the given value. You can specify multiple attributes in this section. Note: The search operation is performed based on the search criteria specified in this section for all objects specified in the Types section. |
Condition | One of the following: and - to return results that match all search criteria. or - to return results that match any of the given criteria. |
Fields | Fields to be returned in the response. You can specify only the required fields, instead of viewing all fields in your response. That is, if you want to view only the API Names and Versions that match your search criteria, you can specify apiName and apiVersion in this section of your REST request. |
REST Request Section | Description |
Types | Objects for which you want to perform the search operation. You can specify one or more of the listed objects. |
Scope | Search Criteria. You must specify your search attribute and a keyword (value of the attribute) or one of the following as your search criteria: Time range - to retrieve results for a date range (from and to values), from a specified date to current date, till a specified date, or since the given amount of time (seconds, minutes, hours, days, weeks, months, quarters, or years). Value range - to retrieve results for a integer value range (from and to values), from a given value to the maximum value, and from 0 to the given value. |
Condition | One of the following: and - to return results that match all search criteria. or - to return results that match any of the given criteria. |
Aggregations | Values for the following: Name - Specify a name used to group the required results. For example, you can specify Info by API, if you are grouping the results by APIs. Type - One of the following: group - to group the results based on the given fields. timeseries - to group results based on a given interval value. The interval can be seconds, minutes, hours, days, weeks, months, quarters, or years. metrics - to find the average, minimum, maximum and sum of given fields. Fields - Fields to be considered for the aggregation. If the type is group and there are multiple fields, separate the field names with commas. |