Get a performance document
get
/hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}
Request
Path Parameters
-
performanceEvaluationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Performance Evaluations resource and used to uniquely identify an instance of Performance Evaluations. The client should not generate the hash key value. Instead, the client should query on the Performance Evaluations collection resource in order to navigate to a specific instance of Performance Evaluations to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : performanceEvaluations-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Unique assignment identifier of the worker.
-
EndDate: string
(date)
Title:
End Date
End date of the performance document. -
EvalStatus: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the performance document. -
EvaluationId: integer
(int64)
System generated primary key of the performance document.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerAssignmentId: integer
(int64)
Unique assignment identifier of the manager in a performance document.
-
ManagerId: integer
(int64)
Title:
Manager Name
System-generated primary key of the manager in a performance document. -
Name: string
Maximum Length:
30
Name of a performance evaluation. -
PerformanceDocumentName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of a performance document. -
PersonId: integer
(int64)
Title:
Worker Name
System-generated primary key of the worker in a performance document. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Unique person identifier of the worker in a performance document. -
ReviewPeriodId: integer
(int64)
Unique identifier of the review period associated with a performance document.
-
Roles: array
Performance Roles
Title:
Performance Roles
The Roles resource is a child of the performanceEvaluations resource. It retrieves information about the evaluation roles in a performance document. -
StartDate: string
(date)
Title:
Start Date
Start date of the performance document. -
StatusCode: string
Title:
Status
Maximum Length:30
Code that represents the status of a performance document. -
TemplateDefnId: integer
(int64)
Unique identifier of the performance template associated with a performance document.
-
TemplateTypeCode: string
Maximum Length:
30
Code that represents the type of template of a performance document. -
TmplPeriodId: integer
(int64)
Title:
Performance Document Name
Unique identifier of the template period of a performance document.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Performance Roles
Type:
array
Title:
Performance Roles
The Roles resource is a child of the performanceEvaluations resource. It retrieves information about the evaluation roles in a performance document.
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.
Nested Schema : performanceEvaluations-Roles-item-response
Type:
Show Source
object
-
EvalRoleId: integer
(int64)
System-generated primary key of the performance role in a performance document.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixParticipantFlag: boolean
Maximum Length:
30
Indicates whether a performance document participant is a matrix participant. Valid values are true or false. The default is false. -
MinimumNumberPcpns: integer
(int64)
Minimum number of participants required in a performance document.
-
Participants: array
Performance Document Participants
Title:
Performance Document Participants
The Participants resource is a child of the roles resource. It retrieves information about participants in a performance document. -
RoleTypeCode: string
Maximum Length:
30
Code that represents the type of a performance role.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Performance Document Participants
Type:
array
Title:
Performance Document Participants
The Participants resource is a child of the roles resource. It retrieves information about participants in a performance document.
Show Source
Nested Schema : performanceEvaluations-Roles-Participants-item-response
Type:
Show Source
object
-
DueDate: string
(date)
Due date for a performance document participant to provide feedback.
-
EvalParticipantId: integer
(int64)
System-generated primary key of the participant in a performance document.
-
EvalRoleId: integer
(int64)
Title:
Participant Role
Unique identifier of the role of a performance document participant. -
FdbackCompletionDate: string
(date-time)
Date on which participant feedback in a performance document is completed.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixParticipantFlag: boolean
Maximum Length:
30
Indicates whether a participant is a matrix participant. Valid values are true or false. The default is false. -
ParticipationStatusCode: string
Title:
Status
Maximum Length:30
Code that represents the status of the participants feedback in a performance document. -
PersonId: integer
(int64)
Title:
Participant Name
Unique person identifier of a performance document participant. -
RoleTypeCode: string
Maximum Length:
30
Code that represents the type of role of a performance document participant. -
Tasks: array
Performance Document Tasks
Title:
Performance Document Tasks
The Tasks resource is a child of the participants resource. It retrieves information about the tasks available for a performance document.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Performance Document Tasks
Type:
array
Title:
Performance Document Tasks
The Tasks resource is a child of the participants resource. It retrieves information about the tasks available for a performance document.
Show Source
Nested Schema : performanceEvaluations-Roles-Participants-Tasks-item-response
Type:
Show Source
object
-
DueDate: string
(date)
Title:
Due Date
Due date for a performance document task. -
EvalStepId: integer
(int64)
System-generated primary key of a performance document task.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StepCode: string
Maximum Length:
30
Code of a performance document task. -
StepStatus: string
Title:
Status
Maximum Length:30
Status code of a performance document task. -
TaskName: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name of a performance document task. -
TaskStatus: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of a performance document task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Roles
-
Operation: /hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/RolesParameters:
- performanceEvaluationsUniqID:
$request.path.performanceEvaluationsUniqID
The Roles resource is a child of the performanceEvaluations resource. It retrieves information about the evaluation roles in a performance document. - performanceEvaluationsUniqID:
Examples
The following example shows how to get performance document for a single employee by submitting a singular GET request on the REST resource using cURL.
curl -i -u "<username>:<password>"-H "Content-Type: application/vnd.oracle.adf.resourceitem+json" GET http://host:port/hcmRestApi/resources/11.13.18.05/performanceEvaluations?onlyData=true&q=EvaluationId=300100014588623
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 Data Retrieved Retrieved Content-Type : application/json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "EvaluationId": 300100014588623, "PersonId": 100000008153756, "PersonNumber": "8153756", "PerformanceDocumentName": "360 FF Participants can accepts or declines" } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [..] }