Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note

If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.

Provides the associations between users and tasks.

URL:

/editor/taskuserassoc/[ID]

Available Methods:

GET / POST / PUT / DELETE

Specialities:

 


Resource Layout

Name

Type

Info

id

int

GET only

entityVersionint
GET only, set by server
PUT / POST only, optional, is compared against the tasks entity version

taskGuid

string

 


userGuid

string

 


login

string

GET only, set by server

surName

string

GET only, set by server

firstName

string

GET only, set by server

state

string

 

Valid values depend on the used workflow, for the default see the API usage in basic workflow description.

role

string

 

DEPRECATED use workflowStepName instead!

workflowStepNamestringValid values depend on the used workflow, for the default see the API usage in basic workflow description.
usedStatestringGET only, set by server
usedInternalSessionUniqIdstringGET only, set by server
isPmOverrideintegerGET only, set by server
staticAuthHashstringGET only, set by server; Needed for single click authentication. Only readable for users with role "api".
deadlineDatedate

The date when the user should finish the assigned job. For each workflow and workflow step, can be defined 

how many days (excluding week-ends) the deadline should be in the future based on task order date.

ex: In this config runtimeOptions.workflow.default.translation.defaultDeadlineDate, you can define the default deadline date for default workflow and translation step

To use the defaultDeadline date config, set the deadlineDate with value "default" on post request.


assignmentDatedateThe date when the user is assigned to the job. (if the date is not set, it will be current date)
finishedDatedateThe date when the user finished the assigned job.