GET SystemEvent/{id}
Some tooltip text!
• 3 minutes to read
• 3 minutes to read
GET /api/v1/SystemEvent/{id}
Gets a SystemEventEntity object.
Calls the Configuration agent service GetSystemEventEntity.
Path Part | Type | Description |
---|---|---|
id | int32 | The id of the SystemEventEntity to return. Required |
Query String Parameters
Parameter Name | Type | Description |
---|---|---|
$select | string | Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields. |
GET /api/v1/SystemEvent/{id}?$select=name,department,category/id
Request Headers
Parameter Name | Description |
---|---|
Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
Accept | Content-type(s) you would like the response in: application/json , text/json , application/xml , text/xml , application/json-patch+json , application/merge-patch+json |
Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Response:
SystemEventEntity found.
Response | Description |
---|---|
200 | SystemEventEntity found. |
404 | Not Found. |
Response body: SystemEventEntityWithLinks
Property Name | Type | Description |
---|---|---|
SystemEventId | int32 | |
Scope | string | |
Eta | date-time | |
Eventkey | string | |
Eventmess | string | |
ExtraInfo | int32 | |
Owner | int32 | |
UpdatedCount | int32 | |
Registered | date-time | |
ActivatedBy | Associate | Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent. |
TableRight | TableRight | The carrier's table right |
FieldProperties | object | Field property dictionary mapping field names to field access rights. |
_Links | object |
Sample request
GET /api/v1/SystemEvent/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Sample response
HTTP/1.1 200 SystemEventEntity found.
Content-Type: application/json; charset=utf-8
{
"SystemEventId": 479,
"Scope": "Database",
"Eta": "2007-01-05T17:54:08.5543174+01:00",
"Eventkey": "inventore",
"Eventmess": "aut",
"ExtraInfo": 551,
"Owner": 207,
"UpdatedCount": 960,
"Registered": "2011-07-16T17:54:08.5543174+02:00",
"ActivatedBy": null,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 128
}
},
"_Links": {
"Self": "https://www.example.com/api/v1/project/321",
"Archive": "https://www.example.com/api/v1/project"
}
}