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.