Reports, Log and Server Schemas

Management.ApplicationSetting


{
  "group": "string",
  "name": "string",
  "type": "string",
  "value": null
}

Properties

Name	Type	Required	Restrictions	Description
group	string¦null	false	none	none
name	string¦null	false	none	none
type	string¦null	false	none	none
value	any	false	none	none

Management.DeleteReportResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.EmailAttachment


{
  "fileName": "string",
  "content": "string",
  "contentType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
fileName	string¦null	false	none	none
content	string(byte)¦null	false	none	none
contentType	string¦null	false	none	none

Management.EmailRecipient


{
  "name": "string",
  "email": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
email	string¦null	false	none	none

Management.GetLogLevelsResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "logLevels": [
    {
      "date": "2019-08-24T14:15:22Z",
      "level": "string",
      "count": 0
    }
  ],
  "groupBy": "string",
  "totalLogLevelEntriesCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
logLevels	[Management.LogLevelInfo]¦null	false	none	none
groupBy	string¦null	false	none	none
totalLogLevelEntriesCount	integer(int32)¦null	false	none	none

Management.GetLogResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "logEntries": [
    {
      "id": 0,
      "message": "string",
      "messageTemplate": "string",
      "level": "string",
      "timeStamp": "2019-08-24T14:15:22Z",
      "exception": "string",
      "properties": "string"
    }
  ],
  "totalLogEntriesCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
logEntries	[Management.LogEntry]¦null	false	none	none
totalLogEntriesCount	integer(int32)¦null	false	none	none

Management.GetReportResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "reports": [
    {
      "id": 0,
      "uid": "string",
      "name": "string",
      "version": "string",
      "date": "2019-08-24T14:15:22Z",
      "userKey": "string",
      "machineId": "string",
      "clientId": "string",
      "clientName": "string",
      "contentType": "string",
      "content": "string",
      "address": "string",
      "geoLocation": "string",
      "properties": [
        {
          "id": 0,
          "name": "string",
          "value": "string",
          "reportId": 0
        }
      ]
    }
  ],
  "totalReportsCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
reports	[Management.Report]¦null	false	none	none
totalReportsCount	integer(int32)¦null	false	none	none

Management.GetServerInfoResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "product": "string",
  "edition": 0,
  "version": "string",
  "license": "string",
  "serverHost": "string",
  "serverTime": "2019-08-24T14:15:22Z",
  "clientAddress": "string",
  "activeTokens": 0,
  "maxTokens": 0,
  "activationTokens": 0,
  "floatingTokens": 0,
  "expiredTokens": 0,
  "totalLicenses": 0,
  "revokedLicenses": 0,
  "tracedLicenses": 0,
  "activationLicenses": 0,
  "floatingLicenses": 0,
  "fileLicenses": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
product	string¦null	false	none	none
edition	integer(int32)¦null	false	none	none
version	string¦null	false	none	none
license	string¦null	false	none	none
serverHost	string¦null	false	none	none
serverTime	string(date-time)¦null	false	none	none
clientAddress	string¦null	false	none	none
activeTokens	integer(int32)¦null	false	none	none
maxTokens	integer(int32)¦null	false	none	none
activationTokens	integer(int32)¦null	false	none	none
floatingTokens	integer(int32)¦null	false	none	none
expiredTokens	integer(int32)¦null	false	none	none
totalLicenses	integer(int32)¦null	false	none	none
revokedLicenses	integer(int32)¦null	false	none	none
tracedLicenses	integer(int32)¦null	false	none	none
activationLicenses	integer(int32)¦null	false	none	none
floatingLicenses	integer(int32)¦null	false	none	none
fileLicenses	integer(int32)¦null	false	none	none

Management.GetSettingsRequest

{}

Properties

None

Management.GetSettingsResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "settings": [
    {
      "group": "string",
      "name": "string",
      "type": "string",
      "value": null
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
settings	[Management.ApplicationSetting]¦null	false	none	none

Management.LogEntry


{
  "id": 0,
  "message": "string",
  "messageTemplate": "string",
  "level": "string",
  "timeStamp": "2019-08-24T14:15:22Z",
  "exception": "string",
  "properties": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
messageTemplate	string¦null	false	none	none
level	string¦null	false	none	none
timeStamp	string(date-time)¦null	false	none	none
exception	string¦null	false	none	none
properties	string¦null	false	none	none

Management.LogLevelInfo


{
  "date": "2019-08-24T14:15:22Z",
  "level": "string",
  "count": 0
}

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	none
level	string¦null	false	none	none
count	integer(int32)	false	none	none

Management.Report


{
  "id": 0,
  "uid": "string",
  "name": "string",
  "version": "string",
  "date": "2019-08-24T14:15:22Z",
  "userKey": "string",
  "machineId": "string",
  "clientId": "string",
  "clientName": "string",
  "contentType": "string",
  "content": "string",
  "address": "string",
  "geoLocation": "string",
  "properties": [
    {
      "id": 0,
      "name": "string",
      "value": "string",
      "reportId": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	none
uid	string¦null	false	none	none
name	string¦null	false	none	none
version	string¦null	false	none	none
date	string(date-time)¦null	false	none	none
userKey	string¦null	false	none	none
machineId	string¦null	false	none	none
clientId	string¦null	false	none	none
clientName	string¦null	false	none	none
contentType	string¦null	false	none	none
content	string¦null	false	none	none
address	string¦null	false	none	none
geoLocation	string¦null	false	none	none
properties	[Management.ReportProperty]¦null	false	none	none

Management.ReportProperty


{
  "id": 0,
  "name": "string",
  "value": "string",
  "reportId": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	none
name	string¦null	false	none	none
value	string¦null	false	none	none
reportId	integer(int32)	false	none	none

Management.ResolveReportLocationsRequest


{
  "reportIds": [
    0
  ],
  "limit": 0
}

Properties

Name	Type	Required	Restrictions	Description
reportIds	[integer]¦null	false	none	none
limit	integer(int32)¦null	false	none	none

Management.ResolveReportLocationsResponse


{
  "success": true,
  "code": 0,
  "message": "string",
  "resolvedCount": 0,
  "unresolvedCount": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none
resolvedCount	integer(int32)¦null	false	none	none
unresolvedCount	integer(int32)¦null	false	none	none

Management.SendEmailRequest


{
  "to": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "subject": "string",
  "body": "string",
  "isHtml": true,
  "attachments": [
    {
      "fileName": "string",
      "content": "string",
      "contentType": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
to	[Management.EmailRecipient]¦null	false	none	none
subject	string¦null	false	none	none
body	string¦null	false	none	none
isHtml	boolean	false	none	none
attachments	[Management.EmailAttachment]¦null	false	none	none

Management.SendEmailResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.SendLicenseEmailRequest


{
  "licenseId": 0,
  "resourceId": 0
}

Properties

Name	Type	Required	Restrictions	Description
licenseId	integer(int32)	false	none	none
resourceId	integer(int32)	false	none	none

Management.SendLicenseEmailResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none

Management.UpdateSettingsRequest


{
  "settings": [
    {
      "group": "string",
      "name": "string",
      "type": "string",
      "value": null
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
settings	[Management.ApplicationSetting]¦null	false	none	none

Management.UpdateSettingsResponse


{
  "success": true,
  "code": 0,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
code	integer(int32)¦null	false	none	none
message	string¦null	false	none	none