Get all managers

get

/hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds all managers that match the primary key criteria specified.
      Finder Variables
      • AssignmentId; integer; Unique identifier for a person's assignment.
      • EmailAddressId; integer; Unique identifier for a person's e-mail.
      • ImageId; integer; Unique identifier for a person's image.
      • PersonId; integer; Unique identifier for a person.
      • PersonNameId; integer; Unique identifier for a person's name.
    • findByWord Finds all managers that match the specified criteria.
      Finder Variables
      • FilterAttributes; string; Attributes for the search terms.
      • GrantAccessMeetingId; integer; Unique identifier of the talent review meeting for which the user needs to grant review access to other managers.
      • ManagerId; integer; Person ID of the worker to find the managers in their hierarchy.
      • SearchTerms; string; Search term criteria to retrieve data.
      • StartsWithFlag; string; Indicates whether data that starts with the search term should be retrieved.
      • TalentReviewMeetingId; integer; Talent review meeting ID to find the managers whose reports are present in the review population of the given talent review meeting.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssignmentId; integer; Unique assignment ID of the worker.
    • AssignmentName; string; Worker's assignment name.
    • AssignmentNumber; string; Worker's assignment number.
    • AssignmentStatusType; string; Status of the worker's assignment.
    • AssignmentType; string; Assignment type of the worker.
    • DisplayName; string; Display version of the worker's name.
    • EmailAddress; string; Email address of the worker.
    • EmailAddressId; integer; Unique email address identifier of the worker.
    • EmailType; string; Type of email address entered.
    • ImageId; integer; Unique identifier of the worker image.
    • ListName; string; List version of the worker's name.
    • PersonId; integer; Unique identifier for the worker.
    • PersonNameId; integer; Unique identifier for name of the worker.
    • PersonNumber; string; Number assigned to the worker.
    • PrimaryFlag; boolean; Worker's primary assignment indicator.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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.

There's no request body for this operation.

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 : talentReviewManagersLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : talentReviewManagersLOV-item-response
Type: object
Show Source
Back to Top

Examples

The following examples show how to retrieve all the talent review managers by submitting a GET request on the REST resource using cURL.

Get All Managers

In this example, a GET operation is performed on the talentReviewManagersLOV resource to retrieve all the talent review managers.

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourcecollection+json

Example of Response Body

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

{
  "items": [
    {
      "PersonId": 383,
      "PersonNumber": "383",
      "PersonNameId": 224411,
      "DisplayName": "John Tipped",
      "ListName": "Tipped, John",
      "EmailAddressId": 111055,
      "EmailAddress": null,
      "EmailType": "W1",
      "AssignmentId": 389,
      "AssignmentNumber": "144",
      "AssignmentType": "E",
      "AssignmentName": "144",
      "AssignmentStatusType": "ACTIVE",
      "PrimaryFlag": true,
      "ImageId": null,
      "links": [
         ...]
   },
   {
      "PersonId": 5,
      "PersonNumber": "5",
      "PersonNameId": 224017,
      "DisplayName": "Kenneth Walker",
      "ListName": "Walker, Ken",
      "EmailAddressId": 110868,
      "EmailAddress": "sendmail-test-discard@example.com",
      "EmailType": "W1",
      "AssignmentId": 5,
      "AssignmentNumber": "4",
      "AssignmentType": "E",
      "AssignmentName": "4",
      "AssignmentStatusType": "ACTIVE",
      "PrimaryFlag": true,
      "ImageId": null,
      "links": [
         ...]
    },
    {
      "PersonId": 27,
      "PersonNumber": "27",
      "PersonNameId": 224063,
      "DisplayName": "Alex Johnson",
      "ListName": "Johnson, Alex",
      "EmailAddressId": 110890,
      "EmailAddress": "sendmail-test-discard@example.com",
      "EmailType": "W1",
      "AssignmentId": 27,
      "AssignmentNumber": "26",
      "AssignmentType": "E",
      "AssignmentName": "26",
      "AssignmentStatusType": "ACTIVE",
      "PrimaryFlag": true,
      "ImageId": null,
      "links": [
         ...]
    },
    {
      "PersonId": 29,
      "PersonNumber": "29",
      "PersonNameId": 224067,
      "DisplayName": "Connor Horton",
      "ListName": "Horton, Connor",
      "EmailAddressId": 110892,
      "EmailAddress": "sendmail-test-discard@example.com",
      "EmailType": "W1",
      "AssignmentId": 29,
      "AssignmentNumber": "28",
      "AssignmentType": "E",
      "AssignmentName": "28",
      "AssignmentStatusType": "ACTIVE",
      "PrimaryFlag": true,
      "ImageId": null,
      "links": [
         ...]
    },
    {
      "PersonId": 31,
      "PersonNumber": "31",
      "PersonNameId": 224071,
      "DisplayName": "Casey Brown",
      "ListName": "Brown, Casey",
      "EmailAddressId": 110894,
      "EmailAddress": "sendmail-test-discard@example.com",
      "EmailType": "W1",
      "AssignmentId": 31,
      "AssignmentNumber": "30",
      "AssignmentType": "E",
      "AssignmentName": "30",
      "AssignmentStatusType": "ACTIVE",
      "PrimaryFlag": true,
      "ImageId": null
      "links": [
         ...]
    }
]

Get All Managers Filtered by Attributes

In this example, the finder findByWord is used with the finder variables SearchTerms and FilterAttributes to retrieve the talent review managers that match the specified criteria. The following is an example of the cURL command.

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV?finder=findByWord;SearchTerms=sendmail-test,FilterAttributes=DisplayName%20ListName%20EmailAddress

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourcecollection+json

Example of Response Body

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

{
  "items" : [ {
    "PersonId" : 5,
    "PersonNumber" : "5",
    "PersonNameId" : 224017,
    "DisplayName" : "Kenneth Walker",
    "ListName" : "Walker, Ken",
    "EmailAddressId" : 110868,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 5,
    "AssignmentNumber" : "4",
    "AssignmentType" : "E",
    "AssignmentName" : "4",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : null,
    "links": [
         ...]
   },
   {
    "PersonId" : 27,
    "PersonNumber" : "27",
    "PersonNameId" : 224063,
    "DisplayName" : "Alex Johnson",
    "ListName" : "Johnson, Alex",
    "EmailAddressId" : 110890,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 27,
    "AssignmentNumber" : "26",
    "AssignmentType" : "E",
    "AssignmentName" : "26",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : null,
    "links": [
         ...]
   },
   {
    "PersonId" : 27,
    "PersonNumber" : "27",
    "PersonNameId" : 224063,
    "DisplayName" : "Alex Johnson",
    "ListName" : "Johnson, Alex",
    "EmailAddressId" : 110890,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 27,
    "AssignmentNumber" : "26",
    "AssignmentType" : "E",
    "AssignmentName" : "26",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : null,
    "links": [
         ...]
   },
   {
    "PersonId" : 29,
    "PersonNumber" : "29",
    "PersonNameId" : 224067,
    "DisplayName" : "Connor Horton",
    "ListName" : "Horton, Connor",
    "EmailAddressId" : 110892,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 29,
    "AssignmentNumber" : "28",
    "AssignmentType" : "E",
    "AssignmentName" : "28",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : null,
    "links": [
         ...]
   },
   {
    "PersonId" : 31,
    "PersonNumber" : "31",
    "PersonNameId" : 224071,
    "DisplayName" : "Casey Brown",
    "ListName" : "Brown, Casey",
    "EmailAddressId" : 110894,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 31,
    "AssignmentNumber" : "30",
    "AssignmentType" : "E",
    "AssignmentName" : "30",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : null,
    "links": [
         ...]
   }
]

Get All Managers in the Hierarchy of a Manager

In this example, the finder findByWord is used with the finder variable ManagerId to retrieve all the talent review managers in the hierarchy of the manager. The following is an example of the cURL command.

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV?finder=findByWord;ManagerId=100000008153757

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourcecollection+json

Example of Response Body

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

{
  "items" : [ {
    "PersonId" : 100000008153768,
    "PersonNumber" : "8153768",
    "PersonNameId" : 100000000000533,
    "DisplayName" : "Guga Danya",
    "ListName" : "Danya, Guga",
    "EmailAddressId" : 100000000000091,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 100000008154072,
    "AssignmentNumber" : "EEEE8153768",
    "AssignmentType" : "E",
    "AssignmentName" : "AssignmentName113",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : 100100099291870,
    "links": [
         ...]
   },
   {
    "PersonId" : 100000008153769,
    "PersonNumber" : "8153769",
    "PersonNameId" : 100000000000534,
    "DisplayName" : "Venkatasurendar Raghupathi",
    "ListName" : "Raghupathi, Venkatasurendar",
    "EmailAddressId" : 100000000000092,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 100000008154073,
    "AssignmentNumber" : "EEEE8153769",
    "AssignmentType" : "E",
    "AssignmentName" : "AssignmentName114",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : 100100099536704,
    "links": [
         ...]
   },
   {
    "PersonId" : 100000008153761,
    "PersonNumber" : "8153761",
    "PersonNameId" : 100000000000526,
    "DisplayName" : "Rakesh Singh",
    "ListName" : "Singh, Rakesh",
    "EmailAddressId" : 100000000000084,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 100000008154065,
    "AssignmentNumber" : "EEEE8153761",
    "AssignmentType" : "E",
    "AssignmentName" : "AssignmentName106",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : 100100099536690,
    "links": [
         ...]
   },
   {
    "PersonId" : 100000008153762,
    "PersonNumber" : "8153762",
    "PersonNameId" : 100000000000527,
    "DisplayName" : "Namita Tadoori",
    "ListName" : "Tadoori, Namita",
    "EmailAddressId" : 100000000000085,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 100000008154066,
    "AssignmentNumber" : "EEEE8153762",
    "AssignmentType" : "E",
    "AssignmentName" : "AssignmentName107",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : 100100099536726,
    "links": [
         ...]
   },
   {
    "PersonId" : 300100006383293,
    "PersonNumber" : "300100006383293",
    "PersonNameId" : 300100006383294,
    "DisplayName" : "Tom EMP12-BISEC",
    "ListName" : "EMP12-BISEC, Tom",
    "EmailAddressId" : 300100006383303,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 300100006383311,
    "AssignmentNumber" : "E300100006383293",
    "AssignmentType" : "E",
    "AssignmentName" : "E300100006383293",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : null,
    "links": [
         ...]
   },
   {
    "PersonId" : 300100006422513,
    "PersonNumber" : "300100006422513",
    "PersonNameId" : 300100006422514,
    "DisplayName" : "Mary EMP13-BISEC",
    "ListName" : "EMP13-BISEC, Mary",
    "EmailAddressId" : 300100006422523,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 300100006422531,
    "AssignmentNumber" : "E300100006422513",
    "AssignmentType" : "E",
    "AssignmentName" : "E300100006422513",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : null,
    "links": [
         ...]
   }
]

Get All Managers Whose Reports Attended the Talent Review Meeting

In this example, the finder findByWord is used with the finder variables ManagerId and TalentReviewMeetingId to retrieve all the talent review managers in the hierarchy of the manager, whose reports attended the Talent Review meeting. The following is an example of the cURL command..

curl -i -u "<username>:<password>" -X GET https://<host>:<port>/hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV?finder=findByWord;ManagerId=100000008153757,TalentReviewMeetingId=300100026971930

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourcecollection+json

Example of Response Body

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

  "items" : [ {
    "PersonId" : 100000008153761,
    "PersonNumber" : "8153761",
    "PersonNameId" : 100000000000526,
    "DisplayName" : "Rakesh Singh",
    "ListName" : "Singh, Rakesh",
    "EmailAddressId" : 100000000000084,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 100000008154065,
    "AssignmentNumber" : "EEEE8153761",
    "AssignmentType" : "E",
    "AssignmentName" : "AssignmentName106",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : 100100099536690,
    "links": [
         ...]
   },
   {
    "PersonId" : 100000008153762,
    "PersonNumber" : "8153762",
    "PersonNameId" : 100000000000527,
    "DisplayName" : "Namita Tadoori",
    "ListName" : "Tadoori, Namita",
    "EmailAddressId" : 100000000000085,
    "EmailAddress" : "sendmail-test-discard@example.com",
    "EmailType" : "W1",
    "AssignmentId" : 100000008154066,
    "AssignmentNumber" : "EEEE8153762",
    "AssignmentType" : "E",
    "AssignmentName" : "AssignmentName107",
    "AssignmentStatusType" : "ACTIVE",
    "PrimaryFlag" : true,
    "ImageId" : 100100099536726,
   "links": [
         ...]
   }
]
Back to Top