Edit a message
patch
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
Request
Path Parameters
-
learnerLearningRecordsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Learner Learning Records resource and used to uniquely identify an instance of Learner Learning Records. The client should not generate the hash key value. Instead, the client should query on the Learner Learning Records collection resource in order to navigate to a specific instance of Learner Learning Records to get the hash key.
-
messagesUniqID(required): string
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=
-
otherSelectedCourseOfferingsUniqID(required): string
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=
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
-
dataSecurityPrivilege: string
Title:
Data Security Privilege
Maximum Length:32
Data security privilege, such as Learner or Learner Manager, that identifies the intent and permissions for the person accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
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 : learnerLearningRecords-primarySelectedCourseOffering-messages-item-response
Type:
Show Source
object
-
dataSecurityPrivilege: string
Title:
Data Security Privilege
Maximum Length:32
Data security privilege, such as Learner or Learner Manager, that identifies the intent and permissions for the person accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
message: string
Read Only:
true
Code to indicate the type of message. -
messageCode: string
Read Only:
true
User-friendly string describing the message. -
messageSecondaryText: string
Read Only:
true
Secondary text for the message. -
messageSeverity: string
Read Only:
true
Indicates the severity of the message like: INFO, WARN, or FATAL. -
visibility: string
Read Only:
true
Determines the message visibility. Valid values are Show or Hide.
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.
Links
- DataSecurityPrivilegeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGNMENT_SEC_CONTEXT
The following properties are defined on the LOV link relation:- Source Attribute: dataSecurityPrivilege; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MessageVisibilityLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LRN_MESSAGE_VISIBILITY
The following properties are defined on the LOV link relation:- Source Attribute: visibility; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: