Task information

Get task information by ID

Get information such as start date, due date etc about a task.

Parameters

Parameter	Description
Task app name	Name of Task app in SharePoint (not id)
Task ID	ID of task

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member	Description
HasFailed	Whether operation has failed or not
ErrorMessage	A description of the failure, if any
ErrorCode	An error code related to operation failure. Is 0 if no failure occured
Results	Record variable containing the results of operation

Structure of Results Results

• ID

  ParentID

  TaskName

  DueDate

  StartDate

  AssignedTo

  • UserID

  • Value

  Predecessors

  • TaskID

  • Value

  Priority

  PercentComplete

  Description

  Status

Errors

Error code	Description
1000	Unspecified error.
1000001	User is not authorized to perform operation.
1000004	Item with given id does not exist.

Get task information by name

Get information such as start date, due date etc about all tasks with given name.

Parameters

Parameter	Description
Task app name	Name of Task app in SharePoint (not id)
Task name	Name of task

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member	Description
HasFailed	Whether operation has failed or not
ErrorMessage	A description of the failure, if any
ErrorCode	An error code related to operation failure. Is 0 if no failure occured
Results	Table variable containing the results of operation

Structure of Results Results

• ID

  ParentID

  TaskName

  DueDate

  StartDate

  AssignedTo

  • UserID

  • Value

  Predecessors

  • TaskID

  • Value

  Priority

  PercentComplete

  Description

  Status

Errors

Error code	Description
1000	Unspecified error.
1000001	User is not authorized to perform operation.

Get task information by query

Gets information about tasks by provided CAML Query. Example to get all tasks that are 50% or more completed:

<View>
    <Query>
        <Where>
            <Geq>
                <FieldRef Name='PercentComplete' />
                <Value Type='Number'>0.50</Value>
            </Geq>
        </Where>
    </Query>
</View>

Parameters

Parameter	Description
Task app name	Name of Task app in SharePoint (not id)
CAML Query	The query to send to SharePoint.

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member	Description
HasFailed	Whether operation has failed or not
ErrorMessage	A description of the failure, if any
ErrorCode	An error code related to operation failure. Is 0 if no failure occured
Results	Table variable containing the results of operation

Structure of Results Results

• ID

  ParentID

  TaskName

  DueDate

  StartDate

  AssignedTo

  • UserID

  • Value

  Predecessors

  • TaskID

  • Value

  Priority

  PercentComplete

  Description

  Status

Errors

Error code	Description
1000	Unspecified error.
1000001	User is not authorized to perform operation.

Get task property value

Gets the value of a field of a given task. This is an advanced operation that require deeper knowledge on how SharePoint works. The Property parameter is the identifier of a field, which might not be the same as is displayed in SharePoint. E.g use 'Body' as Property to update 'Description'.

Parameters

Parameter	Description
Task app name	Name of Task app in SharePoint (not id)
Task ID	ID of task
Property	Name of property

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member	Description
HasFailed	Whether operation has failed or not
ErrorCode	An error code related to operation failure. Is 0 if no failure occured
Results	Simple variable containing the results of operation

Errors

Error code	Description
1000	Unspecified error.
1000001	User is not authorized to perform operation.
1000004	Item with given id does not exist.

List fields of tasks

Lists the fields that are available for tasks in Task app.

Parameters

Parameter	Description
Task app name	Name of Task app in SharePoint (not id)
Include read only fields	Specifies whether to include fields that can only be read in the results of the operation

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member	Description
HasFailed	Whether operation has failed or not
ErrorMessage	A description of the failure, if any
ErrorCode	An error code related to operation failure. Is 0 if no failure occured
Results	Table variable containing the results of operation

Structure of Results Results StaticName Title Description DefaultValue ReadOnly Required TypeAsString

Errors

Error code	Description
1000	Unspecified error.
1000001	User is not authorized to perform operation.

List tasks

Lists all tasks.

Parameters

Parameter	Description
Task app name	Name of Task app in SharePoint (not id)
Row limit	Limit on how many tasks to list. A value of -1 indicates no limit

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member	Description
HasFailed	Whether operation has failed or not
ErrorMessage	A description of the failure, if any
ErrorCode	An error code related to operation failure. Is 0 if no failure occured
Results	Table variable containing the results of operation

Structure of Results Results

• ID

  ParentID

  TaskName

  DueDate

  StartDate

  AssignedTo

  • UserID

  • Value

  Predecessors

  • TaskID

  • Value

  Priority

  PercentComplete

  Description

  Status

Errors

Error code	Description
1000	Unspecified error.
1000001	User is not authorized to perform operation.

List tasks assigned to current user

Lists all tasks assigned to current user. Optionally including finished tasks.

Parameters

Parameter	Description
Task app name	Name of Task app in SharePoint (not id)
Include already finshed tasks	Specifies whether to also include completed tasks

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member	Description
HasFailed	Whether operation has failed or not
ErrorMessage	A description of the failure, if any
ErrorCode	An error code related to operation failure. Is 0 if no failure occured
Results	Table variable containing the results of operation

Structure of Results Results

• ID

  ParentID

  TaskName

  DueDate

  StartDate

  AssignedTo

  • UserID

  • Value

  Predecessors

  • TaskID

  • Value

  Priority

  PercentComplete

  Description

  Status

Errors

Error code	Description
1000	Unspecified error.
1000001	User is not authorized to perform operation.

List tasks assigned to specific user

Lists all tasks assigned to specified user. Optionally including finished tasks.

Parameters

Parameter	Description
Task app name	Name of Task app in SharePoint (not id)
User ID	ID of user
Include already finshed tasks	Specifies whether to also include completed tasks

Output

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

Member	Description
HasFailed	Whether operation has failed or not
ErrorMessage	A description of the failure, if any
ErrorCode	An error code related to operation failure. Is 0 if no failure occured
Results	Table variable containing the results of operation

Structure of Results Results

• ID

  ParentID

  TaskName

  DueDate

  StartDate

  AssignedTo

  • UserID

  • Value

  Predecessors

  • TaskID

  • Value

  Priority

  PercentComplete

  Description

  Status

Errors

Error code	Description
1000	Unspecified error.
1000001	User is not authorized to perform operation.