URL
POST https://{api-url}/api/v2/tenants/{tenantId}/incidents/{incidentId}/responses
Sample URLs
https://{api-url}/api/v2/tenants/client_1000/incidents/INC0000001114/responses
Parameters
Field | Data Type | Description |
---|---|---|
description | String | Short summary describing the response. |
tags | String | (Optional) Labels attached to the response. |
attachments | Object | (Optional) Attachments for the particular response. |
internal | Boolean | (Optional) Represents the visibility of the response:
|
creator | Object | (Optional) If internal=true, creator is mandatory. Provide:
|
Note
- For attachments, files must be converted to bytes stream with base64-encoding.
- The default creator (OpsRamp API User) can send id and loginName to change the default.
- Based on the setting Make default submission status of a pending request as open, the status of the Pending request will change to Open.
- A file attachment is limited to 50MB.
- Date format is yyyy-MM-ddTHH:mm:ssZ (GMT).
Sample request
{
"description": "Adding Attachments to Incident",
"internal": "false",
"creator": {
"id": "USR0000002146",
"loginName": "FSSL-API-Lab-User-1"
},
"tags": "API, Incident",
"attachments": [{
"name": "2.txt",
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
}, {
"name": "1.txt",
"file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ="
}],
"extTicketResponseId": "12345"
}
Sample response
{
"creator": {
"id": "USR0000002146",
"loginName": "FSSL-API-Lab-User-1",
"lastName": "API-Lab",
"firstName": "FSSL",
"email": "fssl.user@gmail.com"
},
"createdDate": "2016-03-29T12:56:15+0000",
"attachments": [{
"id": 108,
"name": "2.txt",
"createdDate": "2016-03-29T12:56:15+0000",
"contentURL": "https://{api-url}/api/v2/tenants/client_1000/incidents/INC0000001114/responses/1913/resources/108"
}, {
"id": 109,
"name": "1.txt",
"createdDate": "2016-03-29T12:56:15+0000",
"contentURL": "https://{api-url}/api/v2/tenants/client_1000/incidents/INC0000001114/responses/1913/resources/109" }], "hasAttachments": true, "tags": "tag1,tag2", "internal": "false", "extTicketResponseId": "12345", "description": "testing response"
}