Business Entity Services Guide

10.3 HotFix 1

Back Next

Request Body

Use the Read Task API to get the details of the task. Specify the task attributes when you update the task. Use the JSON format or the XML format to send the data to update in the request.

The following table describes the task parameters in the request body:

Parameter	Description
taskType	A set of actions that you can perform on a record. Use the name attribute to specify the task type. For more information about task types, see the Multidomain MDM Data Director Implementation Guide .
taskId	ID of the task.
owner	User who performs the task.
title	Short description for the task.
comments	Comments for the task.
attachments	Attachments for the task.
dueDate	Date when the owner must complete the task.
status	Status of the task in the workflow. Use one of the following two values: Open: Task has not started or is in progress. Closed: Task is completed or is cancelled.
priority	Level of importance of the task. Use one of the following values: high, normal, and low. Default is normal.
creator	User who creates the task.
createDate	Date when the task was created.
updatedBy	User who updates the task.
lastUpdateDate	Date when the task was last updated.
orsId	ID of the ORS as registered in the Databases tool in the Hub Console.
processId	ID of the workflow process that contains the task.
taskRecord	The root record or the cross-reference record associated with the task. Use the row ID or the source system and source key to specify the record.
businessEntity name	Name of the business entity to which the taskRecord belongs.

The following sample code uses the rowId to specify the taskRecord:

taskRecord: [{
       businessEntity:{
         name: 'Person',
         key:{
            rowid: '233',
            systemName: '',
            sourceKey: ''
         }
       }
     }]

For a PATCH request, the request body contains those task fields that you want to change. You can change the task title, the priority, the due date, and the owner.

For a PUT request, the request body contains all task fields. Use the following request body for a PUT request:

{    
     taskType: {name:"name of the task"},
     taskId: "ID of the task",
     owner: "user who performs the task",
     title: "title of the task",
     comments: "description of the task",
     attachments: [
          {
               id: "TEMP_SVR1.1VDVS"
          }
     ],
     dueDate: "date to complete the task",
     status: "status of the task",
     priority: "priority of the task",
     creator: "use who creates the task",
     createDate: "date on which the task is created",
     updatedBy: "user who last updated the task",
     lastUpdateDate: "date on which the task was last updated",
     businessEntity: "name of the business entity",
     orsId: "database ID",
     processId: 'ActiveVOS task type ID',
     taskRecord: [{
       businessEntity:{
         name: 'name of the business entity',
         key:{
            rowid: 'rowId of the record',//Use the rowId or the source system and source key to identify the record.
            systemName: '',
            sourceKey: ''
         }
       }
     }]
}

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

Request Body

Request Body