System Categories are a generic framework to define configurable, localized lists or data types for mobile application. Some example system categories are work order types, asset types, time entry categories and line item types. The System Category Mapping REST API is used to create, update or delete system category mapping declarations. ServiceMobility uses mapping definitions at run-time to convert configurable data types from one system to another.

A system category, depending on how it designed to be used by the system, may have child activity definitions, sub categories or both. Please refer to the System Categories related page for more details.

On this page:

Related pages:

Resource URL

Retrieve the details of a specific System Category

GET /seiapi/v3/trans/SystemCategory/Default/${Code}/Mapping

Insert or Update a specific System Category

PUT /seiapi/v3/trans/SystemCategory/Default/${Code}/Mapping

Delete a specific System Category

DELETE /seiapi/v3/trans/SystemCategory/Default/${Code}/Mapping

API Specific Parameters

Parameter	Description
`${Code}`	The unique System Category code.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

API Specifics

Retrieve the details of a specific System Category

URL

GET /seiapi/v3/trans/SystemCategory/Default/${Code}/Mapping

HTTP Request Body

This request does not require a request body.

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a System Category Mapping Object. Otherwise, on error, the response body will contain a descriptive reason for the error.

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" : []
}

Insert or Update a specific System Category

URL

PUT /seiapi/v3/trans/SystemCategory/Default/${Code}/Mapping

HTTP Request Body

The HTTP request body must contain a valid System Category Mapping Object.

HTTP Response

On success the API will return a response code of 200.

Delete a specific System Category

URL

DELETE /seiapi/v3/trans/SystemCategory/Default/${Code}/Mapping

HTTP Request Body

This request does not require a request body.

HTTP Response

On success the API will return a response code of 200.