Get multiple instance groups

GET

https://example.itential.io/lifecycle-manager/resources/:modelIdentifier/groups

GET

/lifecycle-manager/resources/:modelIdentifier/groups

$ curl https://example.itential.io/lifecycle-manager/resources/myCoolDocumentName/groups \
>      -u "<username>:<password>"

1 {
2   "data": [
3     {
4       "createdBy": {
5         "firstname": "string",
6         "provenance": "string",
7         "username": "string",
8         "_id": "string"
9       },
10       "created": "2024-01-15T09:30:00Z",
11       "lastUpdatedBy": {
12         "firstname": "string",
13         "provenance": "string",
14         "username": "string",
15         "_id": "string"
16       },
17       "lastUpdated": "2024-01-15T09:30:00Z",
18       "_id": "string",
19       "lastAction": {
20         "_id": null,
21         "executionId": "string",
22         "name": "Create",
23         "type": "import",
24         "status": "running"
25       },
26       "description": "Some helpful information about the document",
27       "modelId": "string",
28       "name": "myCoolDocumentName"
29     }
30   ],
31   "metadata": {
32     "skip": 1,
33     "limit": 1,
34     "total": 1,
35     "nextPageSkip": 1,
36     "previousPageSkip": 1,
37     "currentPageSize": 1
38   },
39   "message": "Successfully created the requested item"
40 }

Returns multiple instance groups.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

modelIdentifierstringRequired

modelIdentifier

Query parameters

skipstringOptional

This parameter specifies where to start the returned page of search results.

limitstringOptional

This parameter specifies how many items to return in the search results.

sortstringOptional

This parameter specifies the field to sort the search results over.

orderenumOptional

This parameter specifies the direction to sort the search results over.

Allowed values:

equalsobjectOptional

equals

inobjectOptional

starts-withobjectOptional

starts-with

ltobjectOptional

lteobjectOptional

lte

gtobjectOptional

gteobjectOptional

gte

dereferenceanyOptional

Comma-separated list of foreign key field types to dereference

Response

response

datalist of objects

metadataobject

Properties describing search result pagination

Errors

500

Internal Server Error