Tasks

Provides access to Task Force task management functions for third-party applications.

Methods:

• CreateTask - Creates a Task Force task with the specified parameters.
• DeleteTask - Deletes a Task Force task with the specified ID.
• ListTasks - Returns a list of Task Force tasks.
• UpdateTask - Updates a Task Force task with the specified parameters.

General Notes: All Scaffold web methods require that the Content Type of your request is "application/scaffold+json". The Host and Content-Length headers are not required. Scaffold's response Content-Type will always be "application/json". The formatting of JSON shown in the examples on this page is not enforced in requests or necessarily followed in responses--it is only shown as such to enhance human readability--assume that you can send (and may receive) any legal JSON that has the same object, property, and array structures.

CreateTask

Creates a Task Force task with the specified parameters.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• name - The name of the task.
• notes - The notes for the task.
• customValues - The custom field values for the task.

Example Request:

POST /API/Tasks.aspx/CreateTask HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 219

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "name": "string",
  "notes": "string",
  "customValues": [
    {
      "customFieldId": 0,
      "value": "string"
    }
  ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 43

{
  "Response": 0,
  "Error": "string"
}

DeleteTask

Deletes a Task Force task with the specified ID.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• id - The ID of the task to be deleted.

Example Request:

POST /API/Tasks.aspx/DeleteTask HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 95

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "id": 0
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 25

{
  "Error": "string"
}

ListTasks

Returns a list of Task Force tasks.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• taskNameFilter - The text that must appear in a task's name for it to be included in the results; otherwise, specify null to impose no such requirement of inclusion.
• customFieldFilters - The custom field filters that a task must meet to be included in the results; otherwise, specify null or a zero-length array to impose no such requirements of inclusion.

Example Request:

POST /API/Tasks.aspx/ListTasks HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 214

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "taskNameFilter": "string",
  "customFieldFilters": [
    {
      "customFieldId": 0,
      "filter": "string"
    }
  ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 285

{
  "Response": [
    {
      "Id": 0,
      "Name": "string",
      "Notes": "string",
      "CustomValues": [
        {
          "CustomFieldId": 0,
          "CustomFieldName": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "Error": "string"
}

UpdateTask

Updates a Task Force task with the specified parameters.

Parameters:

• accountLogin - The login of the account against which this command will be executed.
• userLogin - The login of a user within the account with permission to execute this command.
• password - The password of the user as specified by the accountLogin and userLogin parameters.
• id - The ID of the task to be updated.
• name - The name of the task.
• notes - The notes for the task.
• customValues - The custom field values for the task.

Example Request:

POST /API/Tasks.aspx/UpdateTask HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 231

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "id": 0,
  "name": "string",
  "notes": "string",
  "customValues": [
    {
      "customFieldId": 0,
      "value": "string"
    }
  ]
}

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 25

{
  "Error": "string"
}