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": "velit cupidatat",
"limit": "aute qui anim pariatur Duis",
"sort": "created",
"order": "asc",
"equals": {
"modelName": "VLAN Service",
"stateName": "Ut cupidatat laborum et officia",
"_id": "62a1f3d2ebedfc54e6e0065c",
"name": "VLAN Service",
"modelId": "62a1f3d2ebedfc54e6e0065c",
"created": "2023-05-23T13:20:25.775Z",
"createdBy": "62a1f3d2ebedfc54e6e0065c",
"lastUpdated": "1961-05-04T01:53:03.632Z",
"lastUpdatedBy": "62a1f3d2ebedfc54e6e0065c"
},
"in": {
"name": "name1,name2,name3"
},
"include-deleted": "false",
"starts-with": {
"name": "EC2 Instance"
},
"lt": {
"created": "1971-01-04T20:23:33.306Z",
"lastUpdated": "2014-12-20T16:32:07.369Z"
},
"lte": {
"created": "1947-08-06T05:35:07.03Z",
"lastUpdated": "1972-08-02T20:11:34.885Z"
},
"gt": {
"created": "2012-10-07T11:43:15.476Z",
"lastUpdated": "1976-05-08T23:21:38.973Z"
},
"gte": {
"created": "2007-06-28T20:44:50.98Z",
"lastUpdated": "1954-01-01T15:13:21.515Z"
},
"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 imported 3 of 4 documents",
"data": "null",
"metadata": {
"skip": 30568338,
"limit": 54860642,
"total": 83736198,
"nextPageSkip": 13515582,
"previousPageSkip": -65458739,
"currentPageSize": 77324627
}
}