{ "info": { "name": "ServiceNow - Remedy Incident synchronisation", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Create a new ticket", "description": "Create a new ticket by specifying the 'originIncidentNumber'.", "request": { "auth": [], "method": "Post", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "localhost:8080\/incident", "protocol": "https", "host": [ "localhost:8080" ], "path": { "1": "incident" } }, "body": { "mode": "formdata", "formdata": [ { "key": "targetSystem", "value": "", "description": "System receiving the request", "required": 1, "type": "string" }, { "key": "originSystem", "value": "", "description": "System originating the request", "required": 1, "type": "string" }, { "key": "transactionId", "value": "", "description": "Transaction identifier used by client", "required": 1, "type": "string" }, { "key": "callerId", "value": "", "description": "User from calling system", "required": 1, "type": "string" }, { "key": "originIncidentNumber", "value": "", "description": "Origin ticket identifier, this is the id of the ticket at the originating system", "required": 1, "type": "string" }, { "key": "shortDescription", "value": "", "description": "Brief description about the ticket", "required": 1, "type": "string" }, { "key": "detailedDescription", "value": "", "description": "More detailed description of the ticket", "required": 0, "type": "string" }, { "key": "impact", "value": "", "description": "Level of impact", "required": 0, "type": "string" }, { "key": "urgency", "value": "", "description": "Level of urgency", "required": 0, "type": "string" }, { "key": "attachmentFilename", "value": "", "description": "Name of file being attached", "required": 0, "type": "string" }, { "key": "attachmentData", "value": "", "description": "Attachment data encoded in base64", "required": 0, "type": "string" } ] } }, "response": [ { "code": 201, "status": "Created", "name": "Incident created", "schema": { "targetIncidentNumber": { "type": "string", "description": "Target ticket identifier, this is the id of the ticket at the target system" }, "statusCode": { "type": "string", "description": "Status code from target system to indicate transaction status" }, "statusMessage": { "type": "string", "description": "Status response description", "example": "processed" }, "originTransactionId": { "type": "string", "description": "Transaction identifier generated by system originating the request", "example": "MTN123456" }, "targetTransactionId": { "type": "string", "description": "Transaction identifier generated by target", "example": "17af7d89db62885072fa83305b961972" } }, "body": "{\"targetIncidentNumber\":\"string\",\"statusCode\":\"string\",\"statusMessage\":\"string\",\"originTransactionId\":\"string\",\"targetTransactionId\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Not authenticated", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not found", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 407, "status": "Proxy Authentication Required", "name": "Proxy system not authenticated", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] }, { "name": "Modify an existing ticket", "description": "This call is used to update a ticket that already exists by using the 'targetIncidentNumber'.", "request": { "auth": [], "method": "Patch", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application\/json", "type": "application\/json", "description": "" } ], "url": { "raw": "localhost:8080\/incident", "protocol": "https", "host": [ "localhost:8080" ], "path": { "1": "incident" } }, "body": { "mode": "formdata", "formdata": [ { "key": "transactionId", "value": "", "description": "Transaction identifier used by client", "required": 1, "type": "string" }, { "key": "originSystem", "value": "", "description": "System originating the request", "required": 1, "type": "string" }, { "key": "targetSystem", "value": "", "description": "System receiving the request", "required": 1, "type": "string" }, { "key": "targetIncidentNumber", "value": "", "description": "Incident number at the target system", "required": 1, "type": "string" }, { "key": "shortDescription", "value": "", "description": "Brief description about the ticket", "required": 0, "type": "string" }, { "key": "detailedDescription", "value": "", "description": "More detailed description of the ticket", "required": 0, "type": "string" }, { "key": "impact", "value": "", "description": "Level of impact", "required": 0, "type": "string" }, { "key": "urgency", "value": "", "description": "Level of urgency", "required": 0, "type": "string" }, { "key": "attachmentFilename", "value": "", "description": "Name of file being attached", "required": 0, "type": "string" }, { "key": "attachmentData", "value": "", "description": "Attachment data encoded in base64", "required": 0, "type": "string" }, { "key": "state", "value": "", "description": "Only applicable for values 2,3,6,7,8. Value 1 is set when an incident is created. Value 2 can only be set if the ticket 'assignedTo' field was prevously set", "required": 0, "type": "string" }, { "key": "assignedTo", "value": "", "description": "Who the incident is assigned to", "required": 0, "type": "string" }, { "key": "closeCode", "value": "", "description": "Applicable when setting 'state' to 6. This value is used to indicate the code for resolution.", "required": 0, "type": "string" }, { "key": "closeNotes", "value": "", "description": "Custom notes for closing ticket.", "required": 0, "type": "string" }, { "key": "comments", "value": "", "description": "Comments to incident", "required": 0, "type": "string" }, { "key": "workNotes", "value": "", "description": "Work notes to incident", "required": 0, "type": "string" }, { "key": "subcategory", "value": "", "description": "Incident category", "required": 0, "type": "string" } ] } }, "response": [ { "code": 200, "status": "OK", "name": "OK", "schema": { "targetIncidentNumber": { "type": "string", "description": "Target ticket identifier, this is the id of the ticket at the target system" }, "statusCode": { "type": "string", "description": "Status code from target system to indicate transaction status" }, "statusMessage": { "type": "string", "description": "Status response description", "example": "processed" }, "originTransactionId": { "type": "string", "description": "Transaction identifier generated by system originating the request", "example": "MTN123456" }, "targetTransactionId": { "type": "string", "description": "Transaction identifier generated by target", "example": "17af7d89db62885072fa83305b961972" } }, "body": "{\"targetIncidentNumber\":\"string\",\"statusCode\":\"string\",\"statusMessage\":\"string\",\"originTransactionId\":\"string\",\"targetTransactionId\":\"string\"}", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 401, "status": "Unauthorized", "name": "Not authenticated", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 404, "status": "Not Found", "name": "Not found", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 407, "status": "Proxy Authentication Required", "name": "Proxy system not authenticated", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] }, { "code": 500, "status": "Internal Server Error", "name": "Internal Server Error", "schema": [], "body": "[]", "header": [ { "key": "Content-Type", "value": "application\/json", "description": "Sending as JSON", "type": "string" } ] } ] } ] }