McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 257

↗ View in doc context
page
257
source
finesse/v12.5/developer-guide/developer-guide.md
chunk_id
finesse::v12.5::developer-guide::developer-guide::241

category (required): The category of reason code (NOT_READY or LOGOUT) code (required):The code for the reason code label (required): The UI label for the reason code forAll (required): Whether the reason code is global (true) or non-global (false) Request Parameters: 200: Success Finesse successfully created the new ReasonCode. The response contains an empty response body, and a "location:" header denoting the absolute URL of the newly created ReasonCode object Note 400: Bad Request 400: Finesse API Error 400: Maximum Exceeded 401: Authorization Failure 401: Invalid Authorization User Specified 403: Forbidden 500: Internal Server Error HTTP Response: <ApiErrors> <ApiError> <ErrorType>Authorization Failure</ErrorType> <ErrorMessage>UNAUTHORIZED</ErrorMessage> <ErrorData>jsmith</ErrorData> </ApiError> </ApiErrors> Example Failure Response: ReasonCode—Update This API allows an administrator to modify an existing reason code. The administrator specifies an existing reason code via the uri, which includes its id, along with the value of the field to update. At least one of the following parameters must be present in the HTTP request to update a reason code: code, label, or forAll. If none of these parameters are present, Finesse returns an Invalid Input error. You do not need to include the attributes (code, label, or forAll) that you do not want to change. For example, if you want to change only the label for an existing reason code from "In Meeting" to "Attend Meeting", you can send the following request: <ReasonCode> <label>Attend Meeting</label> </ReasonCode> If you provide two or more duplicate tags in the XML body for a PUT operation, the value of the last duplicate tag is processed and all other duplicate tags are ignored. Note https://<FQDN>/finesse/api/ReasonCode/<id> URI: https://finesse1.xyz.com/finesse/api/ReasonCode/456 Example URI: Cisco Finesse Web Services Developer and JavaScript Guide, Release 12.5(1) 241 Cisco Finesse Configuration APIs ReasonCode—Update