Update Family Groups
post
/config/sim/v1/menuItems/updateFamilygroups
Updates the Family Group. If not found, it creates a new family group.
| Release | Description |
|---|---|
| 23.4 | Starting with the API release 23.4, Update operation for Family Groups is allowed only at Enterprise. |
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Request body
Root Schema : FamilyGroupCUDRequestBody
Type:
objectModel for Family Group Object
Show Source
-
consumerDesc:
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
consumerName:
object TranslatedString_Name
Additional Properties Allowed: additionalPropertiesA group of translated names
-
hierUnitId(required):
integer
Unique reference of the hierarchy unit of an EnterpriseExample:
2 -
images:
array images
An array of images associated with the family group
-
majorGrpObjNum:
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:
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 : 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
Response
Supported Media Types
- application/json
200 Response
Family Group Response
Root Schema : FamilyGroupResponse
Type:
Show Source
object-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
2 -
objectNum(required):
integer
Object Number of the family groupExample:
1
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