REST API for Oracle Fusion Cloud HCM

Get all completion summaries

get

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionSummary

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.

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 the completion summary for learning assignments that match the specified primary key criteria.
  Finder Variables:
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:
- activitySectionsCount; number; Total number of activity sections in a learning item.
- activitySectionsTotalActivitiesCount; number; Total number of activities in the activities section of a learning item.
- actualEffort; number; Actual effort by the learner.
- actualScore; number; Learner score for the learning assignment.
- completionProgress; number; Learner progress in completing the learning assignment. For a course, it's the number of activities completed. For a specialization, it's the sum of all the completed courses. For tutorials, it's the sum of all the completed sections.
- completionRequirement; number; Number of activities left to complete to complete the learning course assignment offering.
- completionRequirementUnits; string; Unit of measure for the assignment completion requirement, such as chapters, hours, or required activities. Valid values are defined in the CompletionRequirementUnitsLOV list.
- completionRequirementUnitsMeaning; string; Description of the completionRequirementUnits attribute value
- effortUnits; string; Unit of measure for the expected and actual effort to complete the learning item, such as day, hour, or minute. Valid values are defined in the EffortUnitsLOV list.
- effortUnitsMeaning; string; Description of the effortUnits attribute value.
- expectedEffort; string; Expected effort to complete the learning item.
- expectedEffortInSeconds; string; Expected effort, in seconds, to complete the learning item.
- passingScore; number; Passing score for the learning item.
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.

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-completionSummary

Type: object

Show Source

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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionSummary-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object learnerLearningRecords-completionSummary-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionSummary-item-response"
    }
}

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 : learnerLearningRecords-completionSummary-item-response

Type: object

Show Source

activitySectionsCount: number

Title: Total Activity Sections

Read Only: true

Total number of activity sections in a learning item.
activitySectionsTotalActivitiesCount: number

Title: Total Activities

Read Only: true

Total number of activities in the activities section of a learning item.
actualEffort: number

Title: Actual Effort

Read Only: true

Actual effort by the learner.
actualScore: number

Title: Actual Score

Read Only: true

Learner score for the learning assignment.
completionProgress: number

Title: Completion Progress

Learner progress in completing the learning assignment. For a course, it's the number of activities completed. For a specialization, it's the sum of all the completed courses. For tutorials, it's the sum of all the completed sections.
completionRequirement: number

Title: Completion Requirement

Read Only: true

Number of activities left to complete to complete the learning course assignment offering.
completionRequirementUnits: string

Title: Completion Requirement Units

Read Only: true

Maximum Length: 120

Unit of measure for the assignment completion requirement, such as chapters, hours, or required activities. Valid values are defined in the CompletionRequirementUnitsLOV list.
completionRequirementUnitsMeaning: string

Title: Completion Requirement Units Description

Read Only: true

Maximum Length: 4000

Description of the completionRequirementUnits attribute value
effortUnits: string

Title: Effort Units

Read Only: true

Maximum Length: 30

Unit of measure for the expected and actual effort to complete the learning item, such as day, hour, or minute. Valid values are defined in the EffortUnitsLOV list.
effortUnitsMeaning: string

Title: Effort Units Description

Read Only: true

Maximum Length: 4000

Description of the effortUnits attribute value.
expectedEffort: string

Title: Expected Effort

Read Only: true

Maximum Length: 32

Expected effort to complete the learning item.
expectedEffortInSeconds: string

Read Only: true

Expected effort, in seconds, to complete the learning item.
links: array Links

Title: Links

The link relations associated with the resource instance.
passingScore: number

Title: Passing Score

Read Only: true

Passing score for the learning item.

{
    "type":"object",
    "properties":{
        "completionProgress":{
            "title":"Completion Progress",
            "type":"number",
            "description":"Learner progress in completing the learning assignment. For a course, it's the number of activities completed. For a specialization, it's the sum of all the completed courses. For tutorials, it's the sum of all the completed sections.",
            "nullable":true,
            "x-queryable":true
        },
        "completionRequirement":{
            "title":"Completion Requirement",
            "type":"number",
            "description":"Number of activities left to complete to complete the learning course assignment offering.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completionRequirementUnits":{
            "title":"Completion Requirement Units",
            "maxLength":120,
            "type":"string",
            "description":"Unit of measure for the assignment completion requirement, such as chapters, hours, or required activities. Valid values are defined in the CompletionRequirementUnitsLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "actualScore":{
            "title":"Actual Score",
            "type":"number",
            "description":"Learner score for the learning assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "passingScore":{
            "title":"Passing Score",
            "type":"number",
            "description":"Passing score for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionsTotalActivitiesCount":{
            "title":"Total Activities",
            "type":"number",
            "description":"Total number of activities in the activities section of a learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionsCount":{
            "title":"Total Activity Sections",
            "type":"number",
            "description":"Total number of activity sections in a learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "effortUnitsMeaning":{
            "title":"Effort Units Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the effortUnits attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "actualEffort":{
            "title":"Actual Effort",
            "type":"number",
            "description":"Actual effort by the learner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completionRequirementUnitsMeaning":{
            "title":"Completion Requirement Units Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the completionRequirementUnits attribute value",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "expectedEffortInSeconds":{
            "type":"string",
            "description":"Expected effort, in seconds, to complete the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expectedEffort":{
            "title":"Expected Effort",
            "maxLength":32,
            "type":"string",
            "description":"Expected effort to complete the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "effortUnits":{
            "title":"Effort Units",
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the expected and actual effort to complete the learning item, such as day, hour, or minute. Valid values are defined in the EffortUnitsLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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."
        }
    }
}

Examples

The following example shows how to retrieve all the completion summaries of a learning assignment by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET  https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learnerLearningRecords?q=assignmentRecordNumber='OLC128157'&expand=completionSummary

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "assignmentRecordId": 300000175620070,
            "assignmentRecordNumber": "OLC124158",
            "assignmentCreatedDate": "2018-10-11T18:23:29.189+00:00",
            "assignmentLastModifiedDate": "2018-10-11T19:43:49.232+00:00",
            "assignmentType": "ORA_JOIN_ASSIGNMENT",
            "assignmentJustification": null,
            "assignmentDueDate": null,
            "assignmentStatus": "ORA_ASSN_REC_COMPLETE",
            "assignmentSubStatus": "ORA_ASSN_REC_COMPLETE",
            "assignmentDetailsDeepLink": "<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_COURSE&action=NONE&objKey=itemId%3D300000175619876",
            "assignmentDetailsEmbedLink": "<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000175619876&LearningItemType=ORA_COURSE&DisplayMode=details",
            "assignedToId": 300000047887398,
            "assignedToNumber": "100",
            "assignedToPersonEmail": "brian.joseph_zetm@exampledemos.com",
            "assignedToPersonPhone": "123-4568",
            "assignedToPersonImageURL": "<host>:<port>/hcmUI/personImage?personId=300000047887398",
            "assignedToDisplayName": "Brian Joseph",
            "assignerId": 300000047887398,
            "assignerNumber": "100",
            "assignerAttributionType": "ORA_PERSON",
            "assignerDisplayName": "Brian Joseph",
            "assignerPersonPrimaryEmail": "brian.joseph_zetm@exampledemos.com",
            "assignerPersonPrimaryPhone": "123-4568",
            "assignerCommentsToLearner": null,
            "assignerPersonImageURL": "<host>:<port>/hcmUI/personImage?personId=300000047887398",
            "learningItemId": 300000175619876,
            "learningItemNumber": "OLC128457",
            "learningItemType": "ORA_COURSE",
            "learningItemTitle": "Virtual Training Example - Webex Course 101",
            "liShortDescription": "VILT Webex Example",
            "learningItemEffectiveAsOf": "2018-10-11",
            "learningItemDeepLink": "<host>:<port>/hcmUI/faces/deeplink?objType=WLF_LEARN_SS_VIEW_COURSE&action=NONE&objKey=itemId%3D300000175619876",
            "learningItemEmbedLink": "<host>:<port>/hcmUI/rest/LearningItemShowcasePlugin?LearningItemId=300000175619876&LearningItemType=ORA_COURSE&DisplayMode=details",
            "expectedEffortInHours": "1 - 1",
            "requestedStartDate": null,
            "requestCompleteByDate": null,
            "enteredWaitlistDate": null,
            "currentWaitlistPosition": null,
            "exitedWaitlistDate": null,
            "purchasedDate": null,
            "assignedDate": "2018-10-11T00:00:00+00:00",
            "withdrawnDate": null,
            "completedDate": "2018-10-11T19:43:50.020+00:00",
            "expirationDate": null,
            "expirationInDaysSysdate": null,
            "validityPeriodRule": null,
            "hasFutureRenewal": null,
            "nextRenewalAssignmentId": null,
            "nextRenewalAssignmentNumber": null,
            "assignmentDueInFromSysdate": 0,
            "completionSummary": [
                {
                    "passingScore": null,
                    "expectedEffort": 1,
                    "effortUnits": "ORA_DUR_HOUR",
                    "completionRequirement": 1,
                    "completionRequirementUnits": "ORA_REQUIRED_ACTIVITIES",
                    "actualScore": null,
                    "actualEffort": 1,
                    "completionProgress": 1,
                    "links": [
                         {
                          ...}
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
          ...}
    ]
}