Get a library goal measurement
get
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasures/{libraryGoalMeasuresUniqID}
Request
Path Parameters
-
libraryGoalMeasuresUniqID(required): string
This is the hash key of the attributes which make up the composite key--- MeasurementContentId, BusinessGroupId and MeasurementId ---for the Library Goal Measures resource and used to uniquely identify an instance of Library Goal Measures. The client should not generate the hash key value. Instead, the client should query on the Library Goal Measures collection resource with a filter on the primary key values in order to navigate to a specific instance of Library Goal Measures.
For example: libraryGoalMeasures?q=MeasurementContentId=<value1>;BusinessGroupId=<value2>;MeasurementId=<value3> -
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-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 : 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.