Get Effectivity Groups
post
/config/sim/v1/setup/geteffectivitygroups
Gets all the Effectivity Groups configured
Request
Supported Media Types
- application/json
- multipart/form-data
Get request body for effectivity groups
Root Schema : EffGroupGetRequest
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 Effectivity Groups objects of the organization
Root Schema : EffectivityGroupsGetResponse
Type:
Show Source
object-
activeTimes(required):
array activeTimes
-
allowLocalControl(required):
boolean
A Boolean flag indicating if the effectivity group is allowed to be controlled at local level.Example:
true -
changeSetId(required):
integer
The unique reference of the effectivity group.Example:
1 -
dataExtensions(required):
array dataExtensions
An array of data extensions for the menu item
-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
hierUnitName(required):
object hierUnitName
Hierarchy unit name
-
hierUnitObjNum(required):
integer
Hierarchy unit object numberExample:
1 -
localEffectivtyGroupStatus(required):
array localEffectivtyGroupStatus
A list indicating the status of enableEffectivityGroup flags at inherited locations.
-
name(required):
object name
name of the Effectivity Group
-
objectNum(required):
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 : hierUnitName
Type:
objectHierarchy unit name
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}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:
{
"en-US":"Effectivity Group 1",
"es-MX":"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 -
hierUnitName:
object hierUnitName
Hierarchy unit name
Nested Schema : hierUnitName
Type:
objectHierarchy unit name
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}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