Create activity note

Overview

Use this API to create a note for an activity. The logged in user can only create one note at a time.

Permissions

Actor Permission
User All of the following are required:
  • User must have 'Add' action on the 'Notes' resource.
  • The activity must belong to either the user's home department, or to the department in which the user is a foreign user.
Client Application No additional permission is required.

Allowed characters in note content

  • List of allowed characters:
    • Lowercase a to z
    • Uppercase A to Z
    • Digit 0-9
    • 'At' symbol (@)
    • Space
    • Colon (:)
    • Dot (.)
    • Underscore (_)
    • Hyphen (-)
    • Ampersand (&)
    • Single quote (')
    • All characters above ASCII codeset 128
SecurityoAuthUser or oAuthClient
Request
path Parameters
ids
required
string <= 1500 characters

Pass one id or comma separated list of id(s).

Examples:
Providing single ID.
1001
Providing multiple IDs.
1001,1002
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Content-Type
required
string
Default: application/json

Media type sent by the client.

Enum: "application/json" "application/xml" "application/x-www-form-urlencoded" "multipart/form-data" "text/plain"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Request Body schema: application/json

The request body is mandatory. Request body can be in either XML or JSON format.

Elements required in request body

Name Description
content Content of the note. Refer 'Allowed characters in note content' section for more information.
created
string <date-time> (created)

Date and Time details.

object (createdBy)

User details.

content
string (content) [ 1 .. 1500 ] characters ^([^\x00-\x7F]|[a-zA-Z0-9@&\s:'\._-])*$

Content of the Note.

Array of objects (link) >= 0 items

Self-link to the current Note.

id
string (id)

ID of the Note.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

post/activity/{ids}/note
Request samples
application/json
  • POST /core/casemgr/v3/case/1001/note
  • This example demonstrates the following:
    • Creating a note for an activity.
{
  • "content": "Customer has not got cashback till now. We need to check with concerned bank."
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}