GetNotes

Filter inputs

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

CreatedDate

DateTimeThe date the note was created

UserGuid[]The user associated with the note

Headingstring[]The heading of the note

Textstring[]The descriptive text of the note

EventDateFromDateTimeFrom-date for date associated with the note

EventDateToDateTimeTo-date for date associated with the note

IsHTMLboolIf the text contains html

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidThe BrickId (unique id) of the note
CreatedDateDateTimeThe date the note was created
UserGuidThe user associated with the note
HeadingstringThe heading of the note
TextstringThe descriptive text of the note
EventDateDateTimeDate associated with the note
IsHTMLboolIf the text contains html

Code examples

C# - Get notes from a BFS instance
public static void GetActivityLogItemNote()
        {
            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 GetNotesArgs()
            {
                Status = new[] {"Done"}
            };
            req.Fields=new GetNotesFields()
            {
                Status = true
            };

            var resp = target.GetNotes(req);
        }


Blog Posts

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