Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inputs (Array[] to update)

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuidThe BrickId (unique id) of the task.YesNew method in 2.24
UserGuidThe user that the task is associated to. 

AdministratorGuidThe admin user the task is associated to.

HeadingstringThe heading of the task.

TextstringThe text of the task.

DueDateDateTimeThe due date of the task.

IsHTMLboolIf the text of the task contains html this should be set to true.

PrioritystringWhich priority the task should have. Allowed values are: "High", "Medium", "Low".

StatusstringWhich status the task should have. Allowed values are: "Created", "InProgress", "Done", "Closed".


NameTypeDescriptionAvailable from version
EntitiesArrayAll tasks in the request is returned along with each tasks BrickId and array of Errors per task

Code examples

Code Block
titleC# - Update Tasks
public static void UpdateActivityLogTask()
            var binding = new BasicHttpBinding();
            binding.MaxReceivedMessageSize = Int32.MaxValue;

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

            req.identify = GetApiIdentifier();
            req.Fields=new UpdateTaskFields
                Heading = true,
                Priority = true,
                CustomFields = true,
                DueDate = true

            req.Entities = new[]
                new bfsapi.UpdateTask()
                    BrickId = new Guid("20b36672-0109-4679-ad7e-aed65494977d"),
                    Heading = "UpdatedeHeading",
                    Priority = "Medium",
                    CustomFields = new CustomField[]
                        new CustomField
                            FieldName = "TestFieldUpdate",
                            Value = "TestValueUpdate"
                    DueDate = DateTime.Today.AddDays(10)

            var resp = target.UpdateTasks(req);