Create a library goal measurement
post
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasures
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
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. -
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. -
TargetValue: number
Target value of the library goal measurement.
-
UomCode: string
Maximum Length:
30
Unit of measure code of the library goal's measurement.
Response
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.