Activities Resource
Gets activity information about a particular activity.

getActivity

Gets the full definition of an activity.

Example

1
const activityId: string = "https://example.com/activities/test-activity";
2
3
xapi.getActivity({
4
activityId: activityId
5
}).then((result: AxiosReponse<Activity>) => {
6
const activity: Activity = result.data;
7
console.log(activity);
8
});
Copied!

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.
Last modified 1mo ago