WorkflowAction—Get

This API allows an administrator to get a specific WorkflowAction object.

URI:

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

Example URI:

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

Security Constraints:

Only administrators can use this API.

HTTP Method:

GET

Content Type:

—

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 Response: 

<WorkflowAction>
   ...Full WorkflowAction Object...
</WorkflowAction>

Example Failure Response: 

<ApiErrors>
   <ApiError>
      <ErrorData>Action 674 not found.</ErrorData>
      <ErrorType>Not Found</ErrorType>
      <ErrorMessage>HTTP Status code:404 (Not Found)
         Api Error Type:  Not Found
         Error Message: Workflow not found with an id of 674
      </ErrorMessage>
   </ApiError>
</ApiErrors>