Configuration and Content API Guide

Add Family Groups

post

/config/sim/v1/menuItems/familyGroups

Add the Family Group object to a specified hierarchy unit.

Release	Description
23.4	Starting with the API release 23.4, Insert 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: object

Model for Family Group Object

Show Source

consumerDesc: object TranslatedString_Name

Additional Properties Allowed: additionalProperties

A group of translated names
consumerName: object TranslatedString_Name

Additional Properties Allowed: additionalProperties

A group of translated names
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 TranslatedString_Name

Additional Properties Allowed: additionalProperties

A group of translated names
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":{
            "$ref":"#/definitions/TranslatedString_Name"
        },
        "consumerDesc":{
            "$ref":"#/definitions/TranslatedString_Name"
        },
        "consumerName":{
            "$ref":"#/definitions/TranslatedString_Name"
        },
        "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 : TranslatedString_Name

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"A group of translated names",
    "example":{
        "en-US":"Family Group 1",
        "de-DE":"Familiengruppe 1",
        "es-MX":"Grupo Familiar 1"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of translated names

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 : 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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Family Group Response

Root Schema : FamilyGroupResponse

Type: object

Show Source

hierUnitId(required): integer

Unique reference of the hierarchy unit

Example: 2
objectNum(required): integer

Object Number of the family group

Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "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"
        }
    }
}

400 Response

400 Bad Request

Root Schema : ErrorDetails

Type: object

Response 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 problem

Example: 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":"55223"
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":"400"
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}