1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Person Notes

Create a person note

post

/hcmRestApi/resources/11.13.18.05/personNotes

Request

Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : personNotes-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : personNotes-attachments-item-response
Type: object
Show Source
Links
attachments
Parameters:
  • personNotesUniqID: $request.path.personNotesUniqID
The attachments resource is used to view, create, and update attachments.
decrementReferenceCount
Parameters:
  • personNotesUniqID: $request.path.personNotesUniqID
Allows users to decrement the reference count when another application no longer references a note.
getContextName
Parameters:
  • personNotesUniqID: $request.path.personNotesUniqID
Returns the context name for a note based on context type.
incrementReferenceCount
Parameters:
  • personNotesUniqID: $request.path.personNotesUniqID
Allows users to increment the reference count when another application creates a reference to a note.
sendThankYou
Parameters:
  • personNotesUniqID: $request.path.personNotesUniqID
Allows users to send a thank you note to the author of a note.
Back to Top

Examples

The following example shows how to create a person note and add the notetext by submitting a POST request followed by a PUT request on the REST resource using cURL.

Note:

The POST operation creates a new row in the database. To create text for the note, you must copy the enclosure href url from the POST response, add the desired text, and then use the PUT operation.

Create a Note

curl -i -u "<user>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> "http://host:port/hcmCoreApi/resources/11.13.18.05/personNotes"

Example of Payload

The following is an example of the payload.

{
  "AuthorId" : 100000008153756,
  "WorkerId" : 100000008153757,
  "NoteVisibilityCode" : "ALL",
  "ContextType" : "ORA_NO_CONTEXT"
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 201  Created
 Created Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "NoteId": 300100179093281,
    "AuthorId": 100000008153756,
    "AuthorNumber": "8153756",
    "WorkerId": 100000008153757,
    "WorkerNumber": "8153757",
    "ContextType": "ORA_NO_CONTEXT",
    "NoteVisibilityCode": "ALL",
    "CreatedBy": "TM-MFITZIMMONS",
    "LastUpdateDate": "2019-04-24T01:13:14.252+00:00",
    "LastUpdatedBy": "TM-MFITZIMMONS",
    "CreationDate": "2019-04-24T01:13:14+00:00",
    "links": [..]
}

Create a Notetext

curl -i -u "<username>:<password>" -H Content-Type: text/plain" -X PUT -d <payload> "http://host:port/hcmCoreApi/resources/11.13.18.05/personNotes//00020000000EACED00057708000110F084C6BAE70000000EACED0005770800000000000000CA/enclosure/NoteText"

Example of Payload

The following is an example of the payload.

Ravi has done an excellent job leading the latest project.

Example of Response Header

The following is an example of the response header.

HTTP/1.1 204  No Content
Created Content-Type : text/plain
Back to Top