Collaboration APIs

GET collaboration/notebooks/{notebookId}/sections/{sectionId}/notes

Lists notes in a notebook section

HTTP method	GET
URI	https://api.rambase.net/collaboration/notebooks/{notebookId}/sections/{sectionId}/notes
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {notebookId}	Notebook identifier Integer, minimum 100000
- URI parameter {sectionId}	Unique id reference to a section in a notebook Integer, minimum 1
Maximum page size ($top)	80
Successful HTTP status code	200
API resource identifier	2760, version 2

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional	Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional	Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional	Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional	Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional	Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

LastEditedByMe() Named filter	Notes I was the last contributer to
MyNotes() Named filter	Notes I have created or lastly changed
MyPrivateNotes() Named filter	Lists my private notes
NotesICreated() Named filter	Notes I have created
CreatedAt Datetime	The date and time this note was created. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedBy String	User identifier.
IsPrivate Boolean	True if a note is private for the person who created it.
LastChangedAt String	The date this note was last changed.
LastChangedBy String	User identifier.
NoteId Integer	Note identifier.
NoteText String	The text body of a note.
SortIndex Integer	Sort index to determine the order of notes in a notebook section.
Status Integer	The status of a note. 1 = edit, 4 = main, 9 = obsolete.
Subject String	The subject and title of a note.

Read more about filters and sorting on how to use sortable parameters

CreatedAt Datetime	The date and time this note was created
CreatedBy String	User identifier
IsPrivate Boolean	True if a note is private for the person who created it
LastChangedAt String	The date this note was last changed
LastChangedBy String	User identifier
NoteId Integer	Note identifier
NoteText String	The text body of a note
SortIndex Integer	Sort index to determine the order of notes in a notebook section
Status Integer	The status of a note. 1 = edit, 4 = main, 9 = obsolete
Subject String	The subject and title of a note

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <Notes>
                                    

                                             <Note>
                                    

<NoteId

NoteId

Note identifier

>{Integer}</NoteId>

<Subject

Subject

The subject and title of a note

>{String}</Subject>

<Status

Status

The status of a note. 1 = edit, 4 = main, 9 = obsolete

>{Integer}</Status>

<IsPrivate

IsPrivate

True if a note is private for the person who created it

>{Boolean}</IsPrivate>

<SortIndex

SortIndex

Sort index to determine the order of notes in a notebook section

>{Integer}</SortIndex>

<LastChangedBy

LastChangedBy

The person a note was last changed by

<EmployeeId

EmployeeId

Employee identifier

>{Integer}</EmployeeId>

<Name

Name

Last name of employee

>{String}</Name>

<FirstName

FirstName

First name of employee

>{String}</FirstName>

<EmployeeLink

EmployeeLink

Employee reference

>{String}</EmployeeLink>

                                                  </LastChangedBy>
                                    

<LastChangedAt

LastChangedAt

The date this note was last changed

>{Datetime}</LastChangedAt>

<CreatedBy

CreatedBy

User the note was created by

<UserId

UserId

User identifier

>{Integer}</UserId>

<Name

Name

Name of the user

>{String}</Name>

<FirstName

FirstName

First name of the user

>{String}</FirstName>

<UserLink

UserLink

User reference

>{String}</UserLink>

                                                  </CreatedBy>
                                    

<CreatedAt

CreatedAt

The date and time this note was created

>{Datetime}</CreatedAt>

<Text

Text

The text body of a note

>{String}</Text>

                                             </Note>
                                    

<Paging

Paging

Detailed paging information for this list.

<PageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>

<Position

Position

Position of the first element in the list

>{Integer}</Position>

<Page

Page

Page index

>{Integer}</Page>

<FirstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>

<FirstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>

<PreviousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>

<PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>

<NextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>

<NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>

<LastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>

<LastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>

<Size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>

                                             </Paging>
                                    

                                        </Notes>
                                    

{

                                             "notes": [
                                    

{

"noteId

NoteId

Note identifier

": "{Integer}",

"subject

Subject

The subject and title of a note

": "{String}",

"status

Status

The status of a note. 1 = edit, 4 = main, 9 = obsolete

": "{Integer}",

"isPrivate

IsPrivate

True if a note is private for the person who created it

": "{Boolean}",

"sortIndex

SortIndex

Sort index to determine the order of notes in a notebook section

": "{Integer}",

"lastChangedBy

LastChangedBy

The person a note was last changed by

": {

"employeeId

EmployeeId

Employee identifier

": "{Integer}",

"name

Name

Last name of employee

": "{String}",

"firstName

FirstName

First name of employee

": "{String}",

"employeeLink

EmployeeLink

Employee reference

": "{String}"

},

"lastChangedAt

LastChangedAt

The date this note was last changed

": "{Datetime}",

"createdBy

CreatedBy

User the note was created by

": {

"userId

UserId

User identifier

": "{Integer}",

"name

Name

Name of the user

": "{String}",

"firstName

FirstName

First name of the user

": "{String}",

"userLink

UserLink

User reference

": "{String}"

},

"createdAt

CreatedAt

The date and time this note was created

": "{Datetime}",

"text

Text

The text body of a note

": "{String}"

}

],

"paging

Paging

Detailed paging information for this list.

": {

"pageSize

PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",

"position

Position

Position of the first element in the list

": "{Integer}",

"page

Page

Page index

": "{Integer}",

"firstPageKey

FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"firstPage

FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",

"previousPageKey

PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"previousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",

"nextPageKey

NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"nextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",

"lastPageKey

LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",

"lastPage

LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",

"size

Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101814 HTTP 404

Employee not found