Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Current »

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuid[]The BrickId (unique id) of the task
New method in 2.24

CreatedDate

DateTimeThe date the task was created

UsersGuid[]The user associated with the task

AdministratorsGuid[]The admin user associated with the task

Headingsstring[]The heading of the task

Textsstring[]The descriptive text of the task

DueDateFromDateTimeThe from-date for task

DueDateToDateTimeThe to-date for task

IsHTMLboolIf the text contains html

Statusstring[]The status of the task, allowed values: "Created", "InProgress", "Done", "Closed"

Priorities

string[]The priority of the task, allowed values: "High", "Medium", "Low"

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidThe BrickId (unique id) of the task
CreatedDateDateTimeThe date the task was created
UserGuidThe user associated with the task
AdministratorGuidThe admin user associated with the task
HeadingstringThe heading of the task
TextstringThe descriptive text of the task
DueDateDateTimeThe due date for task
IsHTMLboolIf the text contains html
StatusstringThe status of the task, allowed values: "Created", "InProgress", "Done", "Closed"
PrioritystringThe priority of the task, allowed values: "High", "Medium", "Low"

Code examples

C# - Get tasks from a BFS instance
public static void GetActivityLogItemTask()
        {
            var binding = new BasicHttpBinding();
            binding.MaxReceivedMessageSize = Int32.MaxValue;

            var target = new bfsapi.bfsapiSoapClient(binding, new EndpointAddress("http://localhost:20010/bfsapi.asmx"));
            var req = new GetTasksRequest();
            req.Credentials = new bfsapi.Credentials
            {
                UserName = GetApiUserName(),
                Password = GetApiPassword()
            };

            req.identify = GetApiIdentifier();

            req.Args=new GetTasksArgs()
            {
                Status = new[] {"Done"}
            };
            req.Fields=new GetTasksFields()
            {
                Status = true
            };

            var resp = target.GetTasks(req);
        }


Blog Posts

  • No labels