Jump to

• Request
• Response

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.

Body ()

Request body

Root Schema : FamilyGroupCUDRequestBody

Type: object

Model for Family Group Object

Show Source

• consumerDesc: object consumerDesc
  Consumer Desc
• consumerName: object consumerName
  Consumer Name
• hierUnitId(required): integer
  Unique reference of the hierarchy unit of an Enterprise

  Example: 2
• images: array images
  An array of images associated with the family group
• majorGrpObjNum: integer
  Object number of the major group

  Example: 2
• name(required): object name
  Name
• objectNum(required): integer
  Object Number of the family group

  Example: 1
• reportGroup: integer
  Object number of the Report Group.

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit of an Enterprise"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the family group"
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "en-US":"Family Group 1",
                "de-DE":"Familiengruppe 1",
                "es-MX":"Grupo Familiar 1"
            }
        },
        "consumerDesc":{
            "type":"object",
            "description":"Consumer Desc",
            "example":{
                "en-US":"Family Group 1",
                "de-DE":"Familiengruppe 1",
                "es-MX":"Grupo Familiar 1"
            }
        },
        "consumerName":{
            "type":"object",
            "description":"Consumer Name",
            "example":{
                "en-US":"Family Group 1",
                "de-DE":"Familiengruppe 1",
                "es-MX":"Grupo Familiar 1"
            }
        },
        "majorGrpObjNum":{
            "type":"integer",
            "example":2,
            "description":"Object number of the major group"
        },
        "reportGroup":{
            "description":"Object number of the Report Group.",
            "type":"integer",
            "example":1
        },
        "images":{
            "type":"array",
            "description":"An array of images associated with the family group",
            "items":{
                "$ref":"#/definitions/FamilyGroup_image"
            }
        }
    },
    "description":"Model for Family Group Object"
}

Nested Schema : consumerDesc

Type: object

Consumer Desc

Example:

{
    "en-US":"Family Group 1",
    "de-DE":"Familiengruppe 1",
    "es-MX":"Grupo Familiar 1"
}

Nested Schema : consumerName

Type: object

Consumer Name

Example:

{
    "en-US":"Family Group 1",
    "de-DE":"Familiengruppe 1",
    "es-MX":"Grupo Familiar 1"
}

Nested Schema : images

Type: array

An array of images associated with the family group

Show Source

• Array of: object FamilyGroup_image

{
    "type":"array",
    "description":"An array of images associated with the family group",
    "items":{
        "$ref":"#/definitions/FamilyGroup_image"
    }
}

Nested Schema : name

Type: object

Name

Example:

{
    "en-US":"Family Group 1",
    "de-DE":"Familiengruppe 1",
    "es-MX":"Grupo Familiar 1"
}

Nested Schema : FamilyGroup_image

Type: object

Show Source

• altText: string
  The image alternative text of the family group

  Example: pizza
• description: string
  The description text of the family group

  Example: pizza description
• imageIndex: integer
  Image Number for reference

  Example: 1
• isCloudImage: boolean
  Flag indicating if the image is stored on the Cloud

  Example: true
• size: string
  The size of the image

  Example: 1
• url: string
  The URL of the image of the family group

  Example: https://oracleObjectStore.com/images/coffee822815.jpg

{
    "type":"object",
    "properties":{
        "imageIndex":{
            "type":"integer",
            "example":1,
            "description":"Image Number for reference"
        },
        "url":{
            "type":"string",
            "example":"https://oracleObjectStore.com/images/coffee822815.jpg",
            "description":"The URL of the image of the family group"
        },
        "altText":{
            "type":"string",
            "example":"pizza",
            "description":"The image alternative text of the family group"
        },
        "description":{
            "type":"string",
            "example":"pizza description",
            "description":"The description text of the family group"
        },
        "isCloudImage":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if the image is stored on the Cloud"
        },
        "size":{
            "type":"string",
            "example":"1",
            "description":"The size of the image"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Family Group Updated or Added.

Body ()

Root Schema : FamilyGroupResponse

Type: object

Show Source

• hierUnitId: integer
  Unique reference of the hierarchy unit

  Example: 2
• objectNum: integer
  Object Number of the family group

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the family group"
        }
    }
}

Back to Top