Custom Fields

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

Methods:

• CreateCustomField - Creates a Task Force custom field with the specified parameters.
• DeleteCustomField - Deletes a Task Force custom field with the specified ID.
• ListCustomFields - Returns a list of Task Force custom fields.
• UpdateCustomField - Updates a Task Force custom field 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.

CreateCustomField

Creates a Task Force custom field 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 custom field.
• notes - The notes for the custom field.
• matchPattern - The match pattern for the custom field.
• formatPattern - The format pattern from the custom field.
• removeMatchFromName - True if matches are to be removed from the task name during Advanced Data Entry processing; otherwise, false.

Example Request:

POST /API/CustomFields.aspx/CreateCustomField HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 218

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "name": "string",
  "notes": "string",
  "matchPattern": "string",
  "formatPattern": "string",
  "removeMatchFromName": false
}

Example Response:

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

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

DeleteCustomField

Deletes a Task Force custom field 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 custom field to be deleted.

Example Request:

POST /API/CustomFields.aspx/DeleteCustomField 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"
}

ListCustomFields

Returns a list of Task Force custom fields.

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.

Example Request:

POST /API/CustomFields.aspx/ListCustomFields HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 83

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

Example Response:

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

{
  "Response": [
    {
      "Id": 0,
      "Name": "string",
      "Notes": "string",
      "MatchPattern": "string",
      "FormatPattern": "string",
      "RemoveMatchFromName": false
    }
  ],
  "Error": "string"
}

UpdateCustomField

Updates a Task Force custom field 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 custom field to be updated.
• name - The name of the custom field.
• notes - The notes for the custom field.
• matchPattern - The match pattern for the custom field.
• formatPattern - The format pattern from the custom field.
• removeMatchFromName - True if matches are to be removed from the task name during Advanced Data Entry processing; otherwise, false.

Example Request:

POST /API/CustomFields.aspx/UpdateCustomField HTTP/1.1
Host: taskforce.epiforge.com
Content-Type: application/scaffold+json
Content-Length: 230

{
  "accountLogin": "string",
  "userLogin": "string",
  "password": "string",
  "id": 0,
  "name": "string",
  "notes": "string",
  "matchPattern": "string",
  "formatPattern": "string",
  "removeMatchFromName": false
}

Example Response:

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

{
  "Error": "string"
}