Resource: System Event ( /api/systemevent/{id} )
Allows the retrieval of details for a single system event
Methods
DELETE
Delete a single system event by it's unique Identifier
Status Codes
These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you request can not be satisified due to lack of permissions. |
| 404 - NotFound | Returned if the event does not exist. |
GET
Retrieves a single system event by it's unique Identifier
Status Codes
These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).
| Status | Description |
|---|---|
| 200 - OK | Returned if the request was completed successfully. |
| 403 - Forbidden | Returned if you request can not be satisified due to lack of permissions. |
| 404 - NotFound | Returned if the event does not exist. |
Get system event identified by it's unique identifier (That is associated with an external system link)
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| id | 5A416DFF-A4CD-4E46-A702-7A55FBC252A0 | ID of the system event |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Id": "5a416dff-a4cd-4e46-a702-7a55fbc252a0",
"OccurredAt": "2012-01-01T14:45:05Z",
"LinkId": "faa5dcca-1ce4-428f-9508-9f961affe895",
"SystemId": "5d4970a6-bdcc-4816-970f-eab5943279d4",
"ReferenceId": "90b23d7b-87c3-41fb-a5f8-e08af9395f48",
"Message": "Synchronization succeeded",
"Type": "CompileSynchronizationContextTask",
"Source": "Synchronization",
"EntityType": "Requirement",
"EntityId": "a2466924-9267-47ba-8959-d0d7741d5fc9",
"Level": "ERROR",
"Self": "http://localhost/api/systemevent/5a416dff-a4cd-4e46-a702-7a55fbc252a0",
"Links": [
{
"Href": "http://localhost/api/api/externalsystem/5d4970a6-bdcc-4816-970f-eab5943279d4",
"Rel": "ExternalSystem"
},
{
"Href": "http://localhost/api/api/externalsystemlink/faa5dcca-1ce4-428f-9508-9f961affe895",
"Rel": "ExternalSystemLink"
}
]
}
Status Code
200 - OK
Get system event identified by it's unique identifier (That is associated with a stored document)
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| id | 5A416DFF-A4CD-4E46-A702-7A55FBC252A0 | ID of the system event |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
{
"Id": "5a416dff-a4cd-4e46-a702-7a55fbc252a0",
"OccurredAt": "2012-01-01T14:45:05Z",
"DocumentId": "34cdd75e-8a94-4504-8c81-21ec77d39872",
"Message": "Synchronization succeeded",
"Type": "CompileSynchronizationContextTask",
"Source": "Synchronization",
"EntityType": "Requirement",
"EntityId": "a2466924-9267-47ba-8959-d0d7741d5fc9",
"Level": "ERROR",
"Self": "http://localhost/api/systemevent/5a416dff-a4cd-4e46-a702-7a55fbc252a0"
}
Status Code
200 - OK