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": "anim incididunt ea",
"limit": "non",
"sort": "name",
"order": "asc",
"equals": {
"modelName": "VLAN Service",
"stateName": "Excepteur laborum dolor",
"_id": "62a1f3d2ebedfc54e6e0065c",
"name": "VLAN Service",
"modelId": "62a1f3d2ebedfc54e6e0065c",
"created": "1947-04-01T17:48:11.448Z",
"createdBy": "62a1f3d2ebedfc54e6e0065c",
"lastUpdated": "1958-07-30T05:54:47.394Z",
"lastUpdatedBy": "62a1f3d2ebedfc54e6e0065c"
},
"in": {
"name": "name1,name2,name3"
},
"include-deleted": "false",
"starts-with": {
"name": "VLAN Service"
},
"lt": {
"created": "1979-02-06T10:11:29.376Z",
"lastUpdated": "2020-07-29T14:13:17.26Z"
},
"lte": {
"created": "2001-07-19T18:49:49.971Z",
"lastUpdated": "1947-10-19T04:56:11.447Z"
},
"gt": {
"created": "2002-01-18T06:53:44.682Z",
"lastUpdated": "1954-12-11T14:26:01.096Z"
},
"gte": {
"created": "2025-02-02T15:40:06.855Z",
"lastUpdated": "1994-03-08T18:58:07.585Z"
},
"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": 20629625,
"limit": 97307189,
"total": -19609070,
"nextPageSkip": 39872245,
"previousPageSkip": 79791146,
"currentPageSize": 82310838
}
}