1. Oracle Global Human Resources Cloud REST APIREST API for Oracle Fusion Cloud HCM
  2. Use Cases
  3. Talent Management
  4. Manage Anytime Feedback Notes

Manage Anytime Feedback Notes

Overview

You can create notes about any topic either for providing feedback or kudos. Use the personNotes resource to create and view notes about a person. As a manager, Marc wants to give feedback for one of his direct reports and the feedback should be visible to all. Marc uses the personNotes service to create the feedback with context that is ORA_NO_CONTEXT, in Oracle HCM Cloud. When providing the feedback, Marc needs to choose the visibility option ALL, to make the feedback visible to all. Use the personNotesVisibilityOptions service to configure the visibility options for the given context and verify that the VisibleToAllFlag is set to true for the ORA_NO_CONTEXT context.

This use case discusses these scenarios:
  • Create Anytime Feedback Note for a team member
  • Query and view Anytime Feedback Notes for a team member
  • Query and view Anytime Feedback Visibility Options for the organization

Create Anytime Feedback Note

Let's say Marc wants to create an Anytime Feedback Note for his team member.

To create an Anytime Feedback Note:
  1. Use the POST method on the personNotes service to create an Anytime Feedback Note for a person where the context type is ORA_NO_CONTEXT.
  2. Use the PUT method on the personNotes service to provide the required text for the note.

Example of URL

  • POST method:
    /hcmRestApi/resources/11.13.18.05/personNotes
  • PUT method:
    /hcmRestApi/resources/11.13.18.05/personNotes/{enclosure/NoteText link from the POST response}

Example of Request

Sample payload for POST method:

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

Sample payload for PUT method:

Example of Response

	
{
    "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": [
        {
            "rel": "self",
            "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F0849267210000000EACED0005770800000000000000CA",
            "name": "personNotes",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F0849267210000000EACED0005770800000000000000CA",
            "name": "personNotes",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F0849267210000000EACED0005770800000000000000CA/lov/AuthorLovPVO",
            "name": "AuthorLovPVO",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F0849267210000000EACED0005770800000000000000CA/lov/WorkerLovPVO",
            "name": "WorkerLovPVO",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F0849267210000000EACED0005770800000000000000CA/enclosure/NoteText",
            "name": "NoteText",
            "kind": "other"
        }
    ]
}

Note:

There is no response for the PUT method to create the note text other than HTTP/1.1 204 No Content / Created Content-Type : text/plain

Query Anytime Feedback Notes

Let's say Marc wants to view Anytime Feedback Notes for his team member, Ravi whose Worker ID is 100000008153757.

To query an Anytime Feedback note :
  1. Use the GET method on the personNotes service to view all of the Anytime Feedback Notes for Ravi.
  2. Use the GET method on the personNotes service to view the text associated with each Anytime Feedback Note for Ravi.

Example of URL

GET method to retrieve Ravi's complete notes: 
/hcmRestApi/resources/11.13.18.05/personNotes?q=WorkerId=100000008153757
GET method to retrieve the note text for each of Ravi's notes: 
/hcmRestApi/resources/11.13.18.05/personNotes/{enclosure/NoteText link from the GET response}

Example of Response

Example of GET response for Ravi's notes: 


{
    "items": [
        {
            "NoteId": 300100179109622,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "MANAGERS_AND_SUBJECT",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-04-24T00:35:57.783+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-04-24T00:34:50.342+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F60000000EACED0005770800000000000000CA",
                    "name": "personNotes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F60000000EACED0005770800000000000000CA",
                    "name": "personNotes",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F60000000EACED0005770800000000000000CA/lov/AuthorLovPVO",
                    "name": "AuthorLovPVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F60000000EACED0005770800000000000000CA/lov/WorkerLovPVO",
                    "name": "WorkerLovPVO",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F60000000EACED0005770800000000000000CA/enclosure/NoteText",
                    "name": "NoteText",
                    "kind": "other"
                }
            ]
        },
        {
            "NoteId": 300100179109616,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "ALL",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-04-24T00:34:47.045+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-04-24T00:33:10+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F00000000EACED0005770800000000000000CA",
                    "name": "personNotes",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F00000000EACED0005770800000000000000CA",
                    "name": "personNotes",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F00000000EACED0005770800000000000000CA/lov/AuthorLovPVO",
                    "name": "AuthorLovPVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F00000000EACED0005770800000000000000CA/lov/WorkerLovPVO",
                    "name": "WorkerLovPVO",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes/00020000000EACED00057708000110F08492A6F00000000EACED0005770800000000000000CA/enclosure/NoteText",
                    "name": "NoteText",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotes",
            "name": "personNotes",
            "kind": "collection"
        }
    ]
}

Sample GET response for the note text on a Ravi note: Team, please congratulate Ravi on his promotion to Product Manager. Well deserved!

Query Person Notes Visibility Options

Let's say Marc wants to view the available visibility options configured for Anytime Feedback Notes with the context type of ORA_NO_CONTEXT so that he knows which options are valid for creating an Anytime Feedback Note for a team member.

To query the visibility options configured for Anytime Feedback Notes with a context type of ORA_NO_CONTEXT, use the GET method on the personNotesVisibilityOptions service to view the visibility option settings for ORA_NO_CONTEXT.

Example of URL

/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions?q=ContextType='ORA_NO_CONTEXT'

Example of Response

{
    "items": [
        {
            "ContextType": "ORA_NO_CONTEXT",
            "VisibleToAllFlag": true,
            "VisibleToManagersOnlyFlag": true,
            "VisibleToManagersAndWorkerFlag": true,
            "VisibleToAuthorOnlyFlag": true,
            "CreatedBy": "-1",
            "CreationDate": "2018-02-13T22:25:44+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-04-16T14:39:11.433+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions/00020000000EACED0005770800000000000000CA0000000EACED0005770800005B0A5D14A189",
                    "name": "personNotesVisibilityOptions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions/00020000000EACED0005770800000000000000CA0000000EACED0005770800005B0A5D14A189",
                    "name": "personNotesVisibilityOptions",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions/00020000000EACED0005770800000000000000CA0000000EACED0005770800005B0A5D14A189/lov/contextTypesLOV",
                    "name": "contextTypesLOV",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://fuscdrmsmc248-fa-ext.us.example.com:443/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions",
            "name": "personNotesVisibilityOptions",
            "kind": "collection"
        }
    ]
}