API

Collaboration APIs

POST collaboration/notes

Creates a new note

HTTP method POST
URI https://api.rambase.net/collaboration/notes
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2600, version 9

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>
2
     <Subject
Subject

Required/mandatory field

The subject and title of a note

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

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

Default value: False

This field is optional.

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

The text body of a note

This field is optional.

>{String}</Text>
5
</Note>
1
{
2
     "note": {
3
          "subject
Subject

Required/mandatory field

The subject and title of a note

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

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

Default value: False

This field is optional.

": "{Boolean}",
5
          "text
Text

The text body of a note

This field is optional.

": "{String}"
6
     }
7
}

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

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.

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

Possible domain values can be found here

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

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

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

The person a note was last changed by

>
7
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

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

The date this note was last changed

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

User the note was created by

>
14
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

The date and time this note was created

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

The text body of a note

>{String}</Text>
21
</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

Possible domain values can be found here

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

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

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

The person a note was last changed by

": {
8
               "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

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

Employee reference

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

The date this note was last changed

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

User the note was created by

": {
15
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

The date and time this note was created

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

The text body of a note

": "{String}"
22
     }
23
}

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: