Get a library goal
get
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}
Request
Path Parameters
-
libraryGoalsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Library Goals resource and used to uniquely identify an instance of Library Goals. The client should not generate the hash key value. Instead, the client should query on the Library Goals collection resource in order to navigate to a specific instance of Library Goals 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
-
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 : libraryGoals-item-response
Type:
Show Source
object
-
AvailableTo: string
Title:
Meaning
Read Only:true
Maximum Length:80
Indicates the roles that have access to the library goal. The library goal can be made available only to HR specialists, or can also be made available to managers and workers. -
BusinessUnitId: number
Unique identifier for the business unit associated with the library goal.
-
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the business unit associated with the library goal. -
Comments: string
Maximum Length:
4000
Comments added to the library goal. -
ContentTypeId: integer
(int64)
Title:
Content Type
Default Value:124
Unique identifier for the content type associated with the library goal. -
DateTo: string
(date)
Title:
To Date
End date of the library goal. -
DepartmentId: number
Unique identifier for the department associated with the library goal.
-
DepartmentName: string
Title:
Department
Read Only:true
Maximum Length:240
Name of the department associated with the library goal. -
Description: string
Title:
Full Content Item Description
Maximum Length:4000
Description of the library goal. -
DevCategoryCode: string
Maximum Length:
30
Category code of the development library goal. -
DevCategoryMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Category of the development library goal. -
GoalExternalId: string
Maximum Length:
30
Unique external identifier for the library goal. -
GoalId: integer
(int64)
Title:
Content Item ID
Unique identifier for the library goal. -
GoalName: string
Title:
Name
Maximum Length:700
Name of the library goal. -
GoalSubTypeCode: string
Maximum Length:
30
Subtype code of the library goal. -
GoalSubTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Subtype of the library goal. Subtypes are configured based on business requirements. -
GoalUrl: string
Maximum Length:
4000
Uniform Resource Locator of the library goal. -
JobFamilyId: number
Unique identifier for the job family associated with the library goal.
-
JobFamilyName: string
Title:
Job Family
Read Only:true
Maximum Length:240
Name of the job family associated with the library goal. -
JobId: number
Unique identifier for the job associated with the library goal.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date the library goal was last updated. -
LegalEmployerId: number
Unique identifier for the legal employer associated with the library goal.
-
LegalEmployerName: string
Read Only:
true
Maximum Length:255
Name of the legal employer associated with the library goal. -
LevelCode: string
Maximum Length:
30
Level code of the library goal. -
LevelMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Level of the library goal. -
libGoalTargetOutcomes: array
Library Goal Target Outcomes
Title:
Library Goal Target Outcomes
The libGoalTargetOutcomes resource is a child of the libraryGoals resource and provides all the target outcomes of library goals. -
libraryGoalMeasures: array
Library Goal Measures
Title:
Library Goal Measures
The libraryGoalMeasures resource is a child of the libraryGoals resource and provides all the measurements for library goals. -
libraryGoalsDFF: array
libraryGoalsDFF
-
libraryGoalTasks: array
Library Goal Tasks
Title:
Library Goal Tasks
The libraryGoalTasks resource is a child of the libraryGoals resource and provides all the tasks for library goals. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerfCategoryCode: string
Maximum Length:
30
Category code of the performance library goal. -
PerfCategoryMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Category of the performance library goal. -
PriorityCode: string
Maximum Length:
30
Priority code of the library goal. -
PriorityMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Priority of the library goal. -
StartDate: string
(date)
Start date of the library goal.
-
StatusCode: string
Maximum Length:
30
Status code of the library goal. -
StatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the library goal. -
SuccessCriteria: string
Maximum Length:
4000
Success criteria of the library goal. -
TargetCompletionDate: string
(date)
Target completion date of the library goal.
-
TypeCode: string
Maximum Length:
30
Code that indicates the type of library goal. -
TypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of library goal. -
Visible: string
Maximum Length:
30
Indicates who can view the library goal. The goal can be viewed only by the HR specialist, only by the HR specialist and manager, or HR specialist, manager, and worker.
Nested Schema : Library Goal Target Outcomes
Type:
array
Title:
Library Goal Target Outcomes
The libGoalTargetOutcomes resource is a child of the libraryGoals resource and provides all the target outcomes of library goals.
Show Source
Nested Schema : Library Goal Measures
Type:
array
Title:
Library Goal Measures
The libraryGoalMeasures resource is a child of the libraryGoals resource and provides all the measurements for library goals.
Show Source
Nested Schema : Library Goal Tasks
Type:
array
Title:
Library Goal Tasks
The libraryGoalTasks resource is a child of the libraryGoals resource and provides all the tasks for library goals.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : libraryGoals-libGoalTargetOutcomes-item-response
Type:
Show Source
object
-
ContentItemRlatId: integer
(int64)
Title:
Content Item Relationship ID
Unique identifier for the content item added as a target outcome. -
ContentTypeName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the content type added as a target outcome. -
GoalId: integer
(int64)
Title:
Content Item ID
Unique identifier for the goal associated with the target outcome. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:2000
Item description of the target outcome. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the target outcome was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:700
Name of content item added as a target outcome. -
RelationshipCode: string
Title:
Relationship
Maximum Length:30
Default Value:SUPPORTS
Code that indicates the relationship type of the content item added as a target outcome. -
TypeId: integer
(int64)
Title:
Related Content Type
Unique identifier for the content type added as a target outcome. -
TypeItemId: integer
(int64)
Title:
Related Content Item
Unique identifier for the content item type added as a target outcome.
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.
Nested Schema : libraryGoals-libraryGoalMeasures-item-response
Type:
Show Source
object
-
ActualValue: number
Actual value of the library goal's measurement.
-
BusinessGroupId: integer
(int64)
Title:
Business Group ID
Unique identifier for the business group for which the library goal's measurement applies. -
Comments: string
Title:
Full Content Item Description
Maximum Length:4000
Comments about the library goal's measurement. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the library goal measurement. -
CreationDate: string
(date-time)
Read Only:
true
Date when the library goal measurement was created. -
EndDate: string
(date)
End date of the library goal measurement.
-
GoalId: integer
(int64)
Title:
Content Item ID
Unique identifier for the library goal for which the measurement applies. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the library goal measurement was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who the last updated the library goal measurement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumTarget: number
Maximum target of the library goal measurement.
-
MeasurementContentId: integer
(int64)
Title:
Content Item ID
Unique identifier for the measurement of a library goal used to associate it with its components such as the measurement name, and measurement start date. -
MeasurementId: integer
(int64)
Title:
Content Item Relationship ID
Unique identifier for the measurement of a library goal. -
MeasurementName: string
Title:
Name
Maximum Length:700
Name of the measurement of a library goal. -
MeasureTypeCode: string
Maximum Length:
30
Default Value:QUALITATIVE
Code that indicates the measurement type of the measurement associated with the library goal. -
MinimumTarget: number
Minimum target of the library goal measurement.
-
StartDate: string
(date)
Start date of the library goal measurement.
-
TargetTypeCode: string
Maximum Length:
30
Target type code of the library goal measurement. -
TargetTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Target type of the library goal measurement. -
TargetValue: number
Target value of the library goal measurement.
-
UomCode: string
Maximum Length:
30
Unit of measure code of the library goal's measurement. -
UomMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Unit of measure of the library goal's measurement.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : libraryGoals-libraryGoalsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
BusinessGroupId: integer
(int64)
Title:
Business Group ID
-
ContentItemId: integer
(int64)
Title:
Content Item ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : libraryGoals-libraryGoalTasks-item-response
Type:
Show Source
object
-
BusinessGroupId: integer
(int64)
Title:
Business Group ID
Unique identifier for the business group for which the library goal's task applies. -
Comments: string
Title:
Full Content Item Description
Maximum Length:4000
Comments about the library goal task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the library goal task. -
CreationDate: string
(date-time)
Read Only:
true
Date when the library goal task was created. -
GoalId: integer
(int64)
Title:
Content Item ID
Unique identifier for the library goal for which the task applies. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the library goal task was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the library goal task. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PercentCompletion: string
Maximum Length:
30
Completion percentage of the library goal's task. -
PriorityCode: string
Maximum Length:
30
Priority code of the library goal's task. -
PriorityMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Priority of the library goal's task. -
RelatedLink: string
Maximum Length:
4000
Related link of the library goal's task. -
StartDate: string
(date)
Start date of the library goal's task.
-
StatusCode: string
Maximum Length:
30
Status code of the library goal's task. -
StatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the library goal's task. -
TargetCompletionDate: string
(date)
Target completion date for the library goal's task.
-
TaskContentId: integer
(int64)
Title:
Content Item ID
Unique identifier for the task of a library goal used to associate it with its components such as the task name, and task start date. -
TaskId: integer
(int64)
Title:
Content Item Relationship ID
Unique identifier for the task of a library goal. -
TaskName: string
Title:
Name
Maximum Length:700
Name of the task of a library goal. -
TaskTypeCode: string
Maximum Length:
30
Task type code of the library goal's task. -
TaskTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Task type of the library goal's task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- libGoalTargetOutcomes
-
Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libGoalTargetOutcomesParameters:
- libraryGoalsUniqID:
$request.path.libraryGoalsUniqID
The libGoalTargetOutcomes resource is a child of the libraryGoals resource and provides all the target outcomes of library goals. - libraryGoalsUniqID:
- libraryGoalMeasures
-
Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasuresParameters:
- libraryGoalsUniqID:
$request.path.libraryGoalsUniqID
The libraryGoalMeasures resource is a child of the libraryGoals resource and provides all the measurements for library goals. - libraryGoalsUniqID:
- libraryGoalTasks
-
Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasksParameters:
- libraryGoalsUniqID:
$request.path.libraryGoalsUniqID
The libraryGoalTasks resource is a child of the libraryGoals resource and provides all the tasks for library goals. - libraryGoalsUniqID:
- libraryGoalsDFF
-
Operation: /hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalsDFFParameters:
- libraryGoalsUniqID:
$request.path.libraryGoalsUniqID
- libraryGoalsUniqID: