Add Effectivity Groups
post
/config/sim/v1/setup/effectivitygroups
Add an Effectivity Groups record for the current organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that Identifies that who made the change
CUD request body for effectivity groups
Root Schema : EffectivityGroupsCUDRequestBody
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 -
dataExtensions:
array dataExtensions
An array of data extensions for the menu item
-
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
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 : 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
Response
Supported Media Types
- application/json
200 Response
Response indicating the EffGrp object added.
Root Schema : EffGroupCUResponse
Type:
Show Source
object-
changeSetId(required):
integer
The unique reference of the effectivity group.Example:
1 -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
objectNum(required):
integer
Object number of the printerExample:
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