Incident - ExternalData Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/external-data/{ExternalDataId}

Supported Methods

GET
PUT
DELETE
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

None.

Success Codes

Fault Codes

Response Data

Object type: external-data
A External Data object contains additional information added to an incident.
FieldDescription
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
dataThe data from the external data source.
idUnique identifier for the external data.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
moddateThe date and time when the object was last modified.
modifierThe URL of the Sentinel User object that represents the last modifier of the object.
sourceThe source of the external data
typeThe type of data included from the external data source.
Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldDescription
@hrefThe URL reference to the object.
typeThe name of the object type

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/external-data/42
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"external-data",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/external-data/42"
   },
   "id":"Wildebeest",
   "moddate":"2012-04-25T13:33:44.503Z",
   "source":"Log file",
   "createdate":"2012-04-25T13:33:44.503Z",
   "data":"Sample Data",
   "type":"xml"
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: external-data
A External Data object contains additional information added to an incident.
FieldRequiredDescription
datafalseThe data from the external data source.
idfalseUnique identifier for the external data.
sourcefalseThe source of the external data
typefalseThe type of data included from the external data source.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe name of the object type

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/external-data/42
{
   "id":"Wildebeest",
   "source":"Log file",
   "data":"Sample Data",
   "type":"xml"
}
Sample Response for application/json
Status: 200

DELETE

Authentication

Authentication Types
Sentinel Permissions Needed

URL Parameters

None.

Success Codes

Fault Codes

Sample Request

DELETE https://164.99.19.131:8443/SentinelRESTServices/objects/external-data/42