POST documentation for the ServiceNow Customer Service Management Case API at UCSD
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7548206","collectionId":"2f8641a0-0e4e-43db-aade-8dc169f3bc6b","publishedId":"TVsuDTKT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-12-21T19:42:19.000Z"},"item":[{"name":"Create Case Record","id":"670e5b6e-7b55-4dab-a90a-ff4eeb96c681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"contact\": \"sagarza\",\r\n \"u_organization\": \"832cf459db3cc850008c9837db961949\",\r\n \"u_case_type\": \"Request\",\r\n \"short_description\": \"postman test Secured\",\r\n \"description\": \"Savings wireless Bacon Tactics Stand-alone\",\r\n \"service_offering\": \"f4b98c8adbe0774c9736f35aaf961986\",\r\n \"assignment_group\": \"22f0e856dbb8b6404cd8f06e0f961975\",\r\n \"assigned_to\": \"eduque\",\r\n \"comments\": \"Chicken Director Soft Mall Practical fuchsia Multi-lateral Glens Berkshire state Cedi Metal Games Plastic Graphic Bedfordshire Home Mexican\",\r\n \"work_notes\": \"radical Court Central\"\r\n },\r\n {\r\n \"contact\": \"eduque\",\r\n \"u_organization\": \"832cf459db3cc850008c9837db961949\",\r\n \"u_case_type\": \"Incident\",\r\n \"impact\": 2,\r\n \"urgency\": 3,\r\n \"short_description\": \"postman test Group\",\r\n \"description\": \"Executive Cloned Buckinghamshire Cheese\",\r\n \"service_offering\": \"f4b98c8adbe0774c9736f35aaf961986\",\r\n \"category\": 246,\r\n \"assignment_group\": \"22f0e856dbb8b6404cd8f06e0f961975\",\r\n \"assigned_to\":\"eduque\",\r\n \"watch_list\": [\"eduque\", \"eduque@ucsd.edu\", \"blahblahblaheduque\",\"jclow\",\"testingteteete\"],\r\n \"work_notes_list\": [\"eduque\", \"earlduque@example.com\"],\r\n \"comments\": \"Cambridgeshire virtual Sleek Baby Shoes bluetooth action-items redundant indigo deliverables Adaptive Bedfordshire access Beauty payment\",\r\n \"app_index\": \"seleventy\",\r\n \"variables\" :\r\n [{\"question\" : \"answer\"}]\r\n \r\n },\r\n {\r\n \"u_organization\": \"832cf459db3cc850008c9837db961949\",\r\n \"u_case_type\": \"Request\",\r\n \"short_description\": \"postman test backing\",\r\n \"description\": \"Fiji moratorium calculate of Rubber\",\r\n \"service_offering\": \"f4b98c8adbe0774c9736f35aaf961986\",\r\n \"assignment_group\": \"22f0e856dbb8b6404cd8f06e0f961975\",\r\n \"comments\": \"Refined Awesome Turnpike internet Avon coherent Bedfordshire Way Dominica input panel Dynamic Chair Consultant IB parse\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://snqa.ucsd.edu/api/sn_customerservice/case_api?continue_on_error=true&test=false&debug=false","description":"The body of the request should be as follows:
\nAlways an array of objects
\nEven if it’s a single object (case), it would be an array of 1 object
\nEach object corresponds to a new case created
\nEach Object must have a property and value for:
\ncontact (Required, string. Must be a user’s AD username).
\nu_case_type (Required, string. Must be either “Incident” or “Request”)
\nshort_description (Required, string. Must be less than 1000 characters).
\ndescription (Required, string. Must be less than 4000 characters).
\nu_organization (Required, string. Must be exactly 32 character sys_id of organization in ServiceNow) [will be provided by servicenow team]
\nservice_offering (Required, string. Must be exactly 32 characters sys_id of service offering in ServiceNow. Must match a correct service offering in the above organization). [will be provided by servicenow team]
\nassignment_group (Required, string. Must be exactly 32 character sys_id of assignment_group in ServiceNow) [will be provided by servicenow team]
\nOptional fields that can be provided in the object
\nassigned_to (Optional, string. Must be a user’s AD username, user must have agent access and case access, and must be a member of above assignment_group).
\nIf “Incident” for u_case_type, the follow two fields can also be provided
\nimpact (Optional, integer. Must be 1, 2, 3, or 4. If not provided, defaults to 3)
\nurgency (Optional, integer. Must be 1, 2, 3, or 4. If not provided, defaults to 3)
\ncategory (Optional, integer. Must be a category within the service offering) [will be provided by servicenow team]
\nwatch_list (Optional, array of strings. Strings must be either user’s AD username, or email address)
\nwork_notes_list (Optional, array of strings. Strings must be either user’s AD username, or email address)
\ncomments (optional, string. Must be less than 4000 characters)
\nwork_notes (optional, string. Must be less than 4000 characters minus dev work note from below).
\napp_index (optional, string. For identifying this case attempt to match to the response object, otherwise will be the array index starting at 0)
\nOptional, boolean, Default if not provided: false. \nIf true, a non-critical error will not kill the process and all found errors will be provided in the response.\nIf false (or any value other than true), an error will kill the whole process (for the individual case) and provide the first error message in the response
\n","type":"text/plain"},"key":"continue_on_error","value":"true"},{"description":{"content":"Optional, boolean. Default if not provided: false. \nIf true, will proceed through entire process but will not actually create the case records at the end.\nIf false (or any value other than true), will process as normal and create records if possble.
\n","type":"text/plain"},"key":"test","value":"false"},{"description":{"content":"Optional, boolean. Default if not provided: false.\nIf set to true, an addtional object will be included in the response body that will provide the following additonal context for debugging: headers received, body received, and the body by the end of the process.
\n","type":"text/plain"},"key":"debug","value":"false"}],"variable":[]}},"response":[{"id":"cdb3e62f-cd2c-4887-85f5-316371a3f54d","name":"Create Case Record","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"contact\": \"eduque\",\r\n \"u_organization\": \"832cf459db3cc850008c9837db961949\",\r\n \"u_case_type\": \"Request\",\r\n \"short_description\": \"postman test invoice\",\r\n \"description\": \"Producer Nebraska firewall Sleek EXE\",\r\n \"service_offering\": \"f4b98c8adbe0774c9736f35aaf961986\",\r\n \"assignment_group\": \"22f0e856dbb8b6404cd8f06e0f961975\",\r\n \"assigned_to\": \"eduque\",\r\n \"comments\": \"Orchestrator Cambridgeshire impactful Ergonomic Fully-configurable withdrawal Re-contextualized open-source PCI Fresh Home Frozen back-end Belize Chief\"\r\n },\r\n {\r\n \"contact\": \"eduque\",\r\n \"u_organization\": \"832cf459db3cc850008c9837db961949\",\r\n \"u_case_type\": \"Incident\",\r\n \"impact\": 2,\r\n \"urgency\": 3,\r\n \"short_description\": \"postman test Illinois\",\r\n \"description\": \"Buckinghamshire Investment Account red\",\r\n \"service_offering\": \"f4b98c8adbe0774c9736f35aaf961986\",\r\n \"category\": 246,\r\n \"assignment_group\": \"22f0e856dbb8b6404cd8f06e0f961975\",\r\n \"assigned_to\":\"eduque\",\r\n \"watch_list\": [\"eduque\", \"eduque@ucsd.edu\", \"blahblahblaheduque\",\"jclow\",\"testingteteete\"],\r\n \"work_notes_list\": [\"eduque\", \"earlduque@example.com\"],\r\n \"comments\": \"Versatile Car auxiliary Assurance EXE quantifying Persistent Industrial optimizing Product Montana Infrastructure synergies port Tasty Dollar\"\r\n },\r\n {\r\n \"u_organization\": \"832cf459db3cc850008c9837db961949\",\r\n \"u_case_type\": \"Request\",\r\n \"short_description\": \"postman test action-items\",\r\n \"description\": \"override Market\",\r\n \"service_offering\": \"f4b98c8adbe0774c9736f35aaf961986\",\r\n \"assignment_group\": \"22f0e856dbb8b6404cd8f06e0f961975\",\r\n \"comments\": \"syndicate Rustic Beauty Brand Kwacha 1080p Games Brunei Account Designer Practical capacitor wireless Devolved ivory end-to-end connecting bypassing open-source\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://sndev.ucsd.edu/api/sn_customerservice/case_api?continue_on_error=true&test=false&debug=false","protocol":"https","host":["sndev","ucsd","edu"],"path":["api","sn_customerservice","case_api"],"query":[{"key":"continue_on_error","value":"true","description":"Optional, boolean, Default if not provided: false. \nIf true, a non-critical error will not kill the process and all found errors will be provided in the response.\nIf false (or any value other than true), an error will kill the whole process (for the individual case) and provide the first error message in the response"},{"key":"test","value":"false","description":"Optional, boolean. Default if not provided: false. \nIf true, will proceed through entire process but will not actually create the case records at the end.\nIf false (or any value other than true), will process as normal and create records if possble."},{"key":"debug","value":"false","description":"Optional, boolean. Default if not provided: false.\nIf set to true, an addtional object will be included in the response body that will provide the following additonal context for debugging: headers received, body received, and the body by the end of the process."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Encoding","value":"gzip"},{"key":"X-Is-Logged-In","value":"true"},{"key":"X-Transaction-ID","value":"8dd577ec1b21"},{"key":"Pragma","value":"no-store,no-cache"},{"key":"Cache-control","value":"no-cache,no-store,must-revalidate,max-age=-1"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 04 Jan 2021 00:05:58 GMT"},{"key":"Server","value":"ServiceNow"},{"key":"Set-Cookie","value":"glide_user_activity=U0N2Mzp1V01sTUk1ejN6ZWVJWFZRSXdkMXN0Ti9SSTE5L2xoMzoraEdwR0xhTzJpWUx1d1NlZTBPUmtNYU9YSWQyK0luM2toakU2TVhEZEFrPQ==; Path=/; HttpOnly; SameSite=None; Secure"},{"key":"Set-Cookie","value":"glide_session_store=8795B3E41B6128D0484F968F034BCBDF; Max-Age=60; Expires=Mon, 04-Jan-2021 00:06:57 GMT; Path=/; HttpOnly; SameSite=None; Secure"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"Cases created\": 1,\n \"Cases created with warnings\": 1,\n \"Cases skipped\": 1,\n \"created\": [\n {\n \"app_index\": \"0\",\n \"number\": \"CS0230791\",\n \"url\": \"https://sndev.ucsd.edu//services?id=ticket&table=sn_customerservice_case&sys_id=ddd5372c1ba128d0484f968f034bcb36\",\n \"agent_url\": \"https://sndev.ucsd.edu//nav_to.do?uri=sn_customerservice_case.do?sys_id=ddd5372c1ba128d0484f968f034bcb36%26sysparm_view=case\"\n }\n ],\n \"created with warnings\": [\n {\n \"app_index\": \"1\",\n \"number\": \"CS0230792\",\n \"url\": \"https://sndev.ucsd.edu//services?id=ticket&table=sn_customerservice_case&sys_id=95d5bf2c1ba128d0484f968f034bcbc4\",\n \"agent_url\": \"https://sndev.ucsd.edu//nav_to.do?uri=sn_customerservice_case.do?sys_id=95d5bf2c1ba128d0484f968f034bcbc4%26sysparm_view=case\",\n \"error_message\": [\n \"blahblahblaheduque does not match the AD Username of any known, active user and is not a valid email address\",\n \"testingteteete does not match the AD Username of any known, active user and is not a valid email address\"\n ]\n }\n ],\n \"failed\": [\n {\n \"app_index\": \"2\",\n \"error_message\": [\n \"Error: The field contact is missing from the request body.\"\n ]\n }\n ],\n \"continue_on_error\": true\n }\n}"}],"_postman_id":"670e5b6e-7b55-4dab-a90a-ff4eeb96c681"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"b55b4cfc-d6a8-486e-a5e4-d748870d69e1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"60cf8a73-7aa1-4908-8e90-20bff45219c0","type":"text/javascript","exec":[""]}}],"variable":[{"key":"instance","value":"sndev"},{"key":"username","value":""},{"key":"password","value":""}]}