Workflow—Update

This API allows an administrator to update an existing workflow.

If the attributes (name, description, TriggerSet, ConditionSet, workflowActions) for the specified workflow do not change, the request does not need to include those attributes. If an attribute is not specified, the current value is retained. However, you must specify at least one attribute in the request.

If you only want to change the description of the workflow, you can make the following request: 

<Workflow>
   <description>New description</description>
</Workflow>
Note

If you provide two or more duplicate tags during a PUT, the value of the last duplicate tag is processed and all other duplicate tags are ignored.

URI:

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

Example URI:

https://finesse1.xyz.com/finesse/api/Workflow/769

Security Constraints:

Only administrators can use this API.

HTTP Method:

PUT

Content Type:

Application/XML

Input/Output Format:

XML

HTTP Request: 

<Workflow>
   ...Workflow Object...
</Workflow>

Request Parameters:

id (required): Maps to the primary key of the workflow entry

name (optional): The name of the workflow

description (optional): A description of the workflow

Media (optional): The media of the workflow

TriggerSet (optional): A set of events that cause the conditions to be evaluated

ConditionSet (optional): A set of conditions that determine if the workflow is run

workflowActions (optional): A list of workflow actions to run if the trigger and conditions are satisfied

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>For update, at least one field must be set.</ErrorData>
      <ErrorType>Invalid Input</ErrorType>
      <ErrorMessage>
         HTTP Status code: 400 (Bad Request)
         Api Error Type:  Invalid Input
         Error Message: Updating a Workflow requires specifying at 
         least one value to be changed.
      </ErrorMessage>
   </ApiError>
</ApiErrors>