Get all user action hints
get
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/userActionHints
Request
Path Parameters
-
completionDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Completion Details resource and used to uniquely identify an instance of Completion Details. The client should not generate the hash key value. Instead, the client should query on the Completion Details collection resource in order to navigate to a specific instance of Completion Details to get the hash key.
-
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.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey :Finds all user action hints for assignments that match the specified primary key criteria.
Finder Variables:
- PrimaryKey :Finds all user action hints for assignments that match the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- activityLearnerMarkCompl; string; Indicates whether the learner can mark the activity as complete. Valid values are Y and N. Default value is N.
- allowRetry; string; Hint to identify whether a learner can retry the content or not. Y indicates that the learner is allowed to retry. N indicates that the learner isn't allowed to retry. Null indicates that this hint isn't applicable.
- canEditAssignmentHint; string; Hint to identify whether a user can edit the assignment. Examples include Can delete, Can withdraw, and No edit. Valid values are defined in the CanEditAssignmentHintLOV.
- canManageLearningItem; string; Hint to identify whether a user can manage the learning item.
- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
- enrollmentQuestionnaireIdESS; integer; Unique identifier for the enrollment questionnaire for learner self-service assignments.
- enrollmentQuestionnaireIdMSS; integer; Unique identifier for the enrollment questionnaire for manager self-service assignments.
- enrollmentQuestionnaireNumberESS; string; Friendly number for identifying the enrollment questionnaire for learner self-service assignments.
- enrollmentQuestionnaireNumberMSS; string; Friendly number for identifying the enrollment questionnaire for manager self-service assignments.
- initialLearningRecordStatusHintESS; string; Hint for the initial learning record status for learner self-service assignments.
- initialLearningRecordStatusHintESSMeaning; string; Description of the value of the initialLearningRecordStatusHintESS attribute.
- initialLearningRecordStatusHintMSS; string; Hint for the initial learning record status for manager self-service assignments.
- initialLearningRecordStatusHintMSSMeaning; string; Description of the value of the initialLearningRecordStatusHintMSS attribute.
- initialLearningRecordSubStatusHintESS; string; Hint for the initial learning record substatus for manager self-service assignments.
- initialLearningRecordSubStatusHintESSMeaning; string; Description of the value of the initialLearningRecordSubStatusHintESS attribute.
- isEnrolleeForumEnabled; string; Hint to identify whether the enrollee forum is enabled for the learning item.
- isManagerUserForumEnabled; string; Hint to identify whether the manager user forum is enabled for the learning item.
- isSelfServiceUserForumEnabled; string; Hint to identify whether the self-service user forum is enabled for the learning item.
- nextRetryDate; string; Date when the learner can next attempt the learning content.
- paymentTypesAccepted; string; Payment types accepted for the learning record, such as manual payment, online payment, or no payment. Valid values are defined in the PaymentTypesAcceptedLOV.
- paymentTypesAcceptedMeaning; string; Description of the value of the paymentTypesAccepted attribute.
- pendingPrereqTimeoutInDaysESS; number; Hint for the number of days a learner has to complete prerequisites before they're withdrawn for learner self-service.
- pendingPrereqTimeoutInDaysMSS; number; Hint for the number of days a learner has to complete prerequisites before they're withdrawn for manager self-service.
- refundRuleForILTActivity; string; Hint for a refund rule for the instructor-led activity.
- refundRuleForSPActivity; string; Hint for a refund rule for the self-paced activity.
- showEnrollmentFormESS; string; Hint to show the learning record request form for learner self-service assignments.
- showEnrollmentFormESSMeaning; string; Description of the value of the showEnrollmentFormESS attribute.
- showEnrollmentFormMSS; string; Hint to show learning record request form for manager self-service assignments.
- showEnrollmentFormMSSMeaning; string; Description of the value of the showEnrollmentFormMSS attribute.
- viewModeESS; string; Hint for the view mode for learner self-service. Valid values are defined in the ViewModeESSLOV.
- viewModeESSMeaning; string; Description of the value of the viewModeESS attribute.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : learnerLearningRecords-completionDetails-userActionHints
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-userActionHints-item-response
Type:
Show Source
object
-
activityLearnerMarkCompl: string
Read Only:
true
Maximum Length:1
Indicates whether the learner can mark the activity as complete. Valid values are Y and N. Default value is N. -
allowRetry: string
Read Only:
true
Maximum Length:1
Hint to identify whether a learner can retry the content or not. Y indicates that the learner is allowed to retry. N indicates that the learner isn't allowed to retry. Null indicates that this hint isn't applicable. -
canEditAssignmentHint: string
Title:
Can Edit Assignment Hint
Read Only:true
Maximum Length:4000
Hint to identify whether a user can edit the assignment. Examples include Can delete, Can withdraw, and No edit. Valid values are defined in the CanEditAssignmentHintLOV. -
canManageLearningItem: string
Title:
Can Manage Learning Item
Read Only:true
Maximum Length:4000
Hint to identify whether a user can manage the learning item. -
dataSecurityPrivilege: string
Title:
Data Security Privilege
Maximum Length:32
Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list. -
enrollmentQuestionnaireIdESS: integer
(int64)
Title:
Learner Enrollment Questionnaire ID
Read Only:true
Unique identifier for the enrollment questionnaire for learner self-service assignments. -
enrollmentQuestionnaireIdMSS: integer
(int64)
Title:
Manager Enrollment Questionnaire ID
Read Only:true
Unique identifier for the enrollment questionnaire for manager self-service assignments. -
enrollmentQuestionnaireNumberESS: string
Title:
Learner Enrollment Questionnaire Number
Read Only:true
Maximum Length:30
Friendly number for identifying the enrollment questionnaire for learner self-service assignments. -
enrollmentQuestionnaireNumberMSS: string
Title:
Manager Enrollment Questionnaire Number
Read Only:true
Maximum Length:30
Friendly number for identifying the enrollment questionnaire for manager self-service assignments. -
initialLearningRecordStatusHintESS: string
Title:
Self-Assignment
Read Only:true
Maximum Length:32
Hint for the initial learning record status for learner self-service assignments. -
initialLearningRecordStatusHintESSMeaning: string
Title:
Self-Assignment Description
Read Only:true
Maximum Length:4000
Description of the value of the initialLearningRecordStatusHintESS attribute. -
initialLearningRecordStatusHintMSS: string
Title:
Manager Assignment
Read Only:true
Maximum Length:32
Hint for the initial learning record status for manager self-service assignments. -
initialLearningRecordStatusHintMSSMeaning: string
Title:
Manager Assignment Description
Read Only:true
Maximum Length:4000
Description of the value of the initialLearningRecordStatusHintMSS attribute. -
initialLearningRecordSubStatusHintESS: string
Title:
Self-Assignment
Read Only:true
Maximum Length:32
Hint for the initial learning record substatus for manager self-service assignments. -
initialLearningRecordSubStatusHintESSMeaning: string
Title:
Self-Assignment Description
Read Only:true
Maximum Length:4000
Description of the value of the initialLearningRecordSubStatusHintESS attribute. -
isEnrolleeForumEnabled: string
Title:
Enrollee Forum Enabled
Read Only:true
Maximum Length:1
Hint to identify whether the enrollee forum is enabled for the learning item. -
isManagerUserForumEnabled: string
Read Only:
true
Maximum Length:1
Hint to identify whether the manager user forum is enabled for the learning item. -
isSelfServiceUserForumEnabled: string
Title:
Self Service User Forum Enabled
Read Only:true
Maximum Length:1
Hint to identify whether the self-service user forum is enabled for the learning item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
nextRetryDate: string
(date-time)
Read Only:
true
Date when the learner can next attempt the learning content. -
paymentTypesAccepted: string
Title:
Payment Type
Read Only:true
Maximum Length:30
Payment types accepted for the learning record, such as manual payment, online payment, or no payment. Valid values are defined in the PaymentTypesAcceptedLOV. -
paymentTypesAcceptedMeaning: string
Title:
Payment Type Description
Read Only:true
Maximum Length:4000
Description of the value of the paymentTypesAccepted attribute. -
pendingPrereqTimeoutInDaysESS: number
Title:
Self-Assignment Pending Prerequisite Timeout in Days
Read Only:true
Hint for the number of days a learner has to complete prerequisites before they're withdrawn for learner self-service. -
pendingPrereqTimeoutInDaysMSS: number
Title:
Manager Assignment Pending Prerequisite Timeout in Days
Read Only:true
Hint for the number of days a learner has to complete prerequisites before they're withdrawn for manager self-service. -
refundRuleForILTActivity: string
Title:
Refund Rule for Instructor-Led Activity
Read Only:true
Maximum Length:240
Hint for a refund rule for the instructor-led activity. -
refundRuleForSPActivity: string
Title:
Refund Rule for Self-Paced Activity
Read Only:true
Maximum Length:240
Hint for a refund rule for the self-paced activity. -
showEnrollmentFormESS: string
Title:
Show Learner Request Form
Read Only:true
Maximum Length:32
Hint to show the learning record request form for learner self-service assignments. -
showEnrollmentFormESSMeaning: string
Title:
Show Learner Request Form Description
Read Only:true
Maximum Length:4000
Description of the value of the showEnrollmentFormESS attribute. -
showEnrollmentFormMSS: string
Title:
Show Manager Request Form
Read Only:true
Maximum Length:32
Hint to show learning record request form for manager self-service assignments. -
showEnrollmentFormMSSMeaning: string
Title:
Show Manager Request Form Description
Read Only:true
Maximum Length:4000
Description of the value of the showEnrollmentFormMSS attribute. -
viewModeESS: string
Title:
View Mode
Read Only:true
Maximum Length:30
Hint for the view mode for learner self-service. Valid values are defined in the ViewModeESSLOV. -
viewModeESSMeaning: string
Title:
View Mode Description
Read Only:true
Maximum Length:4000
Description of the value of the viewModeESS attribute.
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.