Get Major Groups
post
/config/sim/v1/menuItems/getMajorGroups
Gets all the Major Groups for a given organization
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : MajorGroupGetRequestBody
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 Major Groups in organization.
Root Schema : MajorGroupGetResponse
Type:
Show Source
object
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
1
-
hierUnitName(required):
object TranslatedStringHierUnitName
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1
-
name(required):
object TranslatedString
Additional Properties Allowed: additionalPropertiesA string that contains translations into multiple languages
-
objectNum(required):
integer
Object Number of the major groupExample:
1
-
reportGroup(required):
integer
Object number of the Report Group.Example:
1
Nested Schema : TranslatedStringHierUnitName
Type:
object
Additional Properties Allowed
Show Source
A string that contains translations into multiple languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}
Nested Schema : TranslatedString
Type:
object
Additional Properties Allowed
Show Source
A string that contains translations into multiple languages
Example:
{
"en-US":"Coffee",
"de-DE":"Kaffee",
"es-MX":"Cafe"
}
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 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