Help Contents

 

System Info

Resource: System Info ( /api/systeminfo )

Allows the retrieval of Enterprise Tester system information (such as the version of Enterprise Tester being used, and the modules that are enabled - information that may be required by client library writers to adjust their system behaviour based on the capabilities of the version of Enterprise Tester being connected to).

Root Relation: SystemInfo

This resource supports the following methods: GET

Methods

GET


Retrieves system information.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturns basic system information (version and module info).

Example - Retrieve System Information

Retrieves the system information (Enterprise Tester version and list of moules, including if a module is enabled/disabled.

Request Headers

KeyValueDescription
Acceptapplication/json

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
    "Version": "4.2.0.0",
    "RootUrl" :"http://localhost/EnterpriseTester/",
    "StaticContentRootUrl" : "http://localhost/EnterpriseTester/Content/",
    "PackagePathSeparator": "|",
    "Modules": {
    "__Plugins__": [
        {
            "TypeName": "EnterpriseTester.Plugins.ActivityStream.ActivityStreamsPluginInstaller, EnterpriseTester Plugins.ActivityStream, Version=4.3.0.0, Culture=neutral, PublicKeyToken=null",
            "Description": "Provides support for Activity Streams",
            "LoadStatus": "Loaded",
            "Name": "Activity Streams",
            "State": "Enabled",
            "SupportsStateChange": true,
            "VendorName": "Catch Limited",
            "VendorUrl": "http://www.catchlimited.com/",
            "Version": "4.3.0.0"
        }
        ...
    ],
    "Activity Streams - Event Builders": [...],
    "Activity Streams - Event To Activity Contributors": [...],
    "Activity Streams - Synchronizer": [...],
    "Authentication": [...] 
    ...
}

Status Code

200 - OK