Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 8 Next »

Platform URL

https://[enterprise].cvtr.io/v2/system/whitepapers/content-blocks

API Endpoints

Retrieves the collection of Block resources/Creates a Block resource:

GET/POST https://{enterprise}.cvtr.io/api/v4/blocks

Retrieves/Removes/Replaces a Block resource:

GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4/blocks/{id}

Retrieves a Content Block resource details:

GET https://{enterprise}.cvtr.io/api/v4/content-block-assets/{id}

Epic

DASH-581 - Getting issue details... STATUS

CON-4968 - Getting issue details... STATUS

Document status

DRAFT

Document owner

Adam Carter

Technical writers

Muge Budak Barnaby Murtagh (Unlicensed)

šŸ  Feature Overview

What does it do?

This feature creates a block for up to 5 white papers to be featured within a website. This is useful for Publishers who want to highlight specific key content on their website or via an ad-server.

Admin users would implement this feature by embedding a JavaScript tag into their website. In order to display a specific content block users would reference the ā€˜block idā€™ which can be found on the enterprise level.

  1. Add Content Block

  2. Edit Content Block

  3. Delete Content Block

\uD83D\uDDD2 Summary

Functionality

User Story

1

Add Content Block

As a user I want to Add a Content Block so that I can embed assets to a landing page

2

Edit Content Block

As a user I want to be able to Edit the Content Blocks I have already created so that I can change the way assets are embedded on a website or ad server

3

Delete Content Block

As a user I want to be able to Delete a Content Block so that I can remove a Content block if I no longer need it.

4

Custom Tables

A user can add, remove and reset columns for custom table

Name

Required

Notes

Name

(tick)

Name has to be unique

Websites

(tick)

Website has to be unique

Content Block listing

Adding a Content Block:

Click Add Content Block button

An ā€˜Addā€™ modal will overlay on the listings page. From here users can create new content block listings.A Name value is required and a Websites value is required. The website value does not validate if the value is a url. If website values already exist users can select them from the from a multi select list. Upon clicking ā€˜Saveā€™ the new Content block will be created.

Editing a Content Block:

Click Edit button in the Actions Column

A ā€˜Editā€™ modal will overlay on the listings page. From here users can Edit the Name (required field), Websites (required field) values and select which websites a contact block can be linked to via a multi select. Upon clicking ā€˜Saveā€™ button the Content Block listing will display these edits.

Deleting a Content Block:

Click Delete button in Actions column

A Delete modal will ask users if they want to confirm the deletion of a Content Block. Upon clicking ā€˜Yesā€™ the Content Block item will be deleted.

\uD83D\uDDD2Ā User Permissions

Only admin users have access to System > Whitepapers > Content Blocks

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=415459484

  • No labels