Filter inputs

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


DateTimeThe date the message was created

ReceiversGuid[]The user associated with the task

Subjectsstring[]The heading of the task

Bodiesstring[]The descriptive text of the task

IsReadboolIf the message is read by the customer

IsPublicboolIf the message is public

IsPromotedboolIf the message is promoted

EventDateFromDateTimeThe from-date of message

EventDateToDateTimeThe to-date of message

IsHTMLboolIf the text contains html

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


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 message was created
ReceiverGuidThe receiver of the message
SubjectstringThe subject of the message
BodystringThe body of the message
EventDateDateTimeThe due date for message
IsReadboolIf the message is read
IsPublicboolIf the message is public
IsPromotedboolIf the message is promoted
IsHTMLboolIf the body contains html
StatusstringThe status of the message, allowed values: "Created", "InProgress", "Done", "Closed"
PrioritystringThe priority of the message, allowed values: "High", "Medium", "Low"

Code examples

C# - Get messages from a BFS instance
public static void GetActivityLogItemMessage()
            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 GetMessagesArgs()
                Status = new[] {"Done"}
            req.Fields=new GetMessagesFields()
                Status = true

            var resp = target.GetMessages(req);

Blog Posts

Terms of License
Change Policy
© 2009 - 2024 Huddlestock Technologies AB All rights reserved