Task Services, Version 3.0

92 Task Services, Version 3.0

This chapter provides the information necessary to send messages contained in Version 3.0 of the Task Services API. Information can be obtained using the Web Service Description Language (WSDL) in conjunction with a Simple Object Access Protocol (SOAP), XML Schema, and various methods contained in the classes of the API to provide the web service described above.

The URL for the WSDL is:

https://<servername>:<portNumber>/ws/v3_0/TaskServices?wsdl

where <servername> is the name or address of the server. For a cloud installation, the default port number is 443.

The information presented below describes the methods and classes.

The format of the method and any arguments is shown along with an explanation of what the method does and any other information that is necessary to use the method properly. If an argument is shown in dark blue, it is a class and the class name is a link to a description of the class and its attributes.

The class section shows the attributes of the classes along with an explanation of each attribute and when necessary, when they are used.

Note:

Authentication is required. See Introduction for information on creating and implementing an authentication key.

Methods

This section presents the methods used in Version3.0 of the Task Services.

addTaskNotes

TaskNoteType addTaskNotes(                           TaskNoteType taskNoteType,                           string securityUserId)     throws RelateProcessingException

Variable Required? Description

Variable	Required?	Description
`taskNoteType`	[optional]	Task note to add. Note: Information that maps to a person’s identity is not protected if stored in task notes. Oracle does not recommend using task notes to store personal data.
`securityUserId`	[required]	ID of the user adding the task note.

taskNoteType

[optional]

Task note to add.

Note: Information that maps to a person’s identity is not protected if stored in task notes. Oracle does not recommend using task notes to store personal data.

securityUserId

[required]

ID of the user adding the task note.

The addTaskNotes method adds a note to an existing task.

This method returns a TaskNoteType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

getTaskList

TaskListResponseType getTaskList(                        TaskSearchCriteriaType[] taskSearchCriteria)                        int startIndex                        int pageSize                        string securityUserId     throws RelateProcessingException

Variable	Required?	Description
`taskSearchCriteria`	[optional]	Array of search criteria.
`startIndex`	[optional]	Indicates the first task to include in the response.
`pageSize`	[optional]	Indicates the number of tasks to include in the response. If not specified, the setting of the Task Web Service Response Page Size property is used. This property defines the default number of tasks to include in the response message. The startIndex enables the integrating system to specify the first task to include in the next response if the number of tasks exceeds the pageSize.
`securityUserId`	[required]	ID of the user requesting the task list.

The getTaskList method retrieves the tasks that match the given search criteria.

This method returns aTaskListResponseType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

getTaskNotes

TaskNoteType[] getTaskNotes(                             long taskId,                             string type,                             string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`taskId`	[required]	ID of the task.
`type`	[optional]	Type of task note.
`securityUserId`	[required]	ID of the user making the request.

The getTaskNotes method retrieves the notes associated with a task.

This method returns an array of TaskNoteType elements.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

getTaskPriorityCodes

TaskAttributesType(            [] getTaskPriorityCodes()             string securityUserId

The getTaskPriorityCodes method returns all the priority codes available in Customer Engagement.

This method returns an array of TaskAttributesType elements.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

getTaskStatusCodes

TaskAttributesType
              [] getTaskStatusCodes()             string securityUserId

The getTaskStatusCodes method returns all the status codes available in Customer Engagement.

This method returns an array of TaskAttributesType elements.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

getTaskTypeCodes

TaskAttributesType               [] getTaskTypeCodes()              string securityUserId

The getTaskTypeCodes method returns all the task type codes available in Customer Engagement.

This method returns an array of TaskAttributesType elements.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

saveOrUpdateTask

TaskType saveOrUpdateTask(                           string updateUserId,                           TaskRequestType taskType)                           string securityUserID     throws RelateProcessingException

Variable	Required?	Description
`updateUserId`	[required]	ID of the user processing the update.
`taskType`	[optional]	Task being added or updated.
`securityUserId`	[required]	ID of the user making the request.

The saveOrUpdateTask method creates or updates a task with the information in taskType.

This method returns a TaskType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

saveTaskStatus

TaskType saveTaskStatus(                         long taskId,                         string itemStatusValue,                         string updateUserId)                         string securityUserId)     throws RelateProcessingException

Variable	Required?	Description
`taskId`	[required]	ID of the task.
`itemStatusValue`	[optional]	Status of the task.
`updateUserId`	[required]	ID of the user processing the update.
`securityUserId`	[required]	ID of the user making the request.

The saveTaskStatus updates the status of a task.

This method returns a TaskType element.

Note:

The securityUserId provided within this message must be assigned the proper Security Group permission for this operation to be performed successfully.

Classes

This section presents the classes used in Version3.0 of the Task Services.

RelateProcessingException

For a description of this class, see Introduction.

TaskAttributesType

The TaskAttributesType class contains the following elements:

Type	Element	Description
string	attributeType	ID for the type of attribute.
string	attributeValue	Value of the attribute.
int	sortOrder	Order in which the attribute is displayed.
boolean	hiddenFlag	Indicates whether the attributes is hidden.
date	createDate	Date on which the attribute was created.
string	createUserId	ID of the user who created the attribute.
date	updateDate	Date on which the attributes was most recently updated.
string	updateUserId	ID of the user who most recently updated the attribute.

TaskCustomerRequestType

The TaskCustomerRequestType class contains the following element:

Type	Element	Description
string	custId	ID of the customer.

TaskCustomerType

The TaskCustomerType class contains the following elements:

Type	Element	Description
string	custId	ID of the customer.
string	firstName	First name of the customer.
string	lastName	Last name of the customer.

TaskNoteRequestType

The TaskNoteRequestType class contains the following elements:

Type	Element	Description
string	note	Text of the note.
string	noteType	Type of note.

TaskListResponseType

The TaskListResponseType class includes the following elements:

Type	Element	Description
TaskType[]	TaskType	Information about the tasks.
integer	startIndex	Identifies the first task returned in the response.
boolean	morePages	Indicates whether more pages of tasks can be returned.
integer	pageSize	The number of tasks in the response.

TaskNoteType

The TaskNoteType class contains the following elements:

Type	Element	Description
long	taskId	ID of the task.
string	note	Text of the note.
string	noteType	Type of note.
string	createUserId	ID of the user who created the note.
datetime	createDate	Date on which the note was created.

TaskPromotionRequestType

The TaskPromotionRequestType class contains the following element:

Type	Element	Description
long	campaignId	ID of the campaign.
long	promotionId	ID of the promotion.

TaskRelateUserRequestType

The TaskRelateUserRequestType class contains the following element:

Type	Element	Description
string	userId	ID of the user.

TaskRelateUserType

Type	Element	Description
string	userId	ID of the user.
string	name	Name of the user.
string	email	Email address for the user.

TaskRequestType

The TaskRequestType class contains the following elements:

Type	Element	Description
long	taskId	ID of the task.
string	subject	Subject of the task.
string	retailLocationId	ID of the retail location for the task.
dateTime	startDateTime	Date and time on which the task begins.
dateTime	endDateTime	Date and time on which the task ends.
string	itemStatusValue	Status of the task.
string	itemTypeValue	Value of the task.
string	itemPriorityValue	Priority of the task.
TaskRelateUserRequestType[]	taskRelateUsers	Users assigned to the task.
TaskCustomerRequestType[]	taskCustomers	Customers associated with the task.
TaskNoteRequestType[]	taskNotes	Notes for the task.
TaskPromotionRequestType[]	promotions	Promotions associated with the task.

TaskSearchCriteriaType

The TaskSearchCriteriaType class contains the following elements:

Type	Element	Description
string[]	fieldValue	Value in the search field.
TaskSearchFieldType	searchFieldType	Type of search field.
SearchOperatorType	searchOperator	Comparison operator for the search.

TaskType

The TaskType class contains the following elements:

Type	Element	Description
long	taskId	ID of the task.
string	subject	Subject of the task.
string	retailLocationId	ID of the retail location for the task.
dateTime	startDateTime	Date and time on which the task begins.
dateTime	endDateTime	Date and time on which the task ends.
string	itemStatusValue	Status of the task.
string	itemTypeValue	Value of the task.
string	itemPriorityValue	Priority of the task.
TaskRelateUserRequestType[]	taskRelateUsers	Users assigned to the task.
TaskCustomerRequestType[]	taskCustomers	Customers associated with the task.
TaskNoteRequestType[]	taskNotes	Notes for the task.