xAPI.js
  • xAPI.js
  • xAPI Wrapper Library
    • Introduction
    • Getting Started
    • The XAPI Class
    • Statement Resource
    • State Resource
    • Activity Profile Resource
    • Agent Profile Resource
    • About Resource
    • Agents Resource
    • Activities Resource
    • Helpers
    • Verbs
    • Attachment Usages
  • cmi5 Profile Library
    • Introduction
    • Getting Started
    • The Cmi5 Class
    • "cmi5 defined" Statement methods
    • "cmi5 allowed" Statement methods
    • Helpers
Powered by GitBook
On this page
  • getActivity
  • Example
  • Parameters
  • Returns

Was this helpful?

  1. xAPI Wrapper Library

Activities Resource

Gets activity information about a particular activity.

getActivity

Gets the full definition of an activity.

Example

const activityId: string = "https://example.com/activities/test-activity";

xapi.getActivity({
  activityId: activityId
}).then((result: AxiosReponse<Activity>) => {
  const activity: Activity = result.data;
  console.log(activity);
});

Parameters

Parameter

Type

Required

Description

activityId

string

true

The URI of the activity.

useCacheBuster

boolean

false

Enables cache busting.

Returns

This method returns an AxiosPromise with the success data containing an Activity if successful.

PreviousAgents ResourceNextHelpers

Last updated 3 years ago

Was this helpful?