Documentation Powered by ReDoc

Central Server REST API (2020.1)

Download OpenAPI specification:Download

Servicetrace GmbH: support@servicetrace.de URL: http://www.servicetrace.de

Specification of all RESTful interfaces, which are intended to be used by 3rd party applications.

Authentication

apiKey

The RESTful web service must accept the API key in the HTTP header.

Security Scheme Type API Key
Header parameter name: x-apikey

System Administration

Get all customers

This resource returns a list of all customers the Servicetracer Central Server manages. \nPrivilege: This resource can be invoked by a system user only.\n

Authorizations:
apiKey

Responses

200

A list of all customers.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/customers
http://localhost/servicetrace/api/CentralServerRestApi.svc/customers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the specified customer

This resource returns the specified customer. \nPrivilege: This resource can be invoked by a system user only.\n

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

The ID (stringified UUID) of the customer to be retrieved.

Responses

200

The specified customer.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/customer/{id}
http://localhost/servicetrace/api/CentralServerRestApi.svc/customer/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "active": true,
  • "baseDir": "string",
  • "city": "string",
  • "country": "string",
  • "description": "string",
  • "street": "string",
  • "timeZone":
    {
    },
  • "zip": "string"
}

Master Data

Get the whole master data tree of a customer

This resource returns the whole master data tree of a customer. The customer is specified via the API key's user. \nPrivilege: Master Data Open.\n

Authorizations:
apiKey
header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The whole master data tree of a customer. The customer is specified via the API key's user.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/masterdata
http://localhost/servicetrace/api/CentralServerRestApi.svc/masterdata

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customer":
    {
    },
  • "systems":
    [
    ],
  • "locations":
    [
    ]
}

Master Data - systems

Get all system of a customer

This resource returns a list of all systems of a customer. The customer is specified via the API key's user. \nPrivilege: Master Data Open.\n

Authorizations:
apiKey
header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of all systems of a customer.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/systems
http://localhost/servicetrace/api/CentralServerRestApi.svc/systems

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the specified system and the contained applications

This resource returns the specified system and the contained applications. \nPrivilege: Master Data Open.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int64>

The ID (database NO) of the system to be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The specified system and the contained applications.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/system/{id}
http://localhost/servicetrace/api/CentralServerRestApi.svc/system/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "__type": "string",
  • "no": 0,
  • "name": "string",
  • "description": "string",
  • "type": 0,
  • "customer":
    {
    },
  • "applications":
    [
    ],
  • "clients":
    [
    ]
}

Master Data - services

Get all services of a customer

This resource returns all services of a customer. The customer is specified via the API key's user. \nPrivilege: Master Data Open.\n

Authorizations:
apiKey
header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of all services.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/services
http://localhost/servicetrace/api/CentralServerRestApi.svc/services

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the specified service

This resource returns the specified service. \nPrivilege: Master Data Open.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int32>

The ID (database NO) of the service to be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The specified service.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/service/{id}
http://localhost/servicetrace/api/CentralServerRestApi.svc/service/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "no": 0,
  • "customer":
    {
    },
  • "name": "string",
  • "description": "string",
  • "locations":
    [
    ],
  • "dataSources":
    [
    ],
  • "serviceTimes":
    [
    ],
  • "plannedDowntimes": "string",
  • "unplannedDowntimes": "string",
  • "excludedMeasurements": "string",
  • "serviceLog":
    [
    ],
  • "timeZone":
    {
    }
}

Get the excluded measurements of the specified service

This resource returns the excluded measurements of the specified service. The excluded measurements are returned as an iCalendar string as specified in Internet Calendaring and Scheduling Core Object Specification (iCalendar). Caution: The iCalendar string must fulfill the String specification in RFC 7159 - The JavaScript Object Notation (JSON) Data Interchange Format (Chapter 7). In particular, all line breaks in the iCalendar string may be replaced by \\n or \\u000a. Please note, in the sake of visualization some RESTful tools replace \\n and \\u000a with a line break. Thus the GET of an iCalendar string may not be used in a further PUT out of the box. Depending of the tools you have to replace the line breaks with \\n or \\u000a manually. \nPrivilege: Master Data Open.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int32>

The ID (database NO) of the service.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The excluded measurements of the specified service. The excluded measurements are returned as an iCalendar string as specified in Internet Calendaring and Scheduling Core Object Specification (iCalendar). Caution: The iCalendar string must fulfill the String specification in RFC 7159 - The JavaScript Object Notation (JSON) Data Interchange Format (Chapter 7). In particular, all line breaks in the iCalendar string may be replaced by \n or \u000a. Please note, in the sake of visualization some RESTful tools replace \n and \u000a with a line break. Thus the GET of an iCalendar string may not be used in a further PUT out of the box. Depending of the tools you have to replace the line breaks with \n or \u000a manually.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/service/{id}/excludedMeasurements
http://localhost/servicetrace/api/CentralServerRestApi.svc/service/{id}/excludedMeasurements

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Set the excluded measurements of the specified service

This resource sets the excluded measurements of the specified service. Thus already existing excluded measurements are overwritten. The excluded measurements are given as an iCalendar string as specified in Internet Calendaring and Scheduling Core Object Specification (iCalendar). Caution: The iCalendar string must fulfill the String specification in RFC 7159 - The JavaScript Object Notation (JSON) Data Interchange Format (Chapter 7). In particular, all line breaks in the iCalendar string may be replaced by \\n or \\u000a. Please note, in the sake of visualization some RESTful tools replace \\n and \\u000a with a line break. Thus the GET of an iCalendar string may not be used in a further PUT out of the box. Depending of the tools you have to replace the line breaks with \\n or \\u000a manually. \nPrivilege: Unplanned Incidents and Service Log Entries Create / Edit.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int32>

The ID (database NO) of the service.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Request Body schema: application/json

The excluded measurements of the specified service. The excluded measurements are given as an iCalendar string as specified in Internet Calendaring and Scheduling Core Object Specification (iCalendar). Caution: The iCalendar string must fulfill the String specification in RFC 7159 - The JavaScript Object Notation (JSON) Data Interchange Format (Chapter 7). In particular, all line breaks in the iCalendar string may be replaced by \n or \u000a. Please note, in the sake of visualization some RESTful tools replace \n and \u000a with a line break. Thus the GET of an iCalendar string may not be used in a further PUT out of the box. Depending of the tools you have to replace the line breaks with \n or \u000a manually.

string (iCalendarString)

Responses

200

The excluded measurements have been set successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/service/{id}/excludedMeasurements
http://localhost/servicetrace/api/CentralServerRestApi.svc/service/{id}/excludedMeasurements

Request samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Get the planned down times of the specified service

This resource returns the planned down times of the specified service. The planned down times are returned as an iCalendar string as specified in Internet Calendaring and Scheduling Core Object Specification (iCalendar). Caution: The iCalendar string must fulfill the String specification in RFC 7159 - The JavaScript Object Notation (JSON) Data Interchange Format (Chapter 7). In particular, all line breaks in the iCalendar string may be replaced by \\n or \\u000a. Please note, in the sake of visualization some RESTful tools replace \\n and \\u000a with a line break. Thus the GET of an iCalendar string may not be used in a further PUT out of the box. Depending of the tools you have to replace the line breaks with \\n or \\u000a manually. \n Privilege: Master Data Open.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int32>

The ID (database NO) of the service.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The planned down times of the specified service. The planned down times are returned as an iCalendar string as specified in Internet Calendaring and Scheduling Core Object Specification (iCalendar). Caution: The iCalendar string must fulfill the String specification in RFC 7159 - The JavaScript Object Notation (JSON) Data Interchange Format (Chapter 7). In particular, all line breaks in the iCalendar string may be replaced by \n or \u000a. Please note, in the sake of visualization some RESTful tools replace \n and \u000a with a line break. Thus the GET of an iCalendar string may not be used in a further PUT out of the box. Depending of the tools you have to replace the line breaks with \n or \u000a manually.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/service/{id}/plannedDownTimes
http://localhost/servicetrace/api/CentralServerRestApi.svc/service/{id}/plannedDownTimes

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Set the planned down times of the specified service

This resource sets the planned down times of the specified service. Thus already existing planned down times are overwritten. The planned down times are given as an iCalendar string as specified in Internet Calendaring and Scheduling Core Object Specification (iCalendar). Caution: The iCalendar string must fulfill the String specification in RFC 7159 - The JavaScript Object Notation (JSON) Data Interchange Format (Chapter 7). In particular, all line breaks in the iCalendar string may be replaced by \\n or \\u000a. Please note, in the sake of visualization some RESTful tools replace \\n and \\u000a with a line break. Thus the GET of an iCalendar string may not be used in a further PUT out of the box. Depending of the tools you have to replace the line breaks with \\n or \\u000a manually. \nPrivilege: Service Create / Edit.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int32>

The ID (database NO) of the service.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Request Body schema: application/json

The planned down times of the specified service. The planned down times are given as an iCalendar string as specified in Internet Calendaring and Scheduling Core Object Specification (iCalendar). Caution: The iCalendar string must fulfill the String specification in RFC 7159 - The JavaScript Object Notation (JSON) Data Interchange Format (Chapter 7). In particular, all line breaks in the iCalendar string may be replaced by \n or \u000a. Please note, in the sake of visualization some RESTful tools replace \n and \u000a with a line break. Thus the GET of an iCalendar string may not be used in a further PUT out of the box. Depending of the tools you have to replace the line breaks with \n or \u000a manually.

string

Responses

200

The planned down times have been set successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/service/{id}/plannedDownTimes
http://localhost/servicetrace/api/CentralServerRestApi.svc/service/{id}/plannedDownTimes

Request samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Control Center - robots

Get all robots of a customer

This resource returns a list of all robots of a customer. The customer is specified via the API key's user. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of all robots of a customer.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/robots
http://localhost/servicetrace/api/CentralServerRestApi.svc/robots

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the specified robot

This resource returns the specified robot. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

The ID (stringified UUID) of the robot to be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The specified robot.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/robot/{id}
http://localhost/servicetrace/api/CentralServerRestApi.svc/robot/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "displayName": "string",
  • "description": "string",
  • "robotVersion": "string",
  • "hostName": "string",
  • "ipAddress": "string",
  • "customer":
    {
    },
  • "addedSince": "2020-08-18T15:37:00Z",
  • "osVersion": "string",
  • "cpuInfo": "string",
  • "totalMemory": 0,
  • "totalMemoryDescription": "string",
  • "configVersion": 0,
  • "systemLanguage": 0,
  • "systemLanguageDescription": "string",
  • "timezone": "string",
  • "isScheduling": true,
  • "state": "OK",
  • "errorState": "string",
  • "stateDisplayName": "string",
  • "stations":
    [
    ],
  • "stationStr": "string",
  • "interactWithDesktop": true,
  • "multiTracerEnabled": true,
  • "multiTracerLicenses": 0,
  • "moduleType": "END_TO_END",
  • "vcIsEnabled": true,
  • "vcThreshold": 0,
  • "vcThresholdDescription": "string"
}

Get robots by types

This resource returns a list of robots for the specified module types.

Authorizations:
apiKey
query Parameters
typeList
integer <int32>
Enum: "EndToEnd" "TestAutomation" "Shared"

Comma-separated list of the following module types: \EndToEnd (0), \TestAutomation (1), \Shared (2).

Responses

200

List of robots.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/robotsByType
http://localhost/servicetrace/api/CentralServerRestApi.svc/robotsByType

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Control Center - schedules

Get all schedules of a customer

This resource returns a list of all schedules of a customer. The customer is specified via the API key's user. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of all schedules of a customer. The customer is specified via the API key's user.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/schedules
http://localhost/servicetrace/api/CentralServerRestApi.svc/schedules

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the specified schedule

This resource returns the specified schedule. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

The ID (stringified UUID) of the schedule to be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The specified schedule.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/schedule/{id}
http://localhost/servicetrace/api/CentralServerRestApi.svc/schedule/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "scheduleID": "string",
  • "scheduleName": "string",
  • "description": "string",
  • "customer": "string",
  • "isContinueOnFailure": true,
  • "mode": "DESKTOP_AS_LOGGED_IN_USER",
  • "triggerDefinition":
    {
    },
  • "isRequiresShell": true,
  • "screenResolution": "string",
  • "user": "string",
  • "password": "string",
  • "isExclusive": true,
  • "isActive": true,
  • "workflowCount": 0,
  • "workflows":
    [
    ]
}

Starts the specified schedule on the given robot

This resource starts a specified schedule on the given robot. \nPrivilege: Schedules Deploy.\n

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

The ID (stringified UUID) schedule to be executed.

query Parameters
robotId
string <uuid>

The ID (stringified UUID) of the robot, the schedule schould be processed.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

This resource returns the respective task ID (stringified UUID).

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/schedule/{id}/start
http://localhost/servicetrace/api/CentralServerRestApi.svc/schedule/{id}/start

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Stops the specified schedule on the given robot

This resource stops the specified schedule on the given robot. \nPrivilege: Schedules Deploy.\n

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

The ID (stringified UUID) schedule to be paused.

query Parameters
robotId
string <uuid>

The ID (stringified UUID) of the robot, the schedule schould be paused.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

This resource returns the respective task ID (stringified UUID).

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/schedule/{id}/stop
http://localhost/servicetrace/api/CentralServerRestApi.svc/schedule/{id}/stop

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Redeploy workflows - within a schedule

This resource redeploy workflows of a schedule, which are already deployed in another revision. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

The schedule's ID (stringified UUID).

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Request Body schema: application/json

A string to describe your changes (Changelog).

string (string)

Responses

200

The workflows have been redeployed successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/schedule/{id}/redeploy
http://localhost/servicetrace/api/CentralServerRestApi.svc/schedule/{id}/redeploy

Request samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Get the run results of the specified schedule by count

This resource returns count schedule run results until a specified timestamp. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

The schedule's ID (stringified UUID).

query Parameters
robotId
string <uuid>

The ID (stringified UUID) of the robot, the schedule run results should be retrieved from.

runResultFilter
integer <int32>

The run result filter. The following filter are supported: SUCCESS(1), SKIPPED(2), TIMEOUT(3), EXECUTION_FAILURE(4), ABORTED(5), NO_LICENSE(6), WRONG_VERSION(7), UNKNOWN(8), DEACTIVATED(9), SUSPENDED(10), WARNING(11), RUNNING(12), FAILED(13).

count
integer <int64>

The number of run results to be retrieved. These are the last N run results up to the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which run results should be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of count schedule run results until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/schedule/{id}/runResultsCount
http://localhost/servicetrace/api/CentralServerRestApi.svc/schedule/{id}/runResultsCount

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the run results of the specified schedule by hours

This resource returns schedule run results of the last N hours until a specified timestamp. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
path Parameters
id
required
string <uuid>

The schedule's ID (stringified UUID).

query Parameters
robotId
string <uuid>

The ID (stringified UUID) of the robot, the schedule run results should be retrieved from.

runResultFilter
integer <int32>

The run result filter. The following filter are supported: SUCCESS(1), SKIPPED(2), TIMEOUT(3), EXECUTION_FAILURE(4), ABORTED(5), NO_LICENSE(6), WRONG_VERSION(7), UNKNOWN(8), DEACTIVATED(9), SUSPENDED(10), WARNING(11), RUNNING(12), FAILED(13).

count
integer <int64>

The maximum number of run results to be retrieved.

hours
integer <int64>

The timespan in hours to be retrieved. These are all schedule run results within N hours until the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which run results should be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of schedule run results of the last N hours until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/schedule/{id}/runResultsHours
http://localhost/servicetrace/api/CentralServerRestApi.svc/schedule/{id}/runResultsHours

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Control Center - workflows

Get the run results of all workflows by count

This resource returns count workflow run results until a specified timestamp over all workflows, robots and run results.

Privilege: Simple Workflow Run Results Read.

Authorizations:
apiKey
query Parameters
count
integer <int64>

The number of run results to be retrieved. These are the last N run results up to the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which run results should be retrieved. The timestamp string is given as specified by RFC 3339 or ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of count workflow run results until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/workflows/runResultsCount
http://localhost/servicetrace/api/CentralServerRestApi.svc/workflows/runResultsCount

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the run results of all workflows by hours

This resource returns workflow run results of the last N hours until a specified timestamp over all workflows, robots and run results.

Privilege: Simple Workflow Run Results Read.

Authorizations:
apiKey
query Parameters
count
integer <int64>

The maximum number of run results to be retrieved.

hours
integer <int64>

The timespan in hours to be retrieved. These are all run results within N hours until the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which run results should be retrieved. The timestamp string is given as specified by RFC 3339 or ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of worfkow run results of the last N hours until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/workflows/runResultsHours
http://localhost/servicetrace/api/CentralServerRestApi.svc/workflows/runResultsHours

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the run results including the measurements of all workflows by count

This resource returns count workflow run results until a specified timestamp over all workflows, robots and run results. The run results contain the respective measurement data.

Privilege: Simple Workflow Run Results Read.

Authorizations:
apiKey
query Parameters
count
integer <int64>

The number of run results to be retrieved. These are the last N run results up to the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which run results should be retrieved. The timestamp string is given as specified by RFC 3339 or ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of count workflow run results until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/workflows/runResultsCountMeasurement
http://localhost/servicetrace/api/CentralServerRestApi.svc/workflows/runResultsCountMeasurement

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get the run results including the measurements of all workflows by hours

This resource returns workflow run results of the last N hours until a specified timestamp over all workflows, robots and run results. The run results contain the respective measurement data.

Privilege: Simple Workflow Run Results Read.

Authorizations:
apiKey
query Parameters
count
integer <int64>

The maximum number of run results to be retrieved.

hours
integer <int64>

The timespan in hours to be retrieved. These are all run results within N hours until the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which run results should be retrieved. The timestamp string is given as specified by RFC 3339 or ISO 8601 (yyyy-MM-dd'T'HH:mm:ss.SSSZ).

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of worfkow run results of the last N hours until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/workflows/runResultsHoursMeasurement
http://localhost/servicetrace/api/CentralServerRestApi.svc/workflows/runResultsHoursMeasurement

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get workflows by type

This resource returns a list of workflows for the specified module type.

Authorizations:
apiKey
path Parameters
type
required
integer

The module type: \EndToEnd (0), \TestAutomation (1), \Shared (2).

Responses

200

A list of worfkows for the specified type.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/workflowsByType/{type}
http://localhost/servicetrace/api/CentralServerRestApi.svc/workflowsByType/{type}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get server based variables of a workflow

Gets the server based variables of the specified workflow.

Authorizations:
apiKey
path Parameters
workflowId
required
integer <int32>

The workflow ID.

rev
required
integer <int32>

The revision.

Responses

200

The server based variables of the workflow.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/workflows/{workflowId}/revisions/{rev}
http://localhost/servicetrace/api/CentralServerRestApi.svc/workflows/{workflowId}/revisions/{rev}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ColumnHeader":
    [
    ],
  • "Rows":
    [
    ]
}

Update Workflow Configuration

Updates the server based variables of a workflow. Privilege: ConfigTablesContentDelete and ConfigTablesContentEdit.

Authorizations:
apiKey
path Parameters
revId
required
integer <int32>
Request Body schema: application/json
key
required
integer <int32>
value
required
object (ConfigurationTable)

Responses

200

Update Successful. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/workflowConfiguration/{revId}
http://localhost/servicetrace/api/CentralServerRestApi.svc/workflowConfiguration/{revId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": 0,
  • "value":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Control Center

Get the analysis package of the specified workflow run as a ZIP file

This resource returns a ZIP file of the specified analysis package. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
query Parameters
workflowRunId
required
string <uuid>

The ID (UUID) of the workflow run, from which the analysis package should be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The analysis package of the specified workflow run as a ZIP file.

get/analysisPackage
http://localhost/servicetrace/api/CentralServerRestApi.svc/analysisPackage

Get the most recent analysis package of the specified workflow as a ZIP file

This resource returns a ZIP file of the most recent analysis package (of the latest execution) of the specified workflow. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The most recent analysis package (of the latest execution) of the specified workflow as a ZIP file.

get/lastAnalysisPackage
http://localhost/servicetrace/api/CentralServerRestApi.svc/lastAnalysisPackage

Test Automation - projects

Create a new project

This resource creates a project.\nPrivilege: ProjectCreateEdit.\n

Authorizations:
apiKey
Request Body schema: application/json

The project to be created

id
required
integer <int64>
name
required
string
description
string
projectOwner
string
testManager
string
productOwner
string

Responses

200

The newly created project.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

post/projects
http://localhost/servicetrace/api/CentralServerRestApi.svc/projects

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "projectOwner": "string",
  • "testManager": "string",
  • "productOwner": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "projectOwner": "string",
  • "testManager": "string",
  • "productOwner": "string"
}

Update a project

This resource updates the given project.\nPrivilege: ProjectCreateEdit.\n

Authorizations:
apiKey
path Parameters
projectID
required
integer <int64>

The project ID (stringified integer).

Request Body schema: application/json

The project to be updated

id
required
integer <int64>
name
required
string
description
string
projectOwner
string
testManager
string
productOwner
string

Responses

200

The specified project has been updated successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/projects/{projectID}
http://localhost/servicetrace/api/CentralServerRestApi.svc/projects/{projectID}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "projectOwner": "string",
  • "testManager": "string",
  • "productOwner": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Delete the specified projects

This resource deletes the given projects.\nPrivilege: ProjectDelete.\n

Authorizations:
apiKey
Request Body schema: application/json

A list of IDs of projects, which should be deleted.

Array
string <int64> (integer)

Responses

200

All specified projects have been deleted successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

post/projects/delete
http://localhost/servicetrace/api/CentralServerRestApi.svc/projects/delete

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Test Automation - versions

Create a new version

This resource creates a version.\nPrivilege: UseCaseCreateEdit.\n

Authorizations:
apiKey
query Parameters
copyLabels
boolean

When the version to be created is a copy of another version, you need to define, if you want to copy the requirement labels as well.

Request Body schema: application/json

The version to be created

id
required
integer <int64>
name
required
string
description
string
projectId
required
integer <int64>
cloneVersionId
integer <int64>
requirementLabels
Array of objects (RequirementLabel)

Responses

200

The newly created version.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

post/versions
http://localhost/servicetrace/api/CentralServerRestApi.svc/versions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "projectId": 0,
  • "cloneVersionId": 0,
  • "requirementLabels":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "projectId": 0,
  • "cloneVersionId": 0,
  • "requirementLabels":
    [
    ]
}

Update a version

This resource updates the given version.\nPrivilege: UseCaseCreateEdit.\n

Authorizations:
apiKey
path Parameters
versionID
required
string <int64>

The version ID (stringified integer).

Request Body schema: application/json

The version to be updated

id
required
integer <int64>
name
required
string
description
string
projectId
required
integer <int64>
cloneVersionId
integer <int64>
requirementLabels
Array of objects (RequirementLabel)

Responses

200

The specified version has been updated successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/versions/{versionID}
http://localhost/servicetrace/api/CentralServerRestApi.svc/versions/{versionID}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "projectId": 0,
  • "cloneVersionId": 0,
  • "requirementLabels":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Test Automation - user stories

Create a new user story

This resource creates a user story.\nPrivilege: UseCaseCreateEdit.\n

Authorizations:
apiKey
Request Body schema: application/json

The user story to be created

id
required
integer <int64>
name
required
string
description
string
reference
string
link
string
acceptanceCriteria
Array of objects (TestCases)
versionId
required
integer <int64>
testplanId
required
integer <int64>
hasAcceptanceCriteria
required
boolean
status
required
string (TaStatus)
Enum: "Not Ready" "Ready" "Disabled"

TestPlanStatus: Not Ready (1), Ready (2), Disabled (3)

visibleId
required
string
result
required
integer <int32> (RunResult)
Enum: "SUCCESS" "SKIPPED" "TIMEOUT" "EXECUTION_FAILURE" "ABORTED" "NO_LICENSE" "WRONG_VERSION" "UNKNOWN" "DEACTIVATED" "SUSPENDED" "WARNING" "RUNNING" "FAILED"

RunResult: SUCCESS (1), SKIPPED (2), TIMEOUT (3), EXECUTION_FAILURE (4), ABORTED (5), NO_LICENSE (6), WRONG_VERSION (7), UNKNOWN (8), DEACTIVATED (9), SUSPENDED (10), WARNING (11), RUNNING (12), FAILED (13)

Responses

200

The newly created user story.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

post/userStories
http://localhost/servicetrace/api/CentralServerRestApi.svc/userStories

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "reference": "string",
  • "link": "string",
  • "acceptanceCriteria":
    [
    ],
  • "versionId": 0,
  • "testplanId": 0,
  • "hasAcceptanceCriteria": true,
  • "status": "Not Ready",
  • "visibleId": "string",
  • "result": "SUCCESS"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "reference": "string",
  • "link": "string",
  • "acceptanceCriteria":
    [
    ],
  • "versionId": 0,
  • "testplanId": 0,
  • "hasAcceptanceCriteria": true,
  • "status": "Not Ready",
  • "visibleId": "string",
  • "result": "SUCCESS"
}

Update a user story

This resource updates the given user story.\nPrivilege: UseCaseCreateEdit.\n

Authorizations:
apiKey
path Parameters
userStoryID
required
string <int64>

The user story ID (stringified integer).

Request Body schema: application/json

The user story to be updated

id
required
integer <int64>
name
required
string
description
string
reference
string
link
string
acceptanceCriteria
Array of objects (TestCases)
versionId
required
integer <int64>
testplanId
required
integer <int64>
hasAcceptanceCriteria
required
boolean
status
required
string (TaStatus)
Enum: "Not Ready" "Ready" "Disabled"

TestPlanStatus: Not Ready (1), Ready (2), Disabled (3)

visibleId
required
string
result
required
integer <int32> (RunResult)
Enum: "SUCCESS" "SKIPPED" "TIMEOUT" "EXECUTION_FAILURE" "ABORTED" "NO_LICENSE" "WRONG_VERSION" "UNKNOWN" "DEACTIVATED" "SUSPENDED" "WARNING" "RUNNING" "FAILED"

RunResult: SUCCESS (1), SKIPPED (2), TIMEOUT (3), EXECUTION_FAILURE (4), ABORTED (5), NO_LICENSE (6), WRONG_VERSION (7), UNKNOWN (8), DEACTIVATED (9), SUSPENDED (10), WARNING (11), RUNNING (12), FAILED (13)

Responses

200

The specified user story has been updated successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/userStories/{userStoryID}
http://localhost/servicetrace/api/CentralServerRestApi.svc/userStories/{userStoryID}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "reference": "string",
  • "link": "string",
  • "acceptanceCriteria":
    [
    ],
  • "versionId": 0,
  • "testplanId": 0,
  • "hasAcceptanceCriteria": true,
  • "status": "Not Ready",
  • "visibleId": "string",
  • "result": "SUCCESS"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Test Automation - test plans

Get all test plans of a customer

This resource returns a list of all test plans of a customer. The customer is specified via the API key's user. \nPrivilege: TestAutomation Management Open.\n

Authorizations:
apiKey
header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of all test plans of a customer. The customer is specified via the API key's user.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/testPlans
http://localhost/servicetrace/api/CentralServerRestApi.svc/testPlans

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Create a new test plan

This resource returns the created test plan.\nPrivilege: TestplanCreateEdit.\n

Authorizations:
apiKey
Request Body schema: application/json

The test plan to be created

id
required
integer <int64>
name
required
string
description
string
executionType
required
string (ExecutionType)
Enum: "SCHEDULED" "ENQUEUE" "MANUAL"

ExecutionType: SCHEDULED ("Scheduled", 0), ENQUEUE ("Enqueue", 1), MANUAL ("Manual", 2)

versionId
required
integer <int64>
userStories
Array of objects (UserStories)
continueOnFailure
required
boolean
user
string
password
string
sessionMode
required
integer <int32> (SessionMode)
Enum: "DESKTOP_AS_LOGGED_IN_USER" "DESKTOP_AS_SYSTEM" "DESKTOP_AS_USER" "SESSION_AS_DEFAULT" "SESSION_AS_USER"

SessionMode: DESKTOP_AS_LOGGED_IN_USER (1), DESKTOP_AS_SYSTEM (2), DESKTOP_AS_USER (3), SESSION_AS_DEFAULT (4), SESSION_AS_USER (5)

requiresShell
required
boolean
exclusive
required
boolean
screenResolution
string
status
required
string (TaStatus)
Enum: "Not Ready" "Ready" "Disabled"

TestPlanStatus: Not Ready (1), Ready (2), Disabled (3)

Responses

200

The newly created test plan.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

post/testPlans
http://localhost/servicetrace/api/CentralServerRestApi.svc/testPlans

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "executionType": "SCHEDULED",
  • "versionId": 0,
  • "userStories":
    [
    ],
  • "continueOnFailure": true,
  • "user": "string",
  • "password": "string",
  • "sessionMode": "DESKTOP_AS_LOGGED_IN_USER",
  • "requiresShell": true,
  • "exclusive": true,
  • "screenResolution": "string",
  • "status": "Not Ready"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "executionType": "SCHEDULED",
  • "versionId": 0,
  • "userStories":
    [
    ],
  • "continueOnFailure": true,
  • "user": "string",
  • "password": "string",
  • "sessionMode": "DESKTOP_AS_LOGGED_IN_USER",
  • "requiresShell": true,
  • "exclusive": true,
  • "screenResolution": "string",
  • "status": "Not Ready"
}

Update a test plan

This resource updates the given test plan.\nPrivilege: TestplanCreateEdit.\n

Authorizations:
apiKey
path Parameters
testPlanID
required
string <int64>

The test plan ID (stringified integer).

Request Body schema: application/json

The test plan to be updated

id
required
integer <int64>
name
required
string
description
string
executionType
required
string (ExecutionType)
Enum: "SCHEDULED" "ENQUEUE" "MANUAL"

ExecutionType: SCHEDULED ("Scheduled", 0), ENQUEUE ("Enqueue", 1), MANUAL ("Manual", 2)

versionId
required
integer <int64>
userStories
Array of objects (UserStories)
continueOnFailure
required
boolean
user
string
password
string
sessionMode
required
integer <int32> (SessionMode)
Enum: "DESKTOP_AS_LOGGED_IN_USER" "DESKTOP_AS_SYSTEM" "DESKTOP_AS_USER" "SESSION_AS_DEFAULT" "SESSION_AS_USER"

SessionMode: DESKTOP_AS_LOGGED_IN_USER (1), DESKTOP_AS_SYSTEM (2), DESKTOP_AS_USER (3), SESSION_AS_DEFAULT (4), SESSION_AS_USER (5)

requiresShell
required
boolean
exclusive
required
boolean
screenResolution
string
status
required
string (TaStatus)
Enum: "Not Ready" "Ready" "Disabled"

TestPlanStatus: Not Ready (1), Ready (2), Disabled (3)

Responses

200

The specified test plan has been updated successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/testPlans/{testPlanID}
http://localhost/servicetrace/api/CentralServerRestApi.svc/testPlans/{testPlanID}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "executionType": "SCHEDULED",
  • "versionId": 0,
  • "userStories":
    [
    ],
  • "continueOnFailure": true,
  • "user": "string",
  • "password": "string",
  • "sessionMode": "DESKTOP_AS_LOGGED_IN_USER",
  • "requiresShell": true,
  • "exclusive": true,
  • "screenResolution": "string",
  • "status": "Not Ready"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Get the specified test plan

This resource returns the specified test plan. \nPrivilege: TestAutomation Management Open.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int64>

The ID (database NO) of the test plan to be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The specified test plan

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/testPlan/{id}
http://localhost/servicetrace/api/CentralServerRestApi.svc/testPlan/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "executionType": "SCHEDULED",
  • "versionId": 0,
  • "userStories":
    [
    ],
  • "continueOnFailure": true,
  • "user": "string",
  • "password": "string",
  • "sessionMode": "DESKTOP_AS_LOGGED_IN_USER",
  • "requiresShell": true,
  • "exclusive": true,
  • "screenResolution": "string",
  • "status": "Not Ready"
}

Execute the specified testplan

This resource returns the run ID for the started test plan. \nPrivilege: TestAutomation Management Open.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int64>

The test plan's ID (database NO) to be executed.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Request Body schema: application/json

A list of robots, i.e. robot IDs (stringified UUIDs), the specified test should be executed.

Array
string <uuid>

Responses

200

This resource returns the test plan's run ID (stringified UUID).

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/testPlan/{id}/execute
http://localhost/servicetrace/api/CentralServerRestApi.svc/testPlan/{id}/execute

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Execute the specified test plan with varying variables

Execute the specified test plan and specify server based variables to be overwritten for this run.\n\nPrivilege: TestAutomation Management Open.\n

Authorizations:
apiKey
path Parameters
id
required
integer <int64>

The test plan's ID (database NO) to be executed.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Request Body schema: application/json

The execution parameters.

robotId
string <uuid>

The robot, which should execute the current test plan.

serverBasedVariables
required
Array of objects

The server based variables, which should be overwritten for the current test plan execution.

Responses

200

The test plan's run ID (stringified UUID).

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

post/testPlan/{id}/execute
http://localhost/servicetrace/api/CentralServerRestApi.svc/testPlan/{id}/execute

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "robotId": "string",
  • "serverBasedVariables":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Get the specified run result of the given test plan

This resource returns the specified run result of the given test plan. The required path parameter testPlanRunId is returned by the resource /testPlan/{id}/execute. \nPrivilege: TestAutomation Management Open.\n

Authorizations:
apiKey
path Parameters
testPlanRunId
required
string <uuid>

The test plan run ID (stringified UUID).

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The specified run results.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/testPlanRun/{testPlanRunId}
http://localhost/servicetrace/api/CentralServerRestApi.svc/testPlanRun/{testPlanRunId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Test Automation - test cases

Create a new test case

This resource creates a test case.\nPrivilege: UseCaseCreateEdit.\n

Authorizations:
apiKey
path Parameters
userStoryID
required
string <int64>

The user story ID (stringified integer).

Request Body schema: application/json

The test case to be created

id
required
integer <int64>
name
required
string
description
string
userStoryId
required
integer <int64>
sortId
required
integer <int32>
workflowId
required
string
revision
required
integer <int64>
maxRunTime
required
integer <int64>
workflowName
required
string
severity
required
integer <int32>
preconditionDescription
string
postconditionDescription
string
status
required
string (TaStatus)
Enum: "Not Ready" "Ready" "Disabled"

TestPlanStatus: Not Ready (1), Ready (2), Disabled (3)

visibleId
required
string
ownerName
string
ownerId
string
requirementLabels
Array of objects (RequirementLabels)
workflowRunDetails
required
Array of objects (WorkflowRunDetails)
isPending
required
boolean
lastStartTime
required
string <date-time>
result
required
integer <int32> (RunResult)
Enum: "SUCCESS" "SKIPPED" "TIMEOUT" "EXECUTION_FAILURE" "ABORTED" "NO_LICENSE" "WRONG_VERSION" "UNKNOWN" "DEACTIVATED" "SUSPENDED" "WARNING" "RUNNING" "FAILED"

RunResult: SUCCESS (1), SKIPPED (2), TIMEOUT (3), EXECUTION_FAILURE (4), ABORTED (5), NO_LICENSE (6), WRONG_VERSION (7), UNKNOWN (8), DEACTIVATED (9), SUSPENDED (10), WARNING (11), RUNNING (12), FAILED (13)

hasPackage
required
boolean
workflowRunID
required
string
workflowMessage
string
testRunData
Array of objects
enabled
required
boolean

Responses

200

The newly created test case.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

post/userStories/{userStoryID}/testCases
http://localhost/servicetrace/api/CentralServerRestApi.svc/userStories/{userStoryID}/testCases

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "userStoryId": 0,
  • "sortId": 0,
  • "workflowId": "string",
  • "revision": 0,
  • "maxRunTime": 0,
  • "workflowName": "string",
  • "severity": 0,
  • "preconditionDescription": "string",
  • "postconditionDescription": "string",
  • "status": "Not Ready",
  • "visibleId": "string",
  • "ownerName": "string",
  • "ownerId": "string",
  • "requirementLabels":
    [
    ],
  • "workflowRunDetails":
    [
    ],
  • "isPending": true,
  • "lastStartTime": "2020-08-18T15:37:00Z",
  • "result": "SUCCESS",
  • "hasPackage": true,
  • "workflowRunID": "string",
  • "workflowMessage": "string",
  • "testRunData":
    [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "userStoryId": 0,
  • "sortId": 0,
  • "workflowId": "string",
  • "revision": 0,
  • "maxRunTime": 0,
  • "workflowName": "string",
  • "severity": 0,
  • "preconditionDescription": "string",
  • "postconditionDescription": "string",
  • "status": "Not Ready",
  • "visibleId": "string",
  • "ownerName": "string",
  • "ownerId": "string",
  • "requirementLabels":
    [
    ],
  • "workflowRunDetails":
    [
    ],
  • "isPending": true,
  • "lastStartTime": "2020-08-18T15:37:00Z",
  • "result": "SUCCESS",
  • "hasPackage": true,
  • "workflowRunID": "string",
  • "workflowMessage": "string",
  • "testRunData":
    [
    ],
  • "enabled": true
}

Update a test case

This resource updates the given test case.\nPrivilege: UseCaseCreateEdit.\n

Authorizations:
apiKey
path Parameters
userStoryID
required
string <int64>

The user story ID (stringified integer).

testCaseID
required
string <int64>

The test case ID (stringified integer).

Request Body schema: application/json

The test case to be updated

id
required
integer <int64>
name
required
string
description
string
userStoryId
required
integer <int64>
sortId
required
integer <int32>
workflowId
required
string
revision
required
integer <int64>
maxRunTime
required
integer <int64>
workflowName
required
string
severity
required
integer <int32>
preconditionDescription
string
postconditionDescription
string
status
required
string (TaStatus)
Enum: "Not Ready" "Ready" "Disabled"

TestPlanStatus: Not Ready (1), Ready (2), Disabled (3)

visibleId
required
string
ownerName
string
ownerId
string
requirementLabels
Array of objects (RequirementLabels)
workflowRunDetails
required
Array of objects (WorkflowRunDetails)
isPending
required
boolean
lastStartTime
required
string <date-time>
result
required
integer <int32> (RunResult)
Enum: "SUCCESS" "SKIPPED" "TIMEOUT" "EXECUTION_FAILURE" "ABORTED" "NO_LICENSE" "WRONG_VERSION" "UNKNOWN" "DEACTIVATED" "SUSPENDED" "WARNING" "RUNNING" "FAILED"

RunResult: SUCCESS (1), SKIPPED (2), TIMEOUT (3), EXECUTION_FAILURE (4), ABORTED (5), NO_LICENSE (6), WRONG_VERSION (7), UNKNOWN (8), DEACTIVATED (9), SUSPENDED (10), WARNING (11), RUNNING (12), FAILED (13)

hasPackage
required
boolean
workflowRunID
required
string
workflowMessage
string
testRunData
Array of objects
enabled
required
boolean

Responses

200

The specified test case has been updated successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/userStories/{userStoryID}/testCases/{testCaseID}
http://localhost/servicetrace/api/CentralServerRestApi.svc/userStories/{userStoryID}/testCases/{testCaseID}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "userStoryId": 0,
  • "sortId": 0,
  • "workflowId": "string",
  • "revision": 0,
  • "maxRunTime": 0,
  • "workflowName": "string",
  • "severity": 0,
  • "preconditionDescription": "string",
  • "postconditionDescription": "string",
  • "status": "Not Ready",
  • "visibleId": "string",
  • "ownerName": "string",
  • "ownerId": "string",
  • "requirementLabels":
    [
    ],
  • "workflowRunDetails":
    [
    ],
  • "isPending": true,
  • "lastStartTime": "2020-08-18T15:37:00Z",
  • "result": "SUCCESS",
  • "hasPackage": true,
  • "workflowRunID": "string",
  • "workflowMessage": "string",
  • "testRunData":
    [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Reorder test cases in user story

This resource reorders the given test cases in the user story.

Authorizations:
apiKey
path Parameters
userStoryID
required
string <int64>

The user story ID (stringified integer).

Request Body schema: application/json

A list of test cases, i.e. test case IDs (stringified integers).

Array
string <int64>

Responses

200

Update Successful. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/userStories/{userStoryID}/testCases/updateOrder
http://localhost/servicetrace/api/CentralServerRestApi.svc/userStories/{userStoryID}/testCases/updateOrder

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "string"
]

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Set workflow to a test case

This resource sets a workflow to a test case. \nPrivilege: UseCaseCreateEdit.\n

Authorizations:
apiKey
path Parameters
testCaseID
required
string <int64>

The test case ID (stringified UUID).

Request Body schema: application/json

The workflow that will be set to the test case.

workflowID
required
string <uuid>

The ID of the workflow (strignified UUID).

revision
required
number

The revision: [long]

Responses

200

The specified test case has been updated successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

put/testCases/{testCaseID}/workflow
http://localhost/servicetrace/api/CentralServerRestApi.svc/testCases/{testCaseID}/workflow

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "workflowID": "string",
  • "revision": 0
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Remove workflow of a test case

This resource removes the workflow of a test case. \nPrivilege: UseCaseCreateEdit.\n

Authorizations:
apiKey
path Parameters
testCaseID
required
string <int64>

The test case ID (stringified UUID).

Responses

200

The workflow of the specified test case has been removed successfully. Empty response.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

delete/testCases/{testCaseID}/workflow
http://localhost/servicetrace/api/CentralServerRestApi.svc/testCases/{testCaseID}/workflow

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Reporting

Get the availability data within the specified constraints in seconds

This resource returns the availability data within the specified constraints as a .csv file. The measured values are given in seconds.

Example:
customer|service|location|station|datasource|workflow|date|value|hit
servicetrace|Sample Service 01|Mannheim|DEV-SERVER|Completed|Sample 01|2019-08-09T06:43:00.0000000|0.533|True
servicetrace|Sample Service 01|Mannheim|DEV-SERVER|Completed|Sample 01|2019-08-09T06:43:15.0000000|0.531|True

Privilege: Service Report Management Open.

Authorizations:
apiKey
query Parameters
service
required
integer
start
required
string
end
required
string
dataSources
array
locations
array
serviceTimes
required
boolean
plannedDownTimes
required
boolean
unplannedDownTimes
required
boolean
excludedMeasurements
required
boolean
holidays
required
boolean
includeWorkflowErrors
boolean

If this value is not set, then the system defaults to "true".

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The availability data within the specified constraints as comma-separated values: Customer, Service, Location, Station, DataSource, Workflow, Date, Value, Hits

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/report/availabilityCsv
http://localhost/servicetrace/api/CentralServerRestApi.svc/report/availabilityCsv

Response samples

Content type
text/comma-separated-values
No sample

Get the availability data within the specified constraints in milliseconds

This resource returns the availability data within the specified constraints as a .csv file. The measured values are given in milliseconds.

Example:
customer|service|location|station|datasource|workflow|date|value|hit
servicetrace|Sample Service 01|Mannheim|DEV-SERVER|Completed|Sample 01|2019-08-09T06:43:00.0000000|533|True
servicetrace|Sample Service 01|Mannheim|DEV-SERVER|Completed|Sample 01|2019-08-09T06:43:15.0000000|531|True

Privilege: Service Report Management Open.

Authorizations:
apiKey
query Parameters
service
required
integer
start
required
string
end
required
string
dataSources
array
locations
array
serviceTimes
required
boolean
plannedDownTimes
required
boolean
unplannedDownTimes
required
boolean
excludedMeasurements
required
boolean
holidays
required
boolean
includeWorkflowErrors
boolean

If this value is not set, then the system defaults to "true".

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The availability data within the specified constraints as comma-separated values: Customer, Service, Location, Station, DataSource, Workflow, Date, Value, Hits

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/report/availabilityCsvInMilliseconds
http://localhost/servicetrace/api/CentralServerRestApi.svc/report/availabilityCsvInMilliseconds

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Get the response time data within the specified constraints

This resource returns the response time data within the specified constraints. \nPrivilege: Service Report Management Open.\n

Authorizations:
apiKey
query Parameters
service
required
integer
start
required
string
end
required
string
dataSources
array
locations
array
serviceTimes
required
boolean
plannedDownTimes
required
boolean
unplannedDownTimes
required
boolean
excludedMeasurements
required
boolean
holidays
required
boolean
includeWorkflowErrors
required
boolean
header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

The response time data within the specified constraints as comma-separated-values: Customer, Service, Location, Station, DataSource, Workflow, Date, Value, Hits

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/report/responseTimeCsv
http://localhost/servicetrace/api/CentralServerRestApi.svc/report/responseTimeCsv

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "exception-name": "string",
  • "message": "string",
  • "stacktrace": "string"
}

Alerting

Get all alerts by hours

This resource returns alert objects last N hours until a specified timestamp. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
query Parameters
maxRecords
integer <int64>

The maximum number of alerts to be retrieved.

hours
integer <int64>

The timespan in hours to be retrieved. These are all alerts within N hours until the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which alerts should be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of alerts of the last N hours until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/alert/hours
http://localhost/servicetrace/api/CentralServerRestApi.svc/alert/hours

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get robot alerts by hours

This resource returns alert objects last N hours until a specified timestamp. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
query Parameters
maxRecords
integer <int64>

The maximum number of alerts to be retrieved.

hours
integer <int64>

The timespan in hours to be retrieved. These are all alerts within N hours until the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which alerts should be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of alerts of the last N hours until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/alert/robotHours
http://localhost/servicetrace/api/CentralServerRestApi.svc/alert/robotHours

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get end-to-end alerts by hours

This resource returns alert objects last N hours until a specified timestamp. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
query Parameters
maxRecords
integer <int64>

The maximum number of alerts to be retrieved.

hours
integer <int64>

The timespan in hours to be retrieved. These are all alerts within N hours until the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which alerts should be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of alerts of the last N hours until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/alert/endToEndHours
http://localhost/servicetrace/api/CentralServerRestApi.svc/alert/endToEndHours

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Get run result alerts by hours

This resource returns alert objects last N hours until a specified timestamp. \nPrivilege: Control Center Open.\n

Authorizations:
apiKey
query Parameters
maxRecords
integer <int64>

The maximum number of alerts to be retrieved.

hours
integer <int64>

The timespan in hours to be retrieved. These are all alerts within N hours until the specified timestamp endtime.

endtime
string <date-time>

The timestamp in UTC until which alerts should be retrieved.

header Parameters
x-customer
string <uuid>

Optional HTTP header parameter. The customer ID (stringified UUID) is used in the system context only - i.e. if the API key specifies a system user. The parameter specifies the customer, under which a system user operates. Omit this parameter, if a system user should operate in the system context. If the API key specifies a normal user, this parameter will be ignored and should not be specified.

Responses

200

A list of alerts of the last N hours until the timestamp endTime.

403

The user does not have the necessary permissions for this resource. Please verify the API key.

500

Internal Server Error

get/alert/runResultHours
http://localhost/servicetrace/api/CentralServerRestApi.svc/alert/runResultHours

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]