Create a person note
post
/hcmRestApi/resources/11.13.18.05/personNotes
Request
Header Parameters
-
Effective-Of:
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. -
Metadata-Context:
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".
-
REST-Framework-Version:
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.
-
Upsert-Mode:
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
- application/json
Root Schema : schema
Type:
Show Source
object
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
AuthorId: integer
(int64)
Title:
Author Person ID
Person identifier of the author of the note. -
AuthorNumber: string
Title:
Author Person Number
Maximum Length:30
Unique person identifier of the author of the note. -
CardTitle: string
Maximum Length:
500
Card title of a celebration note. -
ContextId: integer
(int64)
Context identifier of the note.
-
ContextId2: integer
(int64)
Additional context identifier of the note.
-
ContextType: string
Title:
Context Type
Context type of the note. Supply value is ORA_NO_CONTEXT. -
ContextType2: string
Maximum Length:
30
Additional context type of the note. -
DeleteNonAuthorFlag: boolean
Indicates whether a user who isn't the author of the note has the Delete privilege. The default value is false.
-
ForeignKeyReferenceFlag: boolean
Indicates whether another application has created a reference to a note. The default value is false.
-
HiddenFlag: boolean
Title:
Hide
Maximum Length:1
Default Value:false
Indicates whether the note is hidden or shown. The default value is Show. -
HideShowFlag: boolean
Indicates whether a user has the Hide or Show privilege. The default value is false.
-
HideShowNonRecipientFlag: boolean
Indicates whether a user who isn't the recipient or the author of the note has the Hide or Show privilege. The default value is false.
-
ImageReferenceURL: string
Maximum Length:
4000
Image reference URL of a celebration note. -
NoteId: integer
(int64)
Title:
Note ID
System-generated primary key of the note. -
NoteText: string
(byte)
Title:
Note Text
Text of the note. -
NoteVisibilityCode: string
Title:
Note Visibility Code
Maximum Length:30
Visibility of the note. Valid options are: ALL, MANAGERS, MANAGERS_AND_SUBJECT, PRIVATE, SUBJECT, MANAGERS_SUBJECT_PEERS. Administrators can remove any of the options via configuration for the specified context type. -
NoteVisibilityMeaning: string
Maximum Length:
255
Meaning of the visibility code. -
ThankYouFlag: boolean
Indicates whether the user can send a thank you note. The default value is false.
-
WorkerId(required): integer
(int64)
Title:
Worker Person ID
Person identifier of the worker who's the subject of the note. -
WorkerNumber: string
Title:
Worker Person Number
Maximum Length:30
Unique person identifier of the worker who's the subject of the note.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : personNotes-item-response
Type:
Show Source
object
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
AuthorId: integer
(int64)
Title:
Author Person ID
Person identifier of the author of the note. -
AuthorKnownAs: string
Title:
Author Preferred Name
Read Only:true
Maximum Length:80
Preferred name of the author of the note. -
AuthorName: string
Title:
Author Name
Read Only:true
Maximum Length:240
Name of the note author. -
AuthorNumber: string
Title:
Author Person Number
Maximum Length:30
Unique person identifier of the author of the note. -
CardTitle: string
Maximum Length:
500
Card title of a celebration note. -
ContextId: integer
(int64)
Context identifier of the note.
-
ContextId2: integer
(int64)
Additional context identifier of the note.
-
ContextType: string
Title:
Context Type
Context type of the note. Supply value is ORA_NO_CONTEXT. -
ContextType2: string
Maximum Length:
30
Additional context type of the note. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the note. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the note was created. -
DeleteNonAuthorFlag: boolean
Indicates whether a user who isn't the author of the note has the Delete privilege. The default value is false.
-
ForeignKeyReferenceFlag: boolean
Indicates whether another application has created a reference to a note. The default value is false.
-
HiddenFlag: boolean
Title:
Hide
Maximum Length:1
Default Value:false
Indicates whether the note is hidden or shown. The default value is Show. -
HideShowFlag: boolean
Indicates whether a user has the Hide or Show privilege. The default value is false.
-
HideShowNonRecipientFlag: boolean
Indicates whether a user who isn't the recipient or the author of the note has the Hide or Show privilege. The default value is false.
-
ImageReferenceURL: string
Maximum Length:
4000
Image reference URL of a celebration note. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the note was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the note. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
System-generated primary key of the note. -
NoteText: string
(byte)
Title:
Note Text
Text of the note. -
NoteVisibilityCode: string
Title:
Note Visibility Code
Maximum Length:30
Visibility of the note. Valid options are: ALL, MANAGERS, MANAGERS_AND_SUBJECT, PRIVATE, SUBJECT, MANAGERS_SUBJECT_PEERS. Administrators can remove any of the options via configuration for the specified context type. -
NoteVisibilityMeaning: string
Maximum Length:
255
Meaning of the visibility code. -
ThankYouFlag: boolean
Indicates whether the user can send a thank you note. The default value is false.
-
WorkerId: integer
(int64)
Title:
Worker Person ID
Person identifier of the worker who's the subject of the note. -
WorkerKnownAs: string
Title:
Worker Preferred Name
Read Only:true
Maximum Length:80
Preferred name of the worker who's the subject of the note. -
WorkerName: string
Title:
Worker Name
Read Only:true
Maximum Length:240
Name of the worker who's the subject of the note. -
WorkerNumber: string
Title:
Worker Person Number
Maximum Length:30
Unique person identifier of the worker who's the subject of the note.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : personNotes-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- attachments
-
Parameters:
- personNotesUniqID:
$request.path.personNotesUniqID
The attachments resource is used to view, create, and update attachments. - personNotesUniqID:
- decrementReferenceCount
-
Operation: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/decrementReferenceCountParameters:
- personNotesUniqID:
$request.path.personNotesUniqID
Allows users to decrement the reference count when another application no longer references a note. - personNotesUniqID:
- getContextName
-
Parameters:
- personNotesUniqID:
$request.path.personNotesUniqID
Returns the context name for a note based on context type. - personNotesUniqID:
- incrementReferenceCount
-
Operation: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/incrementReferenceCountParameters:
- personNotesUniqID:
$request.path.personNotesUniqID
Allows users to increment the reference count when another application creates a reference to a note. - personNotesUniqID:
- sendThankYou
-
Parameters:
- personNotesUniqID:
$request.path.personNotesUniqID
Allows users to send a thank you note to the author of a note. - personNotesUniqID:
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