Configuration and Content API Guide

Get Family Groups

post

/config/sim/v2/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: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
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: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Family Group entities.

Root Schema : schema

Type: object

Show Source

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 size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Family Groups objects of the organization.",
            "items":{
                "$ref":"#/definitions/FamilyGroupv2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Family Groups objects of the organization.

Show Source

Array of: object FamilyGroupv2

Model for Family Group Object

{
    "type":"array",
    "description":"Array of Family Groups objects of the organization.",
    "items":{
        "$ref":"#/definitions/FamilyGroupv2"
    }
}

Nested Schema : FamilyGroupv2

Type: object

Model for Family Group Object

Show Source

consumerDesc: object consumerDesc

Consumer Description
consumerName: object consumerName

Consumer Name
hierUnitId: integer

Unique reference of the hierarchy unit

Example: 2
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
images: array images

An array of images associated with the family group
majorGrpObjNum: integer

Object number of the major group

Example: 2
name: object name

Family Group Name
objectNum: integer

Object Number of the family group

Example: 1
reportGroup: integer

Object number of the Report Group.

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the family group"
        },
        "name":{
            "type":"object",
            "description":"Family Group Name",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "consumerDesc":{
            "type":"object",
            "description":"Consumer Description",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "consumerName":{
            "type":"object",
            "description":"Consumer Name",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "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 Description

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Nested Schema : consumerName

Type: object

Consumer Name

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

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

Family Group Name

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

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

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details