Common use of Field Type Description Clause in Contracts

Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. Content- Type String • Data format = JSON, this value is application/json”. • Data format = XML, this value is “application/xml”. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge‌ The Cartridge related APIs include the following: • Cartridge — Get all cartridges’ data • Cartridge — Get all core cartridges’ data • Cartridge — Get all non-core cartridges’ data Cartridge — Get all cartridges’ data‌ • API Name: Get all cartridge’s data • Description: Get data of all cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all core cartridges’ data‌ • API Name: Get all core cartridge’s data • Description: Get data of all the core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/core • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/core • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all non-core cartridges’ data‌ • API Name: Get all non-core cartridge’s data • Description: Get data of all the non-core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/nonCore • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/nonCore Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Registry‌ The Registry related API includes the following: • Registry — Get all registries’ data Registry — Get all registries’ data‌ • API Name: Get all registries’ data • Description: Get data of all registries. • Request type: GET • API path: /api/v1/registry/allRegistries • Sample usage: http://<server>:<port>/api/v1/registry/allRegistries • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Remote client‌ The Remote related API includes the following: • Remote client — Get all remote clients’ data • API Name: Get all remote clients’ data‌ • Description: Get data of all the remote clients. • Request type: GET • API path: /api/v1/remoteClient/allRemoteClients • Sample usage: http://<server>:<port>/api/v1/remoteClient/allRemoteClients • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Rule‌ The Rule related APIs include the following: • Rule — Get all rules’ data • Rule — Get rule by id Rule — Get all rules’ data‌ • API Name: Get all rules’ data • Description: Get data of all rules. • Request type: GET • API path: /api/v1/rule/allRules • Sample usage: http://<server>:<port>/api/v1/rule/allRules • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. error String Error code if some exception occurs; otherwise this field is not shown. Rule — Get rule by id‌ • API Name: Get rule by ID • Description: Filter out rules by a rule ID. • Request type: GET • API path: /api/v1/rule/ruleId • Sample usage: http://<server>:<port>/api/v1/rule/ruleId • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown Script‌ The Script related API includes the following: • Script — Run Script • Script — Publish custom REST API Script — Run Script‌ • API Name: Run Script • Description: You need be granted both the Administrator and API Access roles to use this API. This API is similar to the script console, but it does not support functionHelper, log, and out variables that are supported in the script console. Name Description script The script content. is being used in scripts. • Request type: POST • API path: /api/v1/script/runScript • Sample usage:

Field Type Description. Access- Auth-Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. Content- Type String • Data format = JSON, this value is application/json”. • Data format = XML, this value is “application/xml”. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge‌ The Cartridge related APIs include the following: • Cartridge — Get all cartridges’ data • Cartridge — Get all core cartridges’ data • Cartridge — Get all non-core cartridges’ data Cartridge — Get all cartridges’ data‌ • API Name: Get all cartridge’s data • Description: Get data of all cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all core cartridges’ data‌ • API Name: Get all core cartridge’s data • Description: Get data of all the core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/core • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/core • Header: Field Type Description Access- Auth-Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all non-core cartridges’ data‌ • API Name: Get all non-core cartridge’s data • Description: Get data of all the non-core cartridges. • Request type: GET GET‌ • API path: /api/v1/cartridge/allCartridges/nonCore • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/nonCore • Header: Field Type Description Auth-Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Registry‌ The Registry related API includes the following: • Registry — Get all registries’ data Registry — Get all registries’ data‌ • API Name: Get all registries’ data • Description: Get data of all registries. • Request type: GET • API path: /api/v1/registry/allRegistries • Sample usage: http://<server>:<port>/api/v1/registry/allRegistries • Header: Field Type Description Access- Auth-Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Remote client‌ The Remote related API includes the following: • Remote client — Get all remote clients’ data data‌‌‌ • API Name: Get all remote clients’ data‌ data • Description: Get data of all the remote clients. • Request type: GET • API path: /api/v1/remoteClient/allRemoteClients • Sample usage: http://<server>:<port>/api/v1/remoteClient/allRemoteClients • Header: Field Type Description Access- Auth-Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Rule‌ The Rule related APIs include the following: • Rule — Get all rules’ data • Rule — Get rule by id Rule — Get all rules’ data‌ • API Name: Get all rules’ data • Description: Get data of all rules. • Request type: GET • API path: /api/v1/rule/allRules • Sample usage: http://<server>:<port>/api/v1/rule/allRules • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Rule — Get rule by id‌ • API Name: Get rule by ID • Description: Filter out rules by a rule ID. • Request type: GET • API path: /api/v1/rule/ruleId • Sample usage: http://<server>:<port>/api/v1/rule/ruleId • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown Script‌ The Script related API includes the following: • Script — Run Script • Script — Publish custom REST API Script — Run Script‌ • API Name: Run Script • Description: You need be granted both the Administrator and API Access roles to use this API. This API is similar to the script console, but it does not support functionHelper, log, and out variables that are supported in the script console. Name Description script The script content. is being used in scripts. • Request type: POST • API path: /api/v1/script/runScript • Sample usage:

Field Type Description. Access- Auth-Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. json Content- Type String • Data format = JSON, this value is application/json”. • Data format = XML, this value is “application/xml”. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge‌ Subscribe alarm‌ The Cartridge Subscribe related APIs include the following: • Cartridge Subscribe alarm — Get Disconnect SSE • Subscribe alarm — List SSE • Subscribe alarm — Subscribe alarms by object ID • Subscribe alarm — Subscribe all cartridges’ data • Cartridge alarms Subscribe alarm — Get all core cartridges’ data • Cartridge — Get all non-core cartridges’ data Cartridge — Get all cartridges’ data‌ Disconnect SSE‌ • API Name: Get all cartridge’s data Disconnect SSE • Description: Get data of Disconnect all cartridgesthe active Server-Sent Events (SSE) subscriptions. • Request type: GET • API path: /api/v1/cartridgesubscription/allCartridges disconnect/all/ • Sample usage: http://<server>:<port>/api/v1/cartridgesubscription/allCartridges Accept String Specifies the response data format which can be either applicationdisconnect/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all core cartridges’ data‌ • API Name: Get all core cartridge’s data • Description: Get data of all the core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/core • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/core all/ • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all nonAuth-core cartridges’ data‌ • API Name: Get all non-core cartridge’s data • Description: Get data of all the non-core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/nonCore • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/nonCore Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Registry‌ The Registry related API includes the following: • Registry — Get all registries’ data Registry — Get all registries’ data‌ • API Name: Get all registries’ data • Description: Get data of all registries. • Request type: GET • API path: /api/v1/registry/allRegistries • Sample usage: http://<server>:<port>/api/v1/registry/allRegistries • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Remote client‌ The Remote related API includes the following: • Remote client Subscribe alarm — Get all remote clients’ data List SSE‌ • API Name: Get all remote clients’ data‌ List SSE • Description: Get data of Filter out all the remote clientsactive SSE subscriptions. • Request type: GET • API path: /api/v1/remoteClient/allRemoteClients • Sample usage: http://<server>:<port>/api/v1/remoteClientsubscription/allRemoteClients list • Header: Field Type Description Access- Auth-Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Rule‌ The Rule related APIs include the following: • Rule Subscribe alarm — Get all rules’ data • Rule — Get rule Subscribe alarms by id Rule — Get all rules’ data‌ object ID‌ • API Name: Get all rules’ data • Description: Get data of all rules. • Request type: GET • API path: /api/v1/rule/allRules • Sample usage: http://<server>:<port>/api/v1/rule/allRules • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. error String Error code if some exception occurs; otherwise this field is not shown. Rule — Get rule Subscribe alarms by id‌ • API Name: Get rule by object ID • Description: Filter out rules Watch the topology object by a rule IDits topologyId, and subscribe to alarm-generated events through SSE. • Request type: GET • API path: /api/v1/rule/ruleId • Sample usage: http://<server>:<port>/api/v1/rule/ruleId • Header: Field Type Description Access- Token String The token When the client is retrieved after successfully logging in disconnected, there is no retry mechanism to send an event to the Management client. For more information, visit Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format -Sent Events (JSON/XMLSSE) or exception message. error String Error code if some exception occurs; otherwise this field is not shown Script‌ The Script related API includes the following: • Script — Run Script • Script — Publish custom REST API Script — Run Script‌ • API Name: Run Script • Description: You need be granted both the Administrator Support and API Access roles to use this API. This API is similar to the script console, but it does not support functionHelper, log, and out variables that are supported in the script console. Name Description script The script content. is being used in scripts. • Request type: POST • API path: /api/v1/script/runScript • Sample usage:Server-Sent Events.

Field Type Description. Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. Content- Type String • Data format = JSON, this value is application/json”. • Data format = XML, this value is “application/xml”. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge‌ The Cartridge related APIs include the following: • Cartridge — Get all cartridges’ data • Cartridge — Get all core cartridges’ data • Cartridge — Get all non-core cartridges’ data Cartridge — Get all cartridges’ data‌ • API Name: Get all cartridge’s data • Description: Get data of all cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all core cartridges’ data‌ • API Name: Get all core cartridge’s data • Description: Get data of all the core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/core • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/core • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) exception message. error String Error code if some exception occurs; otherwise this field is not shown. Cartridge — Get all non-core cartridges’ data‌ • API Name: Get all non-core cartridge’s data • Description: Get data of all the non-core cartridges. • Request type: GET • API path: /api/v1/cartridge/allCartridges/nonCore • Sample usage: http://<server>:<port>/api/v1/cartridge/allCartridges/nonCore Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Registry‌ The Registry related API includes the following: • Registry — Get all registries’ data Registry — Get all registries’ data‌ • API Name: Get all registries’ data • Description: Get data of all registries. • Request type: GET • API path: /api/v1/registry/allRegistries • Sample usage: http://<server>:<port>/api/v1/registry/allRegistries • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Remote client‌ The Remote related API includes the following: • Remote client — Get all remote clients’ data • API Name: Get all remote clients’ data‌ • Description: Get data of all the remote clients. • Request type: GET • API path: /api/v1/remoteClient/allRemoteClients • Sample usage: http://<server>:<port>/api/v1/remoteClient/allRemoteClients • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Rule‌ The Rule related APIs include the following: • Rule — Get all rules’ data • Rule — Get rule by id Rule — Get all rules’ data‌ • API Name: Get all rules’ data • Description: Get data of all rules. • Request type: GET • API path: /api/v1/rule/allRules • Sample usage: http://<server>:<port>/api/v1/rule/allRules • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Rule — Get rule by id‌ • API Name: Get rule by ID • Description: Filter out rules by a rule ID. • Request type: GET • API path: /api/v1/rule/ruleId • Sample usage: http://<server>:<port>/api/v1/rule/ruleId • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown Script‌ The Script related API includes the following: • Script — Run Script • Script — Publish custom REST API • Script — Run Script‌ named scripts Script — Run Script‌‌ • API Name: Run Script • Description: You need be granted both the Administrator and API Access roles to use this API. This API is similar to the script console, but it does not support functionHelper, log, and out variables that are supported in the script console. Name Description script The script content. catridgeName Specifies the name of associated cartridge, and the name is case- sensitive. scopeObjectId Specifies the scope object. This item must be set if the scope variable is being used in scripts. This API is disabled by default after the installation. Refer to the REST_DisabledAPI Registry Variable in Table 2 for more information about how to change this configuration. • Request type: POST • API path: /api/v1/script/runScript • Sample usage: