Get Enable Effectivity Groups.
post
/config/sim/v1/setup/effectivitygroups/getEnableEffectivityGroups
Gets all the enable effectivity group records.
Request
Supported Media Types
- application/json
- multipart/form-data
Get request body for enable effectivity groups
Root Schema : EnableEffGroupsGetRequest
Type:
objectThe input body model that needs to be given.
Show Source
-
include:
string
Objects included in response
-
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
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of all enable effectivity group records of the organization.
Root Schema : EnableEffGroupsGetResponse
Type:
Show Source
object-
count(required):
integer
Current response record count.Example:
1 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of enable effectivity groups record of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of enable effectivity groups record of the organization.
Show Source
Nested Schema : EnableEffGroups
Type:
Show Source
object-
changeSetId(required):
integer
Unique reference of the inherited effectivity group.Example:
1 -
enableEffectivityGroup(required):
boolean
Flag indicating if the effectivity group is enabled or not.Example:
false -
hierUnitId(required):
integer
hierUnitId of property where the record is inheritedExample:
1 -
hierUnitName(required):
object hierUnitName
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(required):
integer
Hierarchy unit object numberExample:
1 -
name(required):
object name
name of the effectivity group
-
objectNum(required):
integer
Object Number of the inherited effectivity groupExample:
1
Nested Schema : hierUnitName
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : name
Type:
objectname of the effectivity group
Example:
{
"en-US":"Effectivity Group 1",
"es-MX":"Dispositivo de pedido 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