Content resources - HearstCorp/rover-wiki GitHub Wiki

Ad categories

https://{domain}/v2/adcategories

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
title	String	Ad category title	yes
prefix	String	Ad category prefix	yes
parent	Object/UUID	Parent ad category	no

Campaigns

https://{domain}/v2/campaigns

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
title	String	Campaign title	yes
campaign_id	String	Campaign id	yes
start_date	Date	Campaign start date	yes
end_date	Date	Campaign end date	yes
is_active	Boolean	Campaign state	yes

Categories

https://{domain}/v2/categories

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
title	String	Category title	yes
parent	Object/UUID	Parent category	no
iab_code	String	IAB category code	no

Category content

https://{domain}/v2/categories/{id}/content

Read-only listing of content resources related to a category

Collections

https://{domain}/v2/collections

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
site	Object/UUID	Site object - see Brand resources	no
status	Integer	See Publication status	yes
display_type	Integer	Display type id	yes
title	String	Collection title	yes
slug	String	Collection slug (unique with site)	yes
body	String	Collection body	yes
metadata	Object	Metadata is a JSON object	no
ad_category	Object/UUID	Ad category	yes
sponsor	Object/UUID	Sponsor	yes
parent	UUID	Parent category	no
publish_from	Date	See Dates	yes
publish_to	Date	See Dates	yes

Collection content

https://{domain}/v2/collections/{id}/content

Read-only listing of content resources related to a collection

Collection media

https://{domain}/v2/collections/{id}/media

Accepts GET, POST, DELETE operations.

POST operation properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier for related image/file/video	no
type	String	Media type - 'image', 'file', 'video', 'playlist', 'embed'	yes
role	Integer	Resource identifier for the purpose (role) - see Media Roles	no
metadata	Object	Metadata is a JSON object	no
order	Integer	The order in which resources will be automatically sorted	no

NOTE: The id parameter is required unless the type parameter is 'embed'.

DELETE operation

https://{domain}/v2/collections/{collection_id}/media/{collection_media_id}

DELETE operation properties

Name	Type	Description
collection_id	UUID	Unique resource identifier for collection
collection_media_id	UUID	Unique resource identifier for relationship between collection and media

Content types

https://{domain}/v2/contenttypes

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
title	String	Title	yes
display_type	Object/UUID	Display type	yes
metadata_schema	Object	A json-schema structure used to validate resources with content types	no
metadata	Object	Metadata is a JSON object	no
slug	String	Content Type slug	yes
body	String	Content body	yes

Content

https://{domain}/v2/content

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
display_id	Integer	Unique resource identifier	yes
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
site	Object	Site object - see Brand resources	yes
status	Integer	See Publication status	yes
content_type	Object/UUID	Content type	no
display_type	Object/UUID	Display type	no
title	String	Content title	yes
slug	String	Content slug (unique with site)	yes
created_by	Object/UUID	User object - see People resources	no
last_updated_by	Object/UUID	User object - see People resources	no
saved_by	UUIDs array	Author Uuids	no
dateline	String	Content date line, i.e. "MOUNTAIN VIEW, Calif. (sfgate.com)"	yes
body	String	Content body	yes
description	String	Content Description	no
metadata	Object	Metadata is a JSON object	no
publish_from	Date	See Dates	yes
publish_to	Date	See Dates	yes
display_date	Date	Used to display specific date in content	yes
legacy_id	Integer	Legacy identifier	yes
ad_category	Object/UUID	Ad category	yes
rights	Object	Entities that can use the content, see Rights	no
sponsor	Object/UUID	Sponsor	yes
section	Object/UUID	Section	yes
subsection	Object/UUID	Section	yes
editorial_source	Object/UUID	Source id	yes
authors	Array	Array of associated Profile resources - - see People resources	no
siblings	Array	Array of associated Content siblings	no
categories	Array	Array of associated Category resources - see Content categories	no
collections	Array	Array of associated Collection resources - see Content collections	no
media	Array	Array of associated ContentMedia resources - see Content media	no
tags	Array	Array of associated Tag resourcess - see Content tags	no

####Content listing for sitemaps and feeds (New in v2.3.6) There is an additional endpoint available at /v2/sites/{uuid}/content with a subset of content data for sitemap and rss feed purposes.

####Custom sorting (New in v2.3.5) By sorting the virtual field display_or_updated_date it is possible to get resources sorted on a combination of display_date (primary) and and updated_at (secondary).

Content authors

https://{domain}/v2/content/{id}/authors

Accepts a valid doorman Profile UUID as parameter id for POST and DELETE operations - i.e. associating an author profile with a content resource.

Content categories

https://{domain}/v2/content/{id}/categories

Has the same properties as Category on GET methods but accepts only the category id as parameter id for POST and DELETE operations - i.e. associating a category resource with a content resource.

Content collections

https://{domain}/v2/content/{id}/collections

Has the same properties as Collection on GET methods, and an additional primary boolean property. The collection id as parameter id and primary are accepted for POST, PUT and PATCH operations. The collection id as parameter id is accepted for DELETE operations.

Content siblings

https://{domain}/v2/content/{id}/siblings

Accepts content id of related content resource as parameter id for POST and DELETE operations - i.e. associating parent content resource with another content resource.

Content tags

https://{domain}/v2/content/{id}/tags

Has the same properties as Tag on GET methods but accepts only the tag id as parameter id for POST and DELETE operations - i.e. associating a tag resource with a content resource.

Content versions

GET https://{domain}/v2/contentversions

Content version management endpoint - business logic is currently part of MEI.

Name	Type	Description
id	UUID	Unique resource identifier
created_at	Date	Creation timestamp
content	UUID	Associated Content object
created_by	Object/UUID	User object - see People resources
data	String	Version data
data_type	String	Version data type
metadata	Object	Metadata is a JSON object

Content rights

The /content endpoint accepts the special rights and site_has_rights filter parameters as described in the User Guide.

Content media

https://{domain}/v2/content/{id}/media

A special case - it allows for generic association between a content resource as the parent and multiple types of media objects in order to construct slideshows with images, files and videos.

The related media objects have the same properties as Images/Files but are encapsulated as media_object in a content media object that states the id and the media type of the association.

Example

{
    "id": "014c73f2-e430-427b-950e-c6879d0cbdee",
    "media_type": "image",
    "media_object": {
        "id": "3d8bf20f-59fa-4d0a-8d75-46d66e1d0dbc",
        "filename": "ducimus-occaecati-226402322.jpg",
        "path": "/blog",
        "default_title": "Get slim quick.",
        "width": 685,
        "height": 513,
        "metadata": {},
        "created_at": "2015-10-21T17:29:57.866775Z",
        "updated_at": "2015-10-21T19:50:14.970413Z"
    },
    "metadata": {},
    "order": 1,
    "role": 4,
    "created_at": "2015-10-21T17:29:57.866775Z",
    "updated_at": "2015-10-21T19:50:14.970413Z"
},
{
    "id": "ebb28c67-8b0d-4824-8825-9557ca96c7cc",
    "media_type": "file",
    "media_object": {
        "id": "7681d1b7-64f6-4947-8e6c-90f0f15818fb",
        "filename": "exercise-smart-639680789.jpg",
        "path": "/categories/fitness/images",
        "default_title": "Smart exercises",
        "metadata": {},
        "created_at": "2015-10-21T17:29:57.866775Z",
        "updated_at": "2015-10-21T19:50:14.970413Z"
    },
    "metadata": {},
    "order": 2,
    "role": 3,
    "created_at": "2015-10-21T17:29:57.866775Z",
    "updated_at": "2015-10-21T19:50:14.970413Z"
}

POST operation properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier for related image/file/video	no
type	String	Media type - 'image', 'file', 'video', 'embed'	yes
role	Integer	Resource identifier for the purpose (role) - see Media Roles	no
metadata	Object	Metadata is a JSON object	no
order	Integer	The order in which resources will be automatically sorted	no

NOTE: The id parameter is required unless the type parameter is 'embed'.

DELETE operation

To remove an association between content and media, perform a DELETE operation on the association id, i.e.

DELETE https://{domain}/v2/content/{content_id}/media/{contentmedia_id}

Name	Type	Description
content_id	UUID	Unique resource identifier for collection
content_media_id	UUID	Unique resource identifier for content <-> media relationship

Display types

https://{domain}/v2/displaytypes

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
title	String	Title	yes
metadata_schema	Object	A json-schema structure used to validate resources with display types	no
category	Integer	Display type category (1 = content, 2 = feed)	no

Files

https://{domain}/v2/files

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
filename	String	File name	yes
path	String	File path	yes
default_title	String	Default title	yes
metadata	Object	Metadata is a JSON object	no

Flags

https://{domain}/v2/flags

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
site	Object/UUID	Site object - see Brand resources	yes
title	String	Flag title	yes
enabled	String	Boolean 0 or 1	yes
notes	String	Flag notes	yes

Images

https://{domain}/v2/images

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
display_id	Integer	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
site	Object/UUID	Site object - see Brand resources	yes
created_by	Object/UUID	User object - see People resources	no
rights	Object	Entities that can use the image, see Rights	no
filename	String	File name	yes
path	String	File path	yes
default_title	String	Default title	yes
width	Integer	Width	yes
height	Integer	Height	yes
metadata	Object	Metadata is a JSON object	no

Image rights

The /images endpoint accepts the special rights and site_has_rights filter parameters as described in the User Guide

Locks

https://{domain}/v2/locks

This endpoint allows for management via CRUD operations of locking items such as:

Name	Resource Type
Collection	collection
Content	content
ContentType	contenttype
Section	section
Tag	tag

The Resource type is the string value of what must be in the json body when creating a new lock on a given resource.

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
resource_id	UUID	The resource identifier of lockable object	no
resource_type	String	The lockable object type
user_id	UUID	The resource identifier of the user locking the object	no
metadata	Object	Metadata is a JSON object	no

PUT/PATCH operation

https://{domain}/v2/locks/{lock_id}

The lock_id represents the lock object UUID provided to the client upon creating the lock. This method requires a JSON body in the request as well in order to update fields. See above for which fields are available for update. Note that for the update operations, any of these are optional.

DELETE operation

https://{domain}/v2/locks/{lock_id}

Properties

Name	Type	Description
lock_id	UUID	The unique resource identifier for lock record

Menu items (added in v2.3)

https://{domain}/v2/menuitems

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
site	UUID	Site UUID - see Brand resources	yes
title	String	Menutitem title	yes
url	String	Menu item URL (absolute or relative)	yes
order	Integer	Order in menu - default 0	yes
target	Integer	Choice of 1: Same window, 2: New window, 3: New tab	yes
parent	UUID	Parent menu item	yes
children	Array	Children menu items	yes

Sections

https://{domain}/v2/sections

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
site	Object/UUID	Site object - see Brand resources	no
status	Integer	See Publication status	yes
display_type	Object/UUID	Display type id	no
title	String	Content title	yes
slug	String	Content slug (unique with site)	yes
body	String	Section body	yes
sponsor	Object/UUID	Sponsor	yes
metadata	Object	Metadata is a JSON object	no
publish_from	Date	See Dates	yes
publish_to	Date	See Dates	yes
subsections	Array	Array of associated Section objects - see Section subsections	no
ad_category	Object/UUID	Ad category	yes

Section subsections

https://{domain}/v2/sections/{id}/subsections

Has the same properties as Section on GET methods but accepts only the subsection id as parameter id for POST and DELETE operations - i.e. associating a section resource as subsection to another section resource.

Section media

https://{domain}/v2/sections/{id}/media

Accepts GET, POST, DELETE operations

POST operation properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier for related image/file/video	no
type	String	Media type - 'image', 'file', 'video', 'embed'	yes
role	Integer	Resource identifier for the purpose (role) - see Media Roles	no
metadata	Object	Metadata is a JSON object	no
order	Integer	The order in which resources will be automatically sorted	no

NOTE: The id parameter is required unless the type parameter is 'embed'

DELETE operation

To remove an association between a section and media, perform a DELETE operation on the association id, i.e.

DELETE https://{domain}/v2/sections/{section_id}/media/{section_media_id}

Name	Type	Description
section_id	UUID	Unique resource identifier for section
section_media_id	UUID	Unique resource identifier for section <-> media relationship

Source

https://{domain}/v2/sources

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
title	String	Title	yes
source_type	Integer	See Source type	yes
site	Object/UUID	Site object - see Brand resources	no

Sponsors

https://{domain}/v2/sponsors

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
title	String	Title	yes
site	Object/UUID	Site object - see Brand resources	yes
logo	Object/UUID	Image	yes
campaign	Object/UUID	Campaign	yes
brand	String	Sponsor brand	yes
url	String	Sponsor URL	yes
tracking_pixel	String	Tracking pixel name	yes

Statuses

https://{domain}/v2/statuses

Read-only listing of Publication statuses

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
title	String	Title	no

Tags

https://{domain}/v2/tags

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
site	Object/UUID	Site object - see Brand resources	yes
status	Integer	See Publication status	yes
tag_type	Object/UUID	Tag type	yes
display_type	Object/UUID	Display type	yes
title	String	Content title	yes
slug	String	Content slug (unique with site)	yes
sponsor	Object/UUID	Sponsor	yes
body	String	Tag body	yes
metadata	Object	Metadata is a JSON object	no
publish_from	Date	See Dates	yes
publish_to	Date	See Dates	yes
ad_category	Object/UUID	Ad category	yes

Tag content

https://{domain}/v2/tags/{id}/content

Read-only listing of content resources related to a tag

Tag media

Accepts GET, POST, DELETE operations

POST operation properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier for related image/file/video	no
type	String	Media type - 'image', 'file', 'video', 'embed'	yes
role	Integer	Resource identifier for the purpose (role) - see Media Roles	no
metadata	Object	Metadata is a JSON object	no
order	Integer	The order in which resources will be automatically sorted	no

NOTE: The id parameter is required unless the type parameter is 'embed'

DELETE operation

To remove an association between a section and media, perform a DELETE operation on the association id, i.e.

DELETE https://{domain}/v2/tags/{tag_id}/media/{tag_media_id}

Name	Type	Description
tag_id	UUID	Unique resource identifier for tag
tag_media_id	UUID	Unique resource identifier for tag <-> media relationship

Tag types

https://{domain}/v2/tagtypes

Properties

Name	Type	Description	Sortable
id	UUID	Unique resource identifier	no
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
title	String	Title	yes
metadata_schema	Object	A json-schema structure used to validate resources with tag types	no