Custom Intelligence Automation APIs return JSON response objects in the following format:
{ "Data": //..custom response object specific to the API... , "Meta":{ "Result":1, "ErrorCode":0, "ErrorMsg":"" }, "PermissionCtrl":{ "permission":"255", "elements":null }, "FeatureCtrl":{ "mode":"0" }, "SystemCtrl":{ "TmcmSoDist_Role":"none/hub/edge" } }
Where:
Name |
Type |
Description |
---|---|---|
Data |
Object |
Contains the data returned by the specific API For more information about the data returned by a specific API, see Custom Intelligence Automation APIs. |
Meta |
Object |
Indicates the response status, including the result, error code, and error message |
Result |
Integer |
The result code of the response For available values, see Custom Intelligence Automation API Response Codes. |
ErrorCode |
Integer |
The error code of the response For available values, see Custom Intelligence Automation API Response Codes. |
ErrorMsg |
String |
The error message of the response For available descriptions, see Custom Intelligence Automation API Response Codes. |
PermissionCtrl |
Object |
Indicates the permissions assigned to the logged-on user account for accessing Apex Central menu items and features |
permission |
Integer |
|
elements |
String |
The value is always "null" for Custom Intelligence Automation APIs |
FeatureCtrl |
Object |
Indicates the Apex Central deployment model |
mode |
Integer |
|
SystemCtrl |
Object |
Indicates the suspicious object distribution role of the Apex Central server |
TmcmSoDist_Role |
String |
|