API

Collaboration APIs

POST collaboration/notes/{noteId}/mentions

Adds a mentioned person to the mention list

HTTP method POST
URI https://api.rambase.net/collaboration/notes/{noteId}/mentions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {noteId} Note identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2644, version 5

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
<Mention
Mention

This field is optional.

>
2
     <EmployeeId
EmployeeId

The userid of an employee mentioned in the note text body

This field is optional.

>{Integer}</EmployeeId>
3
</Mention>
1
{
2
     "mention
Mention

This field is optional.

": {
3
          "employeeId
EmployeeId

The userid of an employee mentioned in the note text body

This field is optional.

": "{Integer}"
4
     }
5
}

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.

Format:
1
<Mention>
2
     <MentionId
MentionId

Note mention identifier

>{Integer}</MentionId>
3
     <NotifiedAt
NotifiedAt

The notification time of a person mentioned in the text body

>{Datetime}</NotifiedAt>
4
     <Employee
Employee

A person mentioned in the text body of a note

>
5
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
6
          <LastName
LastName

Last name of employee

>{String}</LastName>
7
          <FirstName
FirstName

First name of employee

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

Employee reference

>{String}</EmployeeLink>
9
     </Employee>
10
</Mention>
1
{
2
     "mention": {
3
          "mentionId
MentionId

Note mention identifier

": "{Integer}",
4
          "notifiedAt
NotifiedAt

The notification time of a person mentioned in the text body

": "{Datetime}",
5
          "employee
Employee

A person mentioned in the text body of a note

": {
6
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
7
               "lastName
LastName

Last name of employee

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

First name of employee

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

Employee reference

": "{String}"
10
          }
11
     }
12
}

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