{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"/updatecase","type":"text"}]},{"type":"paragraph","content":[{"text":"V1.0","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Description","type":"text"}]},{"type":"paragraph","content":[{"text":"Updates a given case’s reportable ","type":"text"},{"text":"Attribute","type":"text","marks":[{"type":"code"}]},{"text":" in iCasework with the provided ","type":"text"},{"text":"Value","type":"text","marks":[{"type":"code"}]},{"text":". A case identifier (","type":"text"},{"text":"CaseId","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"ExternalId","type":"text","marks":[{"type":"code"}]},{"text":") must be supplied. In addition to the parameters below, the API can be extended to update additional case attributes. The names of ","type":"text"},{"text":"Attribute","type":"text","marks":[{"type":"code"}]},{"text":"s that can be updated with this service, can be found in reporting; also your iCasework representative can provide the values to use for specific attributes in your configuration.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request Method","type":"text"}]},{"type":"paragraph","content":[{"text":"POST","type":"text","marks":[{"type":"code"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"API Service endpoints","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"UAT: https://uat.icasework.com/updatecase?db=[youriCaseworkAccount]","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"eUAT / Production system: https://[youriCaseworkAccount].icasework.com/updatecase","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Your iCasework account name will be supplied to you by your iCasework Account or Project Manager","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request Parameters","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"6035baeb-85ae-4153-980e-531ca97f62f1"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"Values","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"Required value?","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"CaseId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"The internal identifier for the case you wish to update","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"\"324234321\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"No.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"ExternalId","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"The external identifier for the case you wish to update","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"\"4657845\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"No.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"Format","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"Defines the format of the API response. The default value is \"xml\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"\"xml\" or \"json\"","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"No.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"Attribute","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"The name of the reportable attribute to be updated","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"“Details”","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"No.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[206.0]},"content":[{"type":"paragraph","content":[{"text":"Value","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"The value to update that reportable attribute","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[207.0]},"content":[{"type":"paragraph","content":[{"text":"“This documentation is great”","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[140.0]},"content":[{"type":"paragraph","content":[{"text":"No.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request","type":"text"}]},{"type":"codeBlock","content":[{"text":"","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"CaseId\": \"321123\",\n \"Format\": \"json\",\n \"isVulnerable\": \"true\",\n \"numberOfPets\": \"12\"\n}","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n321123\njson\ntrue\n12","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Response","type":"text"}]},{"type":"codeBlock","content":[{"text":" \n \n abc1234\n ","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"updatecaseattributeresponse\": {\n \"caseid\": \"511234\"\n }\n}","type":"text"}]},{"type":"paragraph","content":[{"text":"HTTP 400 responses","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","localId":"b152c4ac-666c-495d-8692-0a0c5ed530e1"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"X-Application-Error-Code","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"X-Application-Error-Info","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Troubleshooting tips","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"11000","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Invalid HTTP method","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Check the HTTP method of the request; this should be a POST","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"11001","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"API not available here","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Check the endpoint of the request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"11002","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Unable to identify case. Please provide a valid value for parameter CaseId or ExternalId.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Pass a value for ","type":"text"},{"text":"CaseId","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"ExternalId","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[254.0]},"content":[{"type":"paragraph","content":[{"text":"11005","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Unable to identify case. Please provide a valid value for parameter CaseId or ExternalId.","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[253.0]},"content":[{"type":"paragraph","content":[{"text":"Pass a valid value for ","type":"text"},{"text":"CaseId","type":"text","marks":[{"type":"code"}]},{"text":" that refers to a case in the system; if ","type":"text"},{"text":"CaseId","type":"text","marks":[{"type":"code"}]},{"text":" is not being passed then check that ","type":"text"},{"text":"ExternalId","type":"text","marks":[{"type":"code"}]},{"text":" references a case in the system","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"HTTP 403 responses","type":"text","marks":[{"type":"strong"}]}]},{"type":"table","attrs":{"layout":"default","localId":"066c716c-b5a0-45ca-bbb6-b53252106ccd"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"X-Application-Error-Code","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"X-Application-Error-Info","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-neutral, #F4F5F7)","rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Troubleshooting tips","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"11021","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Incorrect key or signature","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Check the authentication method of the request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"11021","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Invalid token (6)","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Check the authentication method of the request","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"11022","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Insufficient privileges for updating customer details","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[170.0]},"content":[{"type":"paragraph","content":[{"text":"Check that there is a power user associated with the ","type":"text"},{"text":"API key","type":"text","marks":[{"type":"link","attrs":{"href":"https://icasework.atlassian.net/wiki/spaces/UsefulFeedback/pages/2281996290"}}]},{"text":" and this user is a member of the same workspace that the target case is in.","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}