Help Contents

 

System Event

Resource: System Event ( /api/systemevent/{id} )

Allows the retrieval of details for a single system event

This resource supports the following methods: DELETE, GET

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).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if you request can not be satisified due to lack of permissions.
404 - NotFoundReturned 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).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if you request can not be satisified due to lack of permissions.
404 - NotFoundReturned if the event does not exist.

Example - Get system event by Id

Get system event identified by it's unique identifier (That is associated with an external system link)

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
id5A416DFF-A4CD-4E46-A702-7A55FBC252A0ID of the system event

Response Headers

KeyValueDescription
Content-Typeapplication/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

Example - Get system event by Id

Get system event identified by it's unique identifier (That is associated with a stored document)

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
id5A416DFF-A4CD-4E46-A702-7A55FBC252A0ID of the system event

Response Headers

KeyValueDescription
Content-Typeapplication/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