Assignments

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

Methods:

• CreateAssignments - Creates Task Force assignments with the specified parameters.
• DeleteAssignments - Deletes Task Force assignments with the specified IDs.
• ListAssignments - Returns a list of Task Force assignments.
• UpdateAssignments - Update Task Force assignments 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.

CreateAssignments

Creates Task Force assignments 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.
• taskIds - The IDs of the tasks being assigned.
• userIds - The IDs of the users to whom each of the tasks will be assigned.
• due - The due date to set for each assignment created in Coordinated Universal Time (e.g. "2010-07-31T12:45:29Z"); otherwise, specify null for no due date.
• estimate - The estimate to set for each assignment created, in seconds; otherwise, specify null for no estimate.

Example Request:

POST /API/Assignments.aspx/CreateAssignments HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 179

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "taskIds": [
    0
  ],
  "userIds": [
    0
  ],
  "due": "string",
  "estimate": 0
}

Example Response:

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

{
  "Error": "string"
}

DeleteAssignments

Deletes Task Force assignments with the specified IDs.

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.
• assignmentIds - The IDs of the assignments to be deleted.

Example Request:

POST /API/Assignments.aspx/DeleteAssignments HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 118

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "assignmentIds": [
    0
  ]
}

Example Response:

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

{
  "Error": "string"
}

ListAssignments

Returns a list of Task Force assignments.

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.
• assignmentType - The type of assignments to be returned in the list.
• taskNameFilter - The text that must appear in an assignment's 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 an assignment's task must meet to be included in the results; otherwise, specify null or a zero-length array to impose no such requirements.
• userIds - An array specifying the users to whom an assignment has been entered for it to be included. If null or empty, users will not be considered.

Example Request:

POST /API/Assignments.aspx/ListAssignments HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 367

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "assignmentType": "All -or- Incomplete -or- PastDue -or- Complete -or- OnTime -or- Late -or- OverCost -or- Unscheduled",
  "taskNameFilter": "string",
  "customFieldFilters": [
    {
      "customFieldId": 0,
      "filter": "string"
    }
  ],
  "userIds": [
    0
  ]
}

Example Response:

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

{
  "Response": [
    {
      "Complete": "string",
      "Due": "string",
      "Estimate": 0,
      "Id": 0,
      "TaskCustomValues": [
        {
          "CustomFieldId": 0,
          "CustomFieldName": "string",
          "Value": "string"
        }
      ],
      "TaskId": 0,
      "TaskName": "string",
      "Time": 0,
      "UserId": 0,
      "UserName": "string"
    }
  ],
  "Error": "string"
}

UpdateAssignments

Update Task Force assignments 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.
• assignmentIds - The IDs of the assignments to be updated.
• due - The due date to set for each assignment updated in Coordinated Universal Time (e.g. "2010-07-31T12:45:29Z"); otherwise, specify null for no due date.
• estimate - The estimate to set for each assignment updated, in seconds; otherwise, specify null for no estimate.

Example Request:

POST /API/Assignments.aspx/UpdateAssignments HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 156

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "assignmentIds": [
    0
  ],
  "due": "string",
  "estimate": 0
}

Example Response:

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

{
  "Error": "string"
}