API

Collaboration APIs

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

Gets information about a note in a notebook section

HTTP method GET
URI https://api.rambase.net/collaboration/notebooks/{notebookId}/sections/{sectionId}/notes/{noteId}
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
- URI parameter {noteId} Note identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2761, version 1

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.

$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.

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

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

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
<Note>
2
     <NoteId
NoteId

Note identifier

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

The subject and title of a note

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

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

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

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

>{Boolean}</IsPrivate>
6
     <SortIndex
SortIndex

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

>{Integer}</SortIndex>
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>
1
{
2
     "note": {
3
          "noteId
NoteId

Note identifier

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

The subject and title of a note

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

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

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

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

": "{Boolean}",
7
          "sortIndex
SortIndex

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

": "{Integer}",
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
}

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