REST Object Definitions Configuration Related Objects System Category Object

System Category Object Formats

JSON Format

 {
    "SysCatID": "1",
    "Desc" : {
        "en" : "English description",
        "es" : "Spanish description"
    },
    "FlexForms" : [
        "${FlexFormID}",
        "${FlexFormID}"
    ],
    "SysActs" : [
        {
            "SysActID" : "",
            "IsActive" : true,
            "Desc" : {
                "en" : "English description",
                "es" : "Spanish description"
            },
            "FlexForms" : [
                "${FlexFormID}",
                "${FlexFormID}"
            ]
        }
    ],
    "SubCats" : []
}

System Category Object Properties

Required properties are in bold.

Property Type Description

Desc

object

Contains localized text descriptions for the code.

Each key/pair combination defines a single localized language description. The property name specifies the language code and the value of the property is the corresponding localized description for the language.

FlexForms

collection

Contains a collection for FormIDs associated with the system category.

Not all system categories support rending Flex Forms. Please review the specific system category definition to determine if Flex Forms are supported.

IsActive

boolean

Identifies if the system category is enabled. This field is used to disable an old value so it can no longer be used. However, it is still defined in the system so the application can display the correct information on historical records and reports.

Valid values are:

true - The system category is enabled. This is default value is the property is not specified.
false - The system category is disabled.

SysActs

collection

Contains a collection of system category activity definitions.

Property	Value	Description
Desc	collection	A collection of localized text descriptions for the code. Each key/pair combination defines a single localized language description. The property name specifies the language code and the value of the property is the corresponding localized description for the language.
FlexForms	collection	Contains a collection for FormIDs associated with the system category activity. Not all system categories support rending Flex Forms. Please review the specific system category definition to determine if Flex Forms are supported.
IsActive	boolean	Identifies if the activity is enabled. This field is used to disable an old value so it can no longer be used. However, it is still defined in the system so the application can display the correct information on historical records and reports. Valid values are: true - The activity is enabled. This is default value is the property is not specified. false - The activity is disabled.
SysActID	string	Identifies the unique activity ID.

SysCatID string Specifies the unique system category ID. All top level system category IDs are defined by ServiceMobility and can not be changed.

SubCats

collection

Collection of sub-categories. The SubCats collection follows the exact same format as the parent definition including additional sub-categories.

Not all system categories support sub-categories. Please refer to the specific system category documentation for complete details.