Incident - Attachment Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/attachment/{AttachmentId}

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: attachment
A file included or 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 being attached to an incident, such as a log file.
descA description of the file being attached to the incident.
extensionThe extension of the file being attached to the incident.
filenameThe name of the file being attached to the incident.
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 file being attached to the incident.
sub-typeThe sub-type of the file being attached to the incident.
typeThe type of file being attached to the incident.
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/attachment/42
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"attachment",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/attachment/42"
   },
   "extension":"txt",
   "sub-type":"xml",
   "moddate":"2012-04-25T13:33:44.524Z",
   "desc":"Log file containing failed logins.",
   "source":"Log File",
   "createdate":"2012-04-25T13:33:44.524Z",
   "filename":"server.log",
   "type":"text"
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: attachment
A file included or added to an incident.
FieldRequiredDescription
datafalseThe data being attached to an incident, such as a log file.
descfalseA description of the file being attached to the incident.
extensionfalseThe extension of the file being attached to the incident.
filenamefalseThe name of the file being attached to the incident.
sourcefalseThe source of the file being attached to the incident.
sub-typefalseThe sub-type of the file being attached to the incident.
typefalseThe type of file being attached to the incident.

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/attachment/42
{
   "extension":"txt",
   "sub-type":"xml",
   "desc":"Log file containing failed logins.",
   "source":"Log File",
   "filename":"server.log",
   "type":"text"
}
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/attachment/42