/
task_set ()

task_set ()

Owned by Former user (Deleted)
Function prototype

task_set (session, task)

API VersionAll

Modifies the properties of a TASK OBJECT

Input


  • session: a token obtained by a session_init () call
  • task: a task XML object ( can be retrieved calling the function task_get() ). The XML can be more simple than the task_get() XML retrieved.
    • ref: task reference
    • assignments/assignment: is the list of roles of the task with the users that can be modify the task
      • team:
        • ref: Reference of assigned TEAM
      • role:
        • ref: Reference of the assigned ROLE
      • user:
        • ref: Reference of the assigned PROFESSIONAL
    • date: is the date in YYYY-MM-DD format of the task
    • hour: is the time in HH:MM:SS format of the task ( if the task is PENDING, is the planning date-hour. If the task is DONE, is the  last modify date-hour). This property is ignored if unscheduled = true

    • unscheduled: (true/false) Indicates whether the TASK has not been defined for a specific time of the day (can be done at any time of the day). When this property is true, the hour will be ignored. Introduced in API Version 2.7.25

    • duration: is the prevision of the duration to doing the task
    • follow_report: Y/N is the check that marks if the task is included in the followup report
    • status: DONE/PENDING

    • recursive: The TASK will be replicated recursively according to the selected frequency:

      • NULL (not recursive)

      • 'EVERYHOUR'

      • '4ADAY'

      • '3ADAY'

      • '2ADAY'

      • 'DAY'

      • 'WEEK', 'WEEK{week_days}: The TASK will be repeated on a weekly basis. Since API Version 2.7.21 it is possible to append a modifier indicating only certain days of the week. For example, WEEK{MF} means that the TASK will be repeated weekly on Mondays and Fridays

      • 'BEWEEK'

      • 'MONTH'

      • 'YEAR'

    • recursive_mode: To define how RECURSIVE TASKS are generated. This property is only used when frequency is not NULL. Introduced in API Version 2.7.26
      Valid values are:

      • 0: The new iteration of a RECURSIVE TASK is generated when the TASK si closed

      • 1: The new iteration of a RECURSIVE TASK is generated automatically by the system even when the previous TASK is not closed. The TASK is generated when the date/time of the theoretic next TASK arrives. For example, i a TASK has a frequency of type 'DAY' and is programmed for '2018-11-01 09:00:00', the next programmed TASK should occur on '2018-11-02 09:00:00', so if that time arrives and the previous TASK is not closed yet, then the new iteration is calculated automatically

    • locked: Indicates whether the TASK is 'locked' or not. A locked TASK cannot be answered by the user to whom it is assigned. Usually a TASK is locked when you don't want it to be completed until another condition happens (for example until a previous TASK has been completed). The 'locked' status of a TASK can be changed using a FORMULA LOCK_TASK(), or API function /wiki/spaces/DES/pages/16974090.

Output

parameters:

  • result: empty
  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language
  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request

sample:

task_set( “LC0000000000”, “

<task>
  <ref>10627</ref>
  <assignments>
    <assignment>
	  <team>
         <ref>1</ref>
      </team>
      <role>
         <ref>23</ref>
      </role>
      <user>
        <ref>1056</ref>
      </user>
    </assignment>
    <assignment>
	  <team>
         <ref>1</ref>
      </team>
      <role>
         <ref>22</ref>
      </role>
      <user>
        <ref>1056</ref>
      </user>
    </assignment>
  </assignments>
  <date>2011-03-25</date>
  <hour>11:19:11</hour>
  <unscheduled>false</unscheduled>
  <duration>20</duration>
  <follow_report>N</follow_report>
  <status>DONE</status>
  <recursive>DAY</recursive>
  <locked></locked>
</task>


 “);

Response

sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>

<ErrorMsg></ErrorMsg>

Notes:


Related content