Reference
Reference List
A listing with available functions is to be found below in this article or also within Reference list.
Properties
An overview with the available properties can be found in Properties.
Authentication
An authentication is required before any operation is possible. The authentication is based on the OAuth2 standard. It uses the credentials of a user that exists in the user management and all its permissions. This means, only the operation are possible that the user can do in the 446 Plattform®. If the user has no permission to see a certain ticket field then the 446 WebAPI will also not load the field when requesting the ticket.
All request must contain the security token in the http Authorization header. To get a security token send a post request to the authorization endpoint:
Query: POST: http://…/WebAPI/xpertauthorizationserver/
oauth/token Headers: Content-Type: application/json
Data: grant_type=password&username=<username>&password=<password>&client_secret=<client_secret>&client_id=<client_id>
Authorization header
key: "Authorization"
value: "Bearer zbaXUc_Zf-YI1M5d~...~DdT4"
Return value
Error status: 400 (Bad Request) Data:
{
"error":"invalid_grant",
"error_description":"The user name or password is incorrect"
}
Success status: 200 Data:
{
"access_token": "vsJUORHvC-sy~...~3RyKg",
"token_type": "bearer",
"expires_in": 86399,
"refresh_token": "AFKTebkW-2zP~...~Pt1TQ",
"user_id": "eb2628d1-d3f6-4cd0-93de-2d8e48b9c0fc"
}