Reporting

Provides access to Task Force reports for third-party applications.

Methods:

Breakdown - Runs the Task Force Breakdown report with the specified parameters.
Grid - Runs the Task Force Grid report with the specified parameters.
TimeLog - Runs the Task Force Time Log report with the specified parameters.
Timesheet - Runs the Task Force Timesheet report with the specified parameters.
UserSyncs - Runs the Task Force Breakdown report 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.

Breakdown

Runs the Task Force Breakdown report with the specified parameters.

Parameters:

accountLogin - The login of the account against which the report will be run.
userLogin - The login of a user within the account with permission to run the report.
password - The password of the user as specified by the accountLogin and userLogin parameters.
breakdownBy - A string denoting how pie slices should be broken down. Valid values: task, user, or custom field ID.
taskNameFilter - A string that must be found in the name of any tasks to be included. If null or empty, no tasks will be filtered by name.
customFieldFilters - An array containing strings that must be found in the values of custom fields for tasks to be included. If null or empty, no tasks will be excluded because of custom field values.
dateFrom - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateTo are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
dateTo - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateFrom are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
userIds - An array specifying the users who must have logged time in order for it to be included. If null or empty, users will not be considered.

Example Request:

POST /API/Reporting.aspx/Breakdown HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 319

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

Example Response:

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

{
  "Response": [
    {
      "Name": "string",
      "Seconds": 0
    }
  ],
  "Error": "string"
}

Grid

Runs the Task Force Grid report with the specified parameters.

Parameters:

accountLogin - The login of the account against which the report will be run.
userLogin - The login of a user within the account with permission to run the report.
password - The password of the user as specified by the accountLogin and userLogin parameters.
breakdownBy1 - A string denoting the first dimension of the Grid. Valid values: task, user, or custom field ID.
breakdownBy2 - A string denoting the second dimension of the Grid. Valid values: task, user, or custom field ID.
taskNameFilter - A string that must be found in the name of any tasks to be included. If null or empty, no tasks will be filtered by name.
customFieldFilters - An array containing strings that must be found in the values of custom fields for tasks to be included. If null or empty, no tasks will be excluded because of custom field values.
dateFrom - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateTo are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
dateTo - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateFrom are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
userIds - An array specifying the users who must have logged time in order for it to be included. If null or empty, users will not be considered.

Example Request:

POST /API/Reporting.aspx/Grid HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 349

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "breakdownBy1": "string",
  "breakdownBy2": "string",
  "taskNameFilter": "string",
  "customFieldFilters": [
    {
      "customFieldId": 0,
      "filter": "string"
    }
  ],
  "dateFrom": "string",
  "dateTo": "string",
  "userIds": [
    0
  ]
}

Example Response:

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

{
  "Response": {
    "Headers": [
      "string"
    ],
    "Rows": [
      {
        "Name": "string",
        "Hours": [
          0.0
        ],
        "Total": 0.0
      }
    ],
    "Footer": {
      "Name": "string",
      "Hours": [
        0.0
      ],
      "Total": 0.0
    }
  },
  "Error": "string"
}

TimeLog

Runs the Task Force Time Log report with the specified parameters.

Parameters:

accountLogin - The login of the account against which the report will be run.
userLogin - The login of a user within the account with permission to run the report.
password - The password of the user as specified by the accountLogin and userLogin parameters.
taskNameFilter - A string that must be found in the name of any tasks to be included. If null or empty, no tasks will be filtered by name.
customFieldFilters - An array containing strings that must be found in the values of custom fields for tasks to be included. If null or empty, no tasks will be excluded because of custom field values.
dateFrom - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateTo are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
dateTo - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateFrom are not null or empty, only time within the range they specify will be used. Otherwise, all time in eligible tasks is used.
userIds - An array specifying the users who must have logged time in order for it to be included. If null or empty, users will not be considered.

Example Request:

POST /API/Reporting.aspx/TimeLog HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 291

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

Example Response:

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

{
  "Response": [
    {
      "Id": 0,
      "Start": "string",
      "End": "string",
      "Duration": 0,
      "Notes": "string",
      "TaskId": 0,
      "TaskName": "string",
      "TaskCustomValues": [
        {
          "CustomFieldId": 0,
          "CustomFieldName": "string",
          "Value": "string"
        }
      ],
      "UserId": 0,
      "UserName": "string"
    }
  ],
  "Error": "string"
}

Timesheet

Runs the Task Force Timesheet report with the specified parameters.

Parameters:

accountLogin - The login of the account against which the report will be run.
userLogin - The login of a user within the account with permission to run the report.
password - The password of the user as specified by the accountLogin and userLogin parameters.
startDate - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z") upon which the Timesheet will start.
breakdownBy - A string denoting how time sheet lines should be broken down. Valid values: task, user, or custom field ID.
taskNameFilter - A string that must be found in the name of any tasks to be included. If null or empty, no tasks will be filtered by name.
customFieldFilters - An array containing strings that must be found in the values of custom fields for tasks to be included. If null or empty, no tasks will be excluded because of custom field values.
userIds - An array specifying the users who must have logged time in order for it to be included. If null or empty, users will not be considered.

Example Request:

POST /API/Reporting.aspx/Timesheet HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 297

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

Example Response:

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

{
  "Response": [
    {
      "Name": "string",
      "CustomFieldValues": [
        {
          "CustomFieldId": 0,
          "CustomFieldName": "string",
          "Value": "string"
        }
      ],
      "DailyHours": [
        0.0
      ]
    }
  ],
  "Error": "string"
}

UserSyncs

Runs the Task Force Breakdown report with the specified parameters.

Parameters:

accountLogin - The login of the account against which the report will be run.
userLogin - The login of a user within the account with permission to run the report.
password - The password of the user as specified by the accountLogin and userLogin parameters.
dateFrom - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateTo are not null or empty, only syncs within the range they specify will be used. Otherwise, all eligible syncs are used.
dateTo - A string containing a datetime in Coordinated Univeral Time (e.g. "2010-07-31T12:45:29Z"). If both this and dateFrom are not null or empty, only syncs within the range they specify will be used. Otherwise, all eligible syncs are used.
userIds - An array specifying the users to be included. If null or empty, users will not be considered.

Example Request:

POST /API/Reporting.aspx/UserSyncs HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 160

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "userIds": [
    0
  ]
}

Example Response:

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

{
  "Response": [
    {
      "Activity": "string",
      "Instant": "string",
      "User": "string",
      "UserId": 0
    }
  ],
  "Error": "string"
}

What were you doing when the error occurred?

Reporting

Breakdown

Grid

TimeLog

Timesheet

UserSyncs