V2
Save Incident Data
| API | SaveIncidentData |
|---|---|
| Purpose | To save the ticket details for Incidents. |
| API URL | https://<API URL>:<API Port>//v2/incident/orgentityid/{orgentityid} |
| Authentication type | Basic /Token |
| Method Type | Post |
|
Request Format: |
|
If “IsTimeZoneOrOffset”: “TIMEZONE” then it is mandatory to define the time zone in which the ticket is being created in the key “TimeZone” and “TimeZoneOffset” value can be left blank else if “IsTimeZoneOrOffset”: “OFFSET“ then it is mandatory to define the offset value in the key “TimeZoneOffset” and “TimeZone” value can be left blank else if “IsTimeZoneOrOffset” : “GMT” then no need to define the value for keys “TimeZone” and“TimeZoneOffset” and can be left blank. (Offset value is the difference of time in minutes in which the ticket is being created and GMT time.)
Parameters Required in Request Body of API
| Column | Column Type | Mandatory | Expected/Sample value | Remarks |
|---|---|---|---|---|
| TicketNumber | String | Yes | XXXXXXXX | This field contains ticket number |
| Summary | String | Yes | testing | This field contains summary of ticket |
| sys_id | String | Yes | XXXXXXXX | This field contains unique number |
| ResolvedDate | String | No | 2019-11-18 07:24:52 | This field contains date whenever ticket gets resolved |
| AssignedGroup | String | No | XXXXXXXXX | This field contains assignment group of ticket |
| StatusCode | String | Yes | 1 | This field contains status of ticket |
| CreationDate | String | Yes | 2019-11-18 06:24:52 | This field contains creation date of ticket |
| Description | String | Yes | testing | This field contains summary of ticket |
| LastModifiedDate | String | Yes | 2019-11-18 07:24:52 | This field contains date whenever updating happen on ticket |
| Col1 | String | No | You can use it for any custom value | |
| Col2 | String | No | You can use it for any custom value | |
| Col3 | String | No | You can use it for any custom value | |
| Col4 | String | No | You can use it for any custom value | |
| Col5 | String | No | You can use it for any custom value | |
| TimeZone | String | Value is Mandatory if "IsTimeZoneOrOffset":"TIMEZONE" | IST | It defines in which format you are sending data, in use only when "IsTimeZoneOrOffset":"TIMEZONE" |
| TimeZoneOffset | String | Value is Mandatory if "IsTimeZoneOrOffset":"OFFSET” | -330 | It defines he offset, in use only when "IsTimeZoneOrOffset":"OFFSET" |
| IsTimeZoneOrOffset | String | Yes |
TIMEZONE/ OFFSET/ GMT |
It defines whether you want to use Timezone, offset or GMT value |
| IsEpoch | String | Yes | Y or N | If date format is Epoch, set this key value as "Y" else "N" |
| ModuleId | String | Yes | 1or 9 | ModuleId=1 for Incident Management and ModuleId=9 for Event Management |
Output:
{
"Id": " XXXXXXXX ",
"Status": "Success",
"Message": "Incident data saved successfully”.
}Parameters Returned in Response of API
| Column | Column type | Value | Remarks |
|---|---|---|---|
| Id | string | XXXXXXXX | This field provide unique number for reference |
| Status | string | Success/Fail | This field provide status |
| Message | string | Incident data saved successfully | Success /fail message |