Versions Compared

Key

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

Inputs (Array[] to update)

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

HeadingstringThe heading of the note.

TextstringThe text of the note.

EventDateDateTimeThe date associated to the note.

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

Outputs

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

Code examples

Code Block
languagec#
themeRDark
titleC# - Update Notess
linenumberstrue
collapsetrue
public static void UpdateActivityLogNote()
        {
            var binding = new BasicHttpBinding();
            binding.MaxReceivedMessageSize = Int32.MaxValue;

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

            req.identify = GetApiIdentifier();
            req.Fields=new UpdateNoteFields
            {
                Heading = true,
                CustomFields = true,
                EventDate = true
            };

            req.Entities = new[]
            {
                new bfsapi.UpdateNote()
                {
                    BrickId = new Guid("20b36672-0109-4679-ad7e-aed65494977d"),
                    Heading = "UpdatedeHeading",
                    CustomFields = new CustomField[]
                    {
                        new CustomField
                        {
                            FieldName = "TestFieldUpdate",
                            Value = "TestValueUpdate"
                        }, 
                    },
                    EventDate = DateTime.Today.AddDays(10)
                    
                }
            };

            var resp = target.UpdateNotes(req);
        }

...