Central Server REST API (4.8)

Download OpenAPI specification:Download

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. Privilege: This resource can be invoked by a system user only.

Authorizations:

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

An error object (JSON) of the respective web service.

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

Response samples

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

Get the specified customer

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

Authorizations:
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

An error object (JSON) of the respective web service.

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

Response samples

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. Privilege: Master Data Open.

Authorizations:
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

An error object (JSON) of the respective web service.

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

Response samples

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. Privilege: Master Data Open.

Authorizations:
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

An error object (JSON) of the respective web service.

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

Response samples

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. Privilege: Master Data Open.

Authorizations:
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

An error object (JSON) of the respective web service.

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

Response samples

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