Collaboration APIs
Create a new note under a notebook section
| HTTP method | POST |
| 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 |
| Successful HTTP status code | 200 |
| API resource identifier | 2763, 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.
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. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
Subject
The subject and title of a note
>{String}</Subject>IsPrivate
True if a note is private for the person who created it
>{Boolean}</IsPrivate>SortIndex
Sort index to determine the order of notes in a notebook section
>{Integer}</SortIndex>Text
The text body of a note
>{String}</Text>Subject
The subject and title of a note
": "{String}",IsPrivate
True if a note is private for the person who created it
": "{Boolean}",SortIndex
Sort index to determine the order of notes in a notebook section
": "{Integer}",Text
The text body of a note
": "{String}"
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 |