Update a target outcome of a library goal
patch
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libGoalTargetOutcomes/{ContentItemRlatId}
Request
Path Parameters
-
ContentItemRlatId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
GoalId: integer
(int64)
Title:
Content Item ID
Unique identifier for the goal associated with the 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.
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-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.