Summary
Searches resource instances
Description
Searches resource instances
Route
GET /lifecycle-manager/resources/:modelId/instances
Roles
admin
apiread
designer
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
modelId |
string |
yes |
- |
searchParameters |
object |
yes |
- |
Copied to Clipboard
{
"searchParameters": {
"skip": "nisi deserunt Lorem ex sunt",
"limit": "amet in",
"sort": "created",
"order": "asc",
"equals": {
"modelName": "VLAN Service",
"stateName": "incididunt mollit",
"_id": "62a1f3d2ebedfc54e6e0065c",
"name": "VLAN Service",
"modelId": "62a1f3d2ebedfc54e6e0065c",
"created": "2010-01-02T04:06:30.891Z",
"createdBy": "62a1f3d2ebedfc54e6e0065c",
"lastUpdated": "1949-04-03T20:50:49.531Z",
"lastUpdatedBy": "62a1f3d2ebedfc54e6e0065c"
},
"in": {
"stateId": "1234,53fe,0000"
},
"include-deleted": "false",
"starts-with": {
"name": "EC2 Instance"
},
"lt": {
"created": "2020-07-18T20:41:23.067Z",
"lastUpdated": "1989-03-06T05:14:19.916Z"
},
"lte": {
"created": "1960-10-15T13:47:37.138Z",
"lastUpdated": "1980-11-04T16:33:16.808Z"
},
"gt": {
"created": "1968-02-04T05:08:09.106Z",
"lastUpdated": "2015-05-23T07:46:02.003Z"
},
"gte": {
"created": "1983-08-09T08:55:07.654Z",
"lastUpdated": "2015-10-28T04:27:45.145Z"
},
"dereference": "accounts"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"searchParameters": {
"title": "searchParameters",
"$ref": "resource-instance-search-params"
}
},
"required": [
"searchParameters"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
response |
object |
- |
Copied to Clipboard
{
"message": "Successfully retrieved search results",
"data": "null",
"metadata": {
"skip": 2220389,
"limit": 26649285,
"total": -75592828,
"nextPageSkip": 30244907,
"previousPageSkip": -89390933,
"currentPageSize": -92342325
}
}