API

Collaboration APIs

GET collaboration/notes

List of notes

HTTP method GET
URI https://api.rambase.net/collaboration/notes
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 585, version 18

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:
1
1

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.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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
ContainingTagName String All tasks containing this TAG.
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.
Subject String The subject and title of a note.

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

ContainingTagName String All tasks containing this TAG
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
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:
1
<Notes>
2
     <Note>
3
          <NoteId
NoteId

Note identifier

>{Integer}</NoteId>
4
          <Subject
Subject

The subject and title of a note

>{String}</Subject>
5
          <Status
Status

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

Possible domain values can be found here

>{Integer}</Status>
6
          <IsPrivate
IsPrivate

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

>{Boolean}</IsPrivate>
7
          <LastChangedBy
LastChangedBy

The person a note was last changed by

>
8
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
9
               <Name
Name

Last name of employee

>{String}</Name>
10
               <FirstName
FirstName

First name of employee

>{String}</FirstName>
11
               <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
12
          </LastChangedBy>
13
          <LastChangedAt
LastChangedAt

The date this note was last changed

>{Datetime}</LastChangedAt>
14
          <CreatedBy
CreatedBy

User the note was created by

>
15
               <UserId
UserId

User identifier

>{Integer}</UserId>
16
               <Name
Name

Name of the user

>{String}</Name>
17
               <FirstName
FirstName

First name of the user

>{String}</FirstName>
18
               <UserLink
UserLink

User reference

>{String}</UserLink>
19
          </CreatedBy>
20
          <CreatedAt
CreatedAt

The date and time this note was created

>{Datetime}</CreatedAt>
21
          <Text
Text

The text body of a note

>{String}</Text>
22
     </Note>
23
     <Paging
Paging

Detailed paging information for this list.

>
24
          <PageSize
PageSize

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

>{Integer}</PageSize>
25
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
26
          <Page
Page

Page index

>{Integer}</Page>
27
          <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>
28
          <FirstPage
FirstPage

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

>{String}</FirstPage>
29
          <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>
30
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
31
          <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>
32
          <NextPage
NextPage

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

>{String}</NextPage>
33
          <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>
34
          <LastPage
LastPage

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

>{String}</LastPage>
35
          <Size
Size

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

>{Integer}</Size>
36
     </Paging>
37
</Notes>
1
{
2
     "notes": [
3
          {
4
               "noteId
NoteId

Note identifier

": "{Integer}",
5
               "subject
Subject

The subject and title of a note

": "{String}",
6
               "status
Status

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

Possible domain values can be found here

": "{Integer}",
7
               "isPrivate
IsPrivate

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

": "{Boolean}",
8
               "lastChangedBy
LastChangedBy

The person a note was last changed by

": {
9
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
10
                    "name
Name

Last name of employee

": "{String}",
11
                    "firstName
FirstName

First name of employee

": "{String}",
12
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
13
               },
14
               "lastChangedAt
LastChangedAt

The date this note was last changed

": "{Datetime}",
15
               "createdBy
CreatedBy

User the note was created by

": {
16
                    "userId
UserId

User identifier

": "{Integer}",
17
                    "name
Name

Name of the user

": "{String}",
18
                    "firstName
FirstName

First name of the user

": "{String}",
19
                    "userLink
UserLink

User reference

": "{String}"
20
               },
21
               "createdAt
CreatedAt

The date and time this note was created

": "{Datetime}",
22
               "text
Text

The text body of a note

": "{String}"
23
          }
24
     ],
25
     "paging
Paging

Detailed paging information for this list.

": {
26
          "pageSize
PageSize

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

": "{Integer}",
27
          "position
Position

Position of the first element in the list

": "{Integer}",
28
          "page
Page

Page index

": "{Integer}",
29
          "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}",
30
          "firstPage
FirstPage

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

": "{String}",
31
          "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}",
32
          "previousPage
PreviousPage

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

": "{String}",
33
          "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}",
34
          "nextPage
NextPage

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

": "{String}",
35
          "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}",
36
          "lastPage
LastPage

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

": "{String}",
37
          "size
Size

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

": "{Integer}"
38
     }
39
}

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