GetNotes

GetNotes

Filter inputs

Name

Type

Description

Mandatory

Available from version

Name

Type

Description

Mandatory

Available from version

BrickId

Guid[]

The BrickId (unique id) of the note

 

New method in 2.24

CreatedDate

DateTime

The date the note was created

 

 

User

Guid[]

The user associated with the note

 

 

Heading

string[]

The heading of the note

 

 

Text

string[]

The descriptive text of the note

 

 

EventDateFrom

DateTime

From-date for date associated with the note

 

 

EventDateTo

DateTime

To-date for date associated with the note

 

 

IsHTML

bool

If the text contains html

 

 

Response rows (Array) inherits from EntityBase

Name

Type

Description

Available from version

Name

Type

Description

Available from version

BrickId

Guid

The BrickId (unique id) of the note

 

CreatedDate

DateTime

The date the note was created

 

User

Guid

The user associated with the note

 

Heading

string

The heading of the note

 

Text

string

The descriptive text of the note

 

EventDate

DateTime

Date associated with the note

 

IsHTML

bool

If the text contains html

 

Code examples

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); }