Package com.mypurecloud.sdk.v2.model

Class WorkitemUpdate

java.lang.Object
com.mypurecloud.sdk.v2.model.WorkitemUpdate
All Implemented Interfaces:
Serializable
public class WorkitemUpdate extends Object implements Serializable
WorkitemUpdate
See Also:

  • Constructor Details

    • WorkitemUpdate

      public WorkitemUpdate()

    • WorkitemUpdate

      public WorkitemUpdate(Boolean initWithEmptyList)

  • Method Details

    • name

      public WorkitemUpdate name(String name)
      The name of the Workitem. Valid length between 3 and 256 characters.

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • priority

      public WorkitemUpdate priority(Integer priority)
      The priority of the Workitem. The valid range is between -25,000,000 and 25,000,000.

    • getPriority

      public Integer getPriority()

    • setPriority

      public void setPriority(Integer priority)

    • dateDue

      public WorkitemUpdate dateDue(Date dateDue)
      The due date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateDue

      public Date getDateDue()

    • setDateDue

      public void setDateDue(Date dateDue)

    • dateExpires

      public WorkitemUpdate dateExpires(Date dateExpires)
      The expiry date of the Workitem. Can not be greater than 365 days from the current time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateExpires

      public Date getDateExpires()

    • setDateExpires

      public void setDateExpires(Date dateExpires)

    • durationSeconds

      public WorkitemUpdate durationSeconds(Integer durationSeconds)
      The estimated duration in seconds to complete the Workitem. Maximum of 365 days.

    • getDurationSeconds

      public Integer getDurationSeconds()

    • setDurationSeconds

      public void setDurationSeconds(Integer durationSeconds)

    • ttl

      public WorkitemUpdate ttl(Integer ttl)
      The epoch timestamp in seconds specifying the time to live for the Workitem. Can not be greater than 365 days from the current time.

    • getTtl

      public Integer getTtl()

    • setTtl

      public void setTtl(Integer ttl)

    • statusId

      public WorkitemUpdate statusId(String statusId)
      The ID of the Status of the Workitem.

    • getStatusId

      public String getStatusId()

    • setStatusId

      public void setStatusId(String statusId)

    • workbinId

      public WorkitemUpdate workbinId(String workbinId)
      The ID of Workbin that contains the Workitem.

    • getWorkbinId

      public String getWorkbinId()

    • setWorkbinId

      public void setWorkbinId(String workbinId)

    • autoStatusTransition

      public WorkitemUpdate autoStatusTransition(Boolean autoStatusTransition)
      Set it to false to disable auto status transition. By default, it is enabled.

    • getAutoStatusTransition

      public Boolean getAutoStatusTransition()

    • setAutoStatusTransition

      public void setAutoStatusTransition(Boolean autoStatusTransition)

    • description

      public WorkitemUpdate description(String description)
      The description of the Workitem. Maximum length of 512 characters.

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • dateClosed

      public WorkitemUpdate dateClosed(Date dateClosed)
      The closed date of the Workitem. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateClosed

      public Date getDateClosed()

    • setDateClosed

      public void setDateClosed(Date dateClosed)

    • assignmentState

      public WorkitemUpdate assignmentState(WorkitemUpdate.AssignmentStateEnum assignmentState)
      The assignment state of the Workitem.

    • getAssignmentState

      public WorkitemUpdate.AssignmentStateEnum getAssignmentState()

    • setAssignmentState

      public void setAssignmentState(WorkitemUpdate.AssignmentStateEnum assignmentState)

    • assignmentOperation

      public WorkitemUpdate assignmentOperation(WorkitemUpdate.AssignmentOperationEnum assignmentOperation)
      Set this value to AgentAssignmentAlerting and supply an 'assigneeId' to assign the workitem to an agent and alert the agent of the assignment. Set this value to QueueAssignmentAlerting and supply a 'queueId' to route the workitem to an agent who is a member of the queue and alert the agent.

    • getAssignmentOperation

      public WorkitemUpdate.AssignmentOperationEnum getAssignmentOperation()

    • setAssignmentOperation

      public void setAssignmentOperation(WorkitemUpdate.AssignmentOperationEnum assignmentOperation)

    • customFields

      public WorkitemUpdate customFields(Map<String,Object> customFields)
      Custom fields defined in the schema referenced by the worktype of the workitem. If set to {}, the existing keys and values will be removed.

    • getCustomFields

      public Map<String,Object> getCustomFields()

    • setCustomFields

      public void setCustomFields(Map<String,Object> customFields)

    • queueId

      public WorkitemUpdate queueId(String queueId)
      The ID of the Workitems queue. Must be a valid UUID.

    • getQueueId

      public String getQueueId()

    • setQueueId

      public void setQueueId(String queueId)

    • assigneeId

      public WorkitemUpdate assigneeId(String assigneeId)
      The ID of the assignee of the Workitem. If supplied it must be a valid UUID.

    • getAssigneeId

      public String getAssigneeId()

    • setAssigneeId

      public void setAssigneeId(String assigneeId)

    • scoredAgents

      public WorkitemUpdate scoredAgents(List<WorkitemScoredAgentRequest> scoredAgents)
      A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents.

    • getScoredAgents

      public List<WorkitemScoredAgentRequest> getScoredAgents()

    • setScoredAgents

      public void setScoredAgents(List<WorkitemScoredAgentRequest> scoredAgents)

    • externalContactId

      public WorkitemUpdate externalContactId(String externalContactId)
      The ID of the external contact of the Workitem. Must be a valid UUID.

    • getExternalContactId

      public String getExternalContactId()

    • setExternalContactId

      public void setExternalContactId(String externalContactId)

    • externalTag

      public WorkitemUpdate externalTag(String externalTag)
      The external tag of the Workitem.

    • getExternalTag

      public String getExternalTag()

    • setExternalTag

      public void setExternalTag(String externalTag)

    • skillIds

      public WorkitemUpdate skillIds(List<String> skillIds)
      The skill IDs of the Workitem. Must be valid UUIDs.

    • getSkillIds

      public List<String> getSkillIds()

    • setSkillIds

      public void setSkillIds(List<String> skillIds)

    • languageId

      public WorkitemUpdate languageId(String languageId)
      The ID of language of the Workitem. Must be a valid UUID.

    • getLanguageId

      public String getLanguageId()

    • setLanguageId

      public void setLanguageId(String languageId)

    • utilizationLabelId

      public WorkitemUpdate utilizationLabelId(String utilizationLabelId)
      The ID of the utilization label of the Workitem. Must be a valid UUID.

    • getUtilizationLabelId

      public String getUtilizationLabelId()

    • setUtilizationLabelId

      public void setUtilizationLabelId(String utilizationLabelId)

    • preferredAgentIds

      public WorkitemUpdate preferredAgentIds(List<String> preferredAgentIds)
      The preferred agent IDs of the Workitem. Must be valid UUIDs.

    • getPreferredAgentIds

      public List<String> getPreferredAgentIds()

    • setPreferredAgentIds

      public void setPreferredAgentIds(List<String> preferredAgentIds)

    • scriptId

      public WorkitemUpdate scriptId(String scriptId)
      The ID of the Workitems script. Must be a valid UUID.

    • getScriptId

      public String getScriptId()

    • setScriptId

      public void setScriptId(String scriptId)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object