Jump to

• Request
• Response

Get a user action hint

get

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/userActionHints/{userActionHintsUniqID}

Request

Path Parameters

• learnerLearningRecordsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the (learnerLearningRecords) resource and used to uniquely identify an instance of (learnerLearningRecords). The client should not generate the hash key value. Instead, the client should query on the (learnerLearningRecords) collection resource in order to navigate to a specific instance of (learnerLearningRecords) to get the hash key.
• userActionHintsUniqID(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=

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 Top

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.

Body ()

Root Schema : learnerLearningRecords-userActionHints-item-response

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "initialLearningRecordStatusHintMSSMeaning":{
            "title":"Manager Assignment Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the initialLearningRecordStatusHintMSS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "paymentTypesAccepted":{
            "title":"Payment Type",
            "maxLength":30,
            "type":"string",
            "description":"Payment types accepted for the learning record, such as manual payment, online payment, or no payment. Valid values are defined in the PaymentTypesAcceptedLOV.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "refundRuleForSPActivity":{
            "title":"Refund Rule for Self-Paced Activity",
            "maxLength":240,
            "type":"string",
            "description":"Hint for a refund rule for the self-paced activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "pendingPrereqTimeoutInDaysESS":{
            "title":"Self-Assignment Pending Prerequisite Timeout in Days",
            "type":"number",
            "description":"Hint for the number of days a learner has to complete prerequisites before they're withdrawn for learner self-service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "initialLearningRecordStatusHintMSS":{
            "title":"Manager Assignment",
            "maxLength":32,
            "type":"string",
            "description":"Hint for the initial learning record status for manager self-service assignments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "allowEnrollmentWhenPreqsNotAchievedMSS"
                ]
            },
            "x-queryable":true
        },
        "canEditAssignmentHint":{
            "title":"Can Edit Assignment Hint",
            "maxLength":4000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "showEnrollmentFormMSSMeaning":{
            "title":"Show Manager Request Form Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the showEnrollmentFormMSS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "enrollmentQuestionnaireIdMSS":{
            "title":"Manager Enrollment Questionnaire ID",
            "type":"integer",
            "description":"Unique identifier for the enrollment questionnaire for manager self-service assignments.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "enrollmentQuestionnaireNumberMSS":{
            "title":"Manager Enrollment Questionnaire Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number for identifying the enrollment questionnaire for manager self-service assignments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "showEnrollmentFormESSMeaning":{
            "title":"Show Learner Request Form Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the showEnrollmentFormESS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "isManagerUserForumEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Hint to identify whether the manager user forum is enabled for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "initialLearningRecordSubStatusHintESSMeaning":{
            "title":"Self-Assignment Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the initialLearningRecordSubStatusHintESS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "paymentTypesAcceptedMeaning":{
            "title":"Payment Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the paymentTypesAccepted attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "showEnrollmentFormESS":{
            "title":"Show Learner Request Form",
            "maxLength":32,
            "type":"string",
            "description":"Hint to show the learning record request form for learner self-service assignments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "enrollmentQuestionnaireIdESS":{
            "title":"Learner Enrollment Questionnaire ID",
            "type":"integer",
            "description":"Unique identifier for the enrollment questionnaire for learner self-service assignments.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":32,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "showEnrollmentFormMSS":{
            "title":"Show Manager Request Form",
            "maxLength":32,
            "type":"string",
            "description":"Hint to show learning record request form for manager self-service assignments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "isSelfServiceUserForumEnabled":{
            "title":"Self Service User Forum Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Hint to identify whether the self-service user forum is enabled for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "canManageLearningItem":{
            "title":"Can Manage Learning Item",
            "maxLength":4000,
            "type":"string",
            "description":"Hint to identify whether a user can manage the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "viewModeESS":{
            "title":"View Mode",
            "maxLength":30,
            "type":"string",
            "description":"Hint for the view mode for learner self-service. Valid values are defined in the ViewModeESSLOV.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "initialLearningRecordStatusHintESSMeaning":{
            "title":"Self-Assignment Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the initialLearningRecordStatusHintESS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "enrollmentQuestionnaireNumberESS":{
            "title":"Learner Enrollment Questionnaire Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number for identifying the enrollment questionnaire for learner self-service assignments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "refundRuleForILTActivity":{
            "title":"Refund Rule for Instructor-Led Activity",
            "maxLength":240,
            "type":"string",
            "description":"Hint for a refund rule for the instructor-led activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "viewModeESSMeaning":{
            "title":"View Mode Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the viewModeESS attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "initialLearningRecordStatusHintESS":{
            "title":"Self-Assignment",
            "maxLength":32,
            "type":"string",
            "description":"Hint for the initial learning record status for learner self-service assignments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "allowEnrollmentWhenPreqsNotAchievedESS"
                ]
            },
            "x-queryable":true
        },
        "initialLearningRecordSubStatusHintESS":{
            "title":"Self-Assignment",
            "maxLength":32,
            "type":"string",
            "description":"Hint for the initial learning record substatus for manager self-service assignments.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "allowEnrollmentWhenPreqsNotAchievedESS"
                ]
            },
            "x-queryable":true
        },
        "pendingPrereqTimeoutInDaysMSS":{
            "title":"Manager Assignment Pending Prerequisite Timeout in Days",
            "type":"number",
            "description":"Hint for the number of days a learner has to complete prerequisites before they're withdrawn for manager self-service.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "isEnrolleeForumEnabled":{
            "title":"Enrollee Forum Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Hint to identify whether the enrollee forum is enabled for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CanEditAssignmentHintLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CAN_EDIT_ASSIGNMENT_HINT

The following properties are defined on the LOV link relation:

• Source Attribute: canEditAssignmentHint; Target Attribute: LookupCode
• Display Attribute: Meaning

DataSecurityPrivilegeLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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

InitialLearningRecordStatusHintESSLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_INIT_ASSGN_STATE_ESS

The following properties are defined on the LOV link relation:

• Source Attribute: initialLearningRecordStatusHintESS; Target Attribute: LookupCode
• Display Attribute: Meaning

InitialLearningRecordStatusHintMSSLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_INIT_ASSGN_STATE_MGR

The following properties are defined on the LOV link relation:

• Source Attribute: initialLearningRecordStatusHintMSS; Target Attribute: LookupCode
• Display Attribute: Meaning

InitialLearningRecordSubStatusHintESSLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_INIT_ASGN_SUBSTATE_ESS

The following properties are defined on the LOV link relation:

• Source Attribute: initialLearningRecordSubStatusHintESS; Target Attribute: LookupCode
• Display Attribute: Meaning

PaymentTypesAcceptedLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_PAYMENT_PROCESSING

The following properties are defined on the LOV link relation:

• Source Attribute: paymentTypesAccepted; Target Attribute: LookupCode
• Display Attribute: Meaning

ViewModeESSLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_WLF_VIEW_MODE

The following properties are defined on the LOV link relation:

• Source Attribute: viewModeESS; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top