Get Effectivity Groups
post
/config/sim/v2/setup/getEffectivityGroups
Gets all the Effectivity Groups configured
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
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 returnedExample:
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 supportedExample:
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)
Response
Supported Media Types
- application/json
200 Response
A collection of Effectivity Groups.
Root Schema : schema
Type:
Show Source
object-
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 Effectivity Group objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Effectivity Group objects of the organization.
Show Source
Nested Schema : EffectivityGroupv2
Type:
Show Source
object-
activeTimes:
array activeTimes
-
allowLocalControl:
boolean
A Boolean flag indicating if the effectivity group is allowed to be controlled at local level.Example:
true -
changeSetId:
integer
The unique reference of the effectivity group.Example:
1 -
dataExtensions:
array dataExtensions
An array of data extensions for the menu item
-
hierUnitId:
integer
Unique hierarchy unit valueExample:
1 -
hierUnitObjNum:
integer
Hierarchy unit object numberExample:
1 -
localEffectivtyGroupStatus:
array localEffectivtyGroupStatus
A list indicating the status of enableEffectivityGroup flags at inherited locations.
-
name:
object name
name of the Effectivity Group
-
objectNum:
integer
Object number of the effectivity groupExample:
1
Nested Schema : dataExtensions
Type:
arrayAn array of data extensions for the menu item
Show Source
Nested Schema : localEffectivtyGroupStatus
Type:
arrayA list indicating the status of enableEffectivityGroup flags at inherited locations.
Show Source
Nested Schema : name
Type:
objectname of the Effectivity Group
Example:
{
"1":"Effectivity Group 1",
"2":"Efectividad Grupo 1"
}Nested Schema : items
Type:
Show Source
object-
effId:
integer
The unique reference of the effectivity recordExample:
1 -
endTime:
string
The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactiveExample:
2020-12-31T23:59:59 -
mustActivateBy:
string
The time that the record must activate for each Active Time. This should be between startTime and endTime.Example:
2023-11-17T02:27:39 -
startTime:
string
The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.Example:
2020-01-01T00:00:00 -
timeIsLocal:
boolean
A Boolean flag indicating if the Start/End times represent the local time of the property.Example:
false
Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extention fieldExample:
extension_Column -
value:
string
value of the extension fieldExample:
value1
Nested Schema : items
Type:
Show Source
object-
enableEffectivityGroup:
boolean
Flag indicating if the effectivity group is enabled or not at the specified hierarchy.Example:
true -
hierUnitId:
integer
Unique hierarchy unit valueExample:
1