Get a performance or development goal
get
/hcmRestApi/resources/11.13.18.05/searchGoals/{searchGoalsUniqID}
Request
Path Parameters
-
searchGoalsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- GoalId and GoalPlanGoalId ---for the Search Performance or Development Goals resource and used to uniquely identify an instance of Search Performance or Development Goals. The client should not generate the hash key value. Instead, the client should query on the Search Performance or Development Goals collection resource with a filter on the primary key values in order to navigate to a specific instance of Search Performance or Development Goals.
For example: searchGoals?q=GoalId=<value1>;GoalPlanGoalId=<value2>
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 : searchGoals-item-response
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of the performance or development goal. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Unique identifier for the job assignment of a worker. -
BusinessUnitId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Unique identifier for the business unit. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the business unit associated with the performance or development goal. -
DepartmentId: integer
(int64)
Read Only:
true
Unique identifier for the department. -
DepartmentName: string
Title:
Department
Read Only:true
Maximum Length:240
Name of the department associated with the performance or development goal. -
Description: string
Title:
Description
Maximum Length:4000
Description of the performance or development goal. -
GoalId: integer
(int64)
Title:
Goal ID
Unique identifier for the performance or development goal. -
GoalName: string
Title:
Goal Name
Maximum Length:400
Name of the performance or development goal. -
GoalPlanGoalId: integer
(int64)
Read Only:
true
Unique identifier for the performance goal in the goal plan. -
GoalPlanId: integer
(int64)
Title:
Goal Plan Name
Read Only:true
Unique identifier of the goal plan. -
GoalTypeCode: string
Title:
Goal Type
Maximum Length:30
Code that indicates whether the goal is a performance or development goal. -
JobId: integer
(int64)
Read Only:
true
Unique identifier for the job. -
JobName: string
Title:
Job
Read Only:true
Maximum Length:240
Name of the job of the worker who's assigned the performance or development goal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Display Name
Read Only:true
Maximum Length:240
Unique identifier for the location. -
LocationId: integer
(int64)
Read Only:
true
Name of the location associated with the performance or development goal. -
ManagerAssignmentId: integer
(int64)
Read Only:
true
Unique identifier for the assignment of the manager. -
ManagerId: integer
(int64)
Read Only:
true
Unique identifier for the manager. -
ManagerName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the manager. -
ManagerType: string
Title:
Type
Read Only:true
Maximum Length:30
Manager's relationship type with the worker who's assigned the performance or development goal. -
PerfGoalType: string
Read Only:
true
Maximum Length:255
Indicates whether the performance goal is an individual or organizational goal. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the worker who's assigned the performance or development goal. -
ReviewPeriodId: integer
(int64)
Read Only:
true
Unique Identifier for the review period that the goal plan of the performance goal is associated with. -
StartDate: string
(date)
Title:
Start Date
Start date of the performance or development goal. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:NOT_STARTED
Status code of the performance or development goal that indicates its status. -
StatusCodeMeaning: string
Read Only:
true
Maximum Length:255
Indicates whether the performance or development goal hasn't yet started, is in progress, or completed. -
TargetCompletionDate: string
(date)
Title:
Target Completion Date
Target completion date of the performance or development goal. -
WorkerAssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Unique identifier for the assignment of worker to whom the performance or development goal is assigned. -
WorkerAssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the assignment of the worker who's assigned the performance goal. -
WorkerAssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Unique assignment number for a worker assignment. -
WorkerId: integer
(int64)
Title:
Person ID
Unique identifier for the worker who's assigned the performance or development goal. -
WorkerName: string
Title:
Name
Read Only:true
Maximum Length:240
Display name of the worker to whom the performance or development goal is assigned.
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.