Get Family Groups
post
/config/sim/v1/menuItems/getFamilyGroups
Gets a list of Family Groups
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : FamilyGroupGetRequestBody
Type:
Show Source
object-
include:
string
Example:
locations -
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 translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of family group entities in an organization.
Root Schema : FamilyGroupGetResponse
Type:
objectModel for Family Group Object
Show Source
-
consumerDesc(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
consumerName(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
hierUnitName(required):
object TranslatedString_HierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
images(required):
array images
An array of images associated with the family group
-
majorGrpName(required):
object TranslatedString_MajorGrpName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the major group in configured languages
-
majorGrpObjNum(required):
integer
Object number of the major groupExample:
2 -
name(required):
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
objectNum(required):
integer
Object Number of the family groupExample:
1 -
reportGroup(required):
integer
Object number of the Report Group.Example:
1
Nested Schema : TranslatedString_Name
Type:
objectAdditional Properties Allowed
Show Source
A group of translated names
Example:
{
"en-US":"Family Group 1",
"de-DE":"Familiengruppe 1",
"es-MX":"Grupo Familiar 1"
}Nested Schema : TranslatedString_HierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : TranslatedString_MajorGrpName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the major group in configured languages
Example:
{
"en-US":"Major Group 1",
"de-DE":"Hauptgruppe 1",
"es-MX":"Grupo principal 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
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found