WorkflowAction—Delete

This API allows an administrator to delete an existing workflow action. The administrator references the existing WorkflowAction object by its ID.

URI:

https://<FQDN>/finesse/api/WorkflowAction/<id>

Example URI:

https://finesse1.xyz.com/finesse/api/WorkflowAction/768

Security Constraints:

Only administrators can use this API.

HTTP Method:

DELETE

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request:

—

HTTP Response:

200: Success

400: Bad Request

400: Finesse API Error

401: Authorization Failure

403: Forbidden

404: Not Found

500: Internal Server Error

Example Failure Response: 

<ApiErrors>
   <ApiError>
      <ErrorData>Action 768 not found.</ErrorData>
      <ErrorType>Not Found</ErrorType>
      <ErrorMessage>
         HTTP Status code: 404 (Not Found)
         Api Error Type:  Not Found
         Error Message: This is not a valid action
      </ErrorMessage>
   </ApiError>
</ApiErrors>