Get Family Groups
post
/config/sim/v1/menuItems/getFamilyGroups
Gets a list of Family Groups
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
0 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A Collection of Family Group entities.
Root Schema : FamilyGroupv1GetResponse
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Family Groups objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Family Groups objects of the organization.
Show Source
-
Array of:
object FamilyGroupv1
Model for Family Group Object
Nested Schema : FamilyGroupv1
Type:
objectModel for Family Group Object
Show Source
-
consumerDesc:
object consumerDesc
Consumer Description.
-
consumerName:
object consumerName
Consumer Name
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
images:
array images
An array of images associated with the family group
-
majorGrpName:
object majorGrpName
Major Group Name
-
majorGrpObjNum:
integer
Object number of the major groupExample:
2 -
name:
object name
Name
-
objectNum:
integer
Object Number of the family groupExample:
1 -
reportGroup:
integer
Object number of the Report Group.Example:
1
Nested Schema : consumerDesc
Type:
objectConsumer Description.
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : consumerName
Type:
objectConsumer Name
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : majorGrpName
Type:
objectMajor Group Name
Example:
{
"en-US":"Major Group 1",
"de-DE":"Hauptgruppe 1",
"es-MX":"Grupo principal 1"
}Nested Schema : name
Type:
objectName
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : FamilyGroup_image
Type:
Show Source
object-
altText:
string
The image alternative text of the family groupExample:
pizza -
description:
string
The description text of the family groupExample:
pizza description -
imageIndex:
integer
Image Number for referenceExample:
1 -
isCloudImage:
boolean
Flag indicating if the image is stored on the CloudExample:
true -
size:
string
The size of the imageExample:
1 -
url:
string
The URL of the image of the family groupExample:
https://oracleObjectStore.com/images/coffee822815.jpg