Configuration and Content API Guide

Add Effectivity Groups

post

/config/sim/v2/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

Detail that identifies, who made the change.

CUD request body for effectivity groups

Root Schema : schema

Type: object

Show Source

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 value

Example: 1
name(required): object name

name of the Effectivity Group
objectNum(required): integer

Object number of the effectivity group

Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the effectivity group",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"name of the Effectivity Group",
            "type":"object",
            "example":{
                "1":"Effectivity Group 1",
                "2":"Efectividad Grupo 1"
            }
        },
        "activeTimes":{
            "type":"array",
            "items":{
                "properties":{
                    "effId":{
                        "description":"The unique reference of the effectivity record",
                        "type":"integer",
                        "example":1
                    },
                    "startTime":{
                        "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.",
                        "type":"string",
                        "example":"2020-01-01T00:00:00"
                    },
                    "endTime":{
                        "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive",
                        "type":"string",
                        "example":"2020-12-31T23:59:59"
                    },
                    "timeIsLocal":{
                        "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.",
                        "type":"boolean",
                        "example":false
                    },
                    "mustActivateBy":{
                        "description":"The time that the record must activate for each Active Time. This should be between startTime and endTime.\n",
                        "type":"string",
                        "example":"2023-11-17T02:27:39"
                    }
                }
            }
        },
        "allowLocalControl":{
            "description":"A Boolean flag indicating if the effectivity group is allowed to be controlled at local level.\n",
            "type":"boolean",
            "example":true
        },
        "dataExtensions":{
            "description":"An array of data extensions for the menu item",
            "type":"array",
            "items":{
                "properties":{
                    "columnName":{
                        "description":"Name of the extention field",
                        "type":"string",
                        "example":"extension_Column"
                    },
                    "value":{
                        "description":"value of the extension field",
                        "type":"string",
                        "example":"value1"
                    }
                }
            }
        }
    }
}

Nested Schema : activeTimes

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "effId":{
                "description":"The unique reference of the effectivity record",
                "type":"integer",
                "example":1
            },
            "startTime":{
                "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.",
                "type":"string",
                "example":"2020-01-01T00:00:00"
            },
            "endTime":{
                "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive",
                "type":"string",
                "example":"2020-12-31T23:59:59"
            },
            "timeIsLocal":{
                "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.",
                "type":"boolean",
                "example":false
            },
            "mustActivateBy":{
                "description":"The time that the record must activate for each Active Time. This should be between startTime and endTime.\n",
                "type":"string",
                "example":"2023-11-17T02:27:39"
            }
        }
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the menu item

Show Source

Array of: object items

{
    "description":"An array of data extensions for the menu item",
    "type":"array",
    "items":{
        "properties":{
            "columnName":{
                "description":"Name of the extention field",
                "type":"string",
                "example":"extension_Column"
            },
            "value":{
                "description":"value of the extension field",
                "type":"string",
                "example":"value1"
            }
        }
    }
}

Nested Schema : name

Type: object

name of the Effectivity Group

Example:

{
    "1":"Effectivity Group 1",
    "2":"Efectividad Grupo 1"
}

Nested Schema : items

Type: object

Show Source

effId: integer

The unique reference of the effectivity record

Example: 1
endTime: string

The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive

Example: 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

{
    "properties":{
        "effId":{
            "description":"The unique reference of the effectivity record",
            "type":"integer",
            "example":1
        },
        "startTime":{
            "description":"The time that the record becomes active for each Active Time interval. Leave the field blank if the start time is not relevant.",
            "type":"string",
            "example":"2020-01-01T00:00:00"
        },
        "endTime":{
            "description":"The time that the record becomes inactive for each Active Time interval. Leave the field blank if the record never becomes inactive",
            "type":"string",
            "example":"2020-12-31T23:59:59"
        },
        "timeIsLocal":{
            "description":"A Boolean flag indicating if the Start/End times represent the local time of the property.",
            "type":"boolean",
            "example":false
        },
        "mustActivateBy":{
            "description":"The time that the record must activate for each Active Time. This should be between startTime and endTime.\n",
            "type":"string",
            "example":"2023-11-17T02:27:39"
        }
    }
}

Nested Schema : items

Type: object

Show Source

columnName: string

Name of the extention field

Example: extension_Column
value: string

value of the extension field

Example: value1

{
    "properties":{
        "columnName":{
            "description":"Name of the extention field",
            "type":"string",
            "example":"extension_Column"
        },
        "value":{
            "description":"value of the extension field",
            "type":"string",
            "example":"value1"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Effectivity Group Added

Root Schema : schema

Type: object

Show Source

changeSetId: integer

The unique reference of the effectivity group.

Example: 1
hierUnitId: integer

Unique hierarchy unit value

Example: 1
objectNum: integer

Object number of the effectivity group

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the effectivity group",
            "type":"integer",
            "example":1
        },
        "changeSetId":{
            "description":"The unique reference of the effectivity group.",
            "type":"integer",
            "example":1
        }
    }
}