API

Collaboration APIs

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

Updates values in a note in a notebook section

HTTP method PUT
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 2762, 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:
1
<Note
Note

This field is optional.

>
2
     <Subject
Subject

The subject and title of a note

This field is optional.

>{String}</Subject>
3
     <IsPrivate
IsPrivate

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

This field is optional.

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

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

This field is optional.

>{Integer}</SortIndex>
5
     <Text
Text

The text body of a note

This field is optional.

>{String}</Text>
6
</Note>
1
{
2
     "note
Note

This field is optional.

": {
3
          "subject
Subject

The subject and title of a note

This field is optional.

": "{String}",
4
          "isPrivate
IsPrivate

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

This field is optional.

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

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

This field is optional.

": "{Integer}",
6
          "text
Text

The text body of a note

This field is optional.

": "{String}"
7
     }
8
}

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.

$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
$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.

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
1

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 101013 HTTP 404 Sub-module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}
Error 101420 HTTP 404 Setting definition not found