Save Change Request Task Data
SaveChangeRequestTaskData API is used to save the ticket details for Change Tasks. The API URL, authentication type, and request format are provided along with the expected column types and values. The output includes the status code, status, and result. There is also an updated version V2.0 of the API with some changes in the API URL and output format.
API version V1.0
API: | SaveChangeRequestTaskData |
Purpose: | To save the ticket details for Change Tasks. |
API URL: | http://<API URL>:<API Port>//iAutomateAPI/Request/SaveChangeRequestTaskData/1 |
Authentication type: | Basic |
Method Type: | Post |
Request Format: [ { "TicketNumber": "CRT0303863", "Summary": "testing", "sys_id": "2b535ab3dbc988506d7550d3dc96190e", "ChangeId": "2b535ab3dbc988506d7550d3dc96190e", "StatusCode": "1", "CreationDate": "2019-11-18 06:24:54", "Description": "testing data", "LastModifiedDate": "2019-11-18 06:24:54", "AssignedGroup": "02cc6a39376e4f00c72b2b2943990e68", "Col1": "", "Col2": "", "Col3": "", "Col4": "", "Col5": "", "TimeZone": "IST", "TimeZoneOffset": "-330", "IsTimeZoneOrOffset": "OFFSET", "IsEpoch": "N" } ] |
Column | Column Type | Mandatory | Expected/Sample value | Remarks |
TicketNumber | string | Yes | CRT0303863 | This field contains change task number |
Summary | string | Yes | testing | This field contains summary of change task |
sys_id | string | Yes | 2b535ab3dbc988506d7550d3dc96190e | This field contains unique number |
changeid | string | Yes | 2b535ab3dbc988506d7550d3dc96190e | This field contains unique number of change |
StatusCode | string | Yes | 1 | This field contains status of change task |
CreationDate | string | Yes | 2019-11-18 06:24:52 | This field contains creation date of change task |
Description | string | Yes | testing | This field contains summary of change task |
LastModifiedDate | string | Yes | 2019-11-18 07:24:52 | This field contains date whenever updating happen on change task |
AssignedGroup | string | No | 123456 | This field contains assignment group of change task |
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 define in which format you are sending data, in use only when "IsTimeZoneOrOffset":"TIMEZONE" |
TimeZoneOffset | string | Value is Mandatory if "IsTimeZoneOrOffset":"OFFSET” | -330 | It define he offset, in use only when "IsTimeZoneOrOffset":"OFFSET" |
IsTimeZoneOrOffset | string | Yes |
TIMEZONE/ OFFSET/ GMT |
It define 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" |
Output: { "statusCode": 200, "status": "Success", "message": "Success", "result": "df7f533b-c0cf-44a6-9e95-0f50f00dadb9" } |
Column | Column type | value | Remarks |
statusCode | int |
Success = 200, Error = 300, RequiredAttributeValueMissing = 400, Unauthorized = 401, |
This field provide status code |
status | string | Success/Fail | This field provide status |
message | string | null or message in case of not success | |
result | string | de0e3951-4c7b-40ad-b5ce-5993d770c0a9 | This field provide unique number for reference |
API version V2.0
API: | SaveChangeRequestTaskData |
Purpose: | To save the ticket details for Change Tasks. |
API URL: | http://<API URL>:<API Port>/v2/changeRequests/orgentityid/1 |
Authentication type: | Basic |
Method Type: | Post |
Request Format: [ { "TicketNumber": "CRT0303863", "Summary": "testing", "sys_id": "2b535ab3dbc988506d7550d3dc96190e", "ChangeId": "2b535ab3dbc988506d7550d3dc96190e", "StatusCode": "1", "CreationDate": "2019-11-18 06:24:54", "Description": "testing data", "LastModifiedDate": "2019-11-18 06:24:54", "AssignedGroup": "02cc6a39376e4f00c72b2b2943990e68", "Col1": "", "Col2": "", "Col3": "", "Col4": "", "Col5": "", "TimeZone": "IST", "TimeZoneOffset": "-330", "IsTimeZoneOrOffset": "OFFSET", "IsEpoch": "N" } ] |
Column | Column Type | Mandatory | Expected/Sample value | Remarks |
TicketNumber | string | Yes | CRT0303863 | This field contains change task number |
Summary | string | Yes | testing | This field contains summary of change task |
sys_id | string | Yes | 2b535ab3dbc988506d7550d3dc96190e | This field contains unique number |
changeid | string | Yes | 2b535ab3dbc988506d7550d3dc96190e | This field contains unique number of change |
StatusCode | string | Yes | 1 | This field contains status of change task |
CreationDate | string | Yes | 2019-11-18 06:24:52 | This field contains creation date of change task |
Description | string | Yes | testing | This field contains summary of change task |
LastModifiedDate | string | Yes | 2019-11-18 07:24:52 | This field contains date whenever updating happen on change task |
AssignedGroup | string | No | 123456 | This field contains assignment group of change task |
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 define in which format you are sending data, in use only when "IsTimeZoneOrOffset":"TIMEZONE" |
TimeZoneOffset | string | Value is Mandatory if "IsTimeZoneOrOffset":"OFFSET” | -330 | It define he offset, in use only when "IsTimeZoneOrOffset":"OFFSET" |
IsTimeZoneOrOffset | string | Yes |
TIMEZONE/ OFFSET/ GMT |
It define 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" |
Output: { "Id": "5a940df1-c251-4af1-9e59-20fecd18bd7e", "Status": "Success", "Message": "Change Request saved successfully" } |
Column | Column type | value | Remarks |
Id | string | 5a940df1-c251-4af1-9e59-20fecd18bd7e | This field provide unique number for reference |
Status | string | Success/Fail | This field provide status |
Message | string | message | Success/Fail message |