Attributes¶

EP.Presentation¶

A Presentation EP object’s structure differs in three ways from the general form of the EpObject data block:

• Its ObjectTypeId property will be set to the appropriate EPOBJ_T value (“<number:EPOJ_T:Presentation>”).

• When you use actions that create a new presentation, two additional properties appear in the object’s data block:

  {
      "BannerTitle": "<string>",
      "BannerDescription": "<string>",
  }
  

• When you use actions that fetch a presentation, three additional properties appear in the object’s data block:

  {
      "BannerTitle": "<string>",
      "BannerDescription": "<string>",
      "ViewLink": "<string>"
  }
  

  ViewLink

  URL string to use to view the presentation.

Actions¶

DELETE /d2l/api/eP/(D2LVERSION: version)/presentation/(D2LID: id)¶

Delete a particular presentation.

Parameters:	version (D2LVERSION) – API version. id (D2LID) – EP object ID.
Status Codes:	200 – Action succeeded. 403 – No permission to delete the presentation.
API Versions:	2.0+ – Route first appears in EP v3.5.1.

GET /d2l/api/eP/(D2LVERSION: version)/presentation/(D2LID: id)¶

Retrieve a particular presentation.

Parameters:	version (D2LVERSION) – API version. id (D2LID) – EP object ID.
Query Parameters:
	c – Optional boolean value. If “true”, include comments attached to the presentation.
Status Codes:	200 – Action succeeded. 403 – No permission to see artifact.
API Versions:	2.0+ – Route first appears in EP v3.5.1.

Return. This action retrieves a Presentation JSON data block.

POST /d2l/api/eP/(D2LVERSION: version)/presentations/new¶

Create a new presentation.

Parameters:	version (D2LVERSION) – API version.
Status Codes:	200 – Action succeeded. 400 – Invalid presentation data provided. 403 – No permission to create presentation.
API Versions:	2.0+ – Route first appears in EP v3.5.1.

Input. In your post body, provide a Presentation JSON data block, in the Create form, containing the properties for the new presentation.

Return. This action returns a Presentation JSON data block, in the Fetch form, for the newly created presentation.

POST /d2l/api/eP/(D2LVERSION: version)/presentation/(D2LID: id)¶

Update an existing presentation.

Parameters:	version (D2LVERSION) – API version.
Status Codes:	200 – Action succeeded. 400 – Mismatch between EP object ID in route and ObjectId property in the provided JSON data, or invalid presentation data provided. 403 – No permission to update presentation.
API Versions:	2.0+ – Route first appears in EP v3.5.1.

Input. Your post body should include a Presentation JSON data block containing the updated properties for the presentation.

Return. This action returns a Presentation JSON data block for the updated presentation.