Entities

The entities page will list all types of entities in the Portal.

You can filter on each column in the table.

Click on Edit and you can modify the icon and colour, and modify or select an API Request and Embedding Url for an existing entity type.

How to Create a New Entity

Click on Add Entity Type.

Add a new entity type

Provide the entity type. (This is required.)

Provide the Source.

Provide a Category and Subcategory.

Choose the API Request from the dropdown.

Add a new entity type

Choose an icon and its colour by clicking on Edit.

Add a new entity type

Provide a description for the URL field in Url Description. This is required as publishers will need to supply a URL for each asset registered against this entity type.

You can then click on Next to choose embedding details.

Add a new entity type

Provide an embedding URL to be able to embed assets with this entity type.

Add a new entity type

Adding of embedding params is disabled when there is no embedding url defined.

If you have provided an embedding URL, you can then optionally add embedding parameters here.

Click on Add and you can then provide the fields needed for a parameter.

Add a new entity type

Provide an Id, name, type (Text, Boolean, Choice, or Array), value, and description of this parameter.

Add a new entity type

Click on Save to add this entity type.

Add a new entity type