ePublishing Knowledge BaseContinuumContent Import/ExportWhat are all of the possible routes and filters available for the content export XML feed?

What are all of the possible routes and filters available for the content export XML feed?

Overview

The following routes and filters are possible for the NewsML Export for Articles.

Currently, there is a limit of 50 articles being returned with a single NewsML call based on routes and filters.

Routes and Filters

The below routes are all assume version 1 of the API and are for articles

https://www.domain.com/api/v1/articles/….

1. Route: Article ID(s)

Purpose:

Provide a specific article id or list of article IDs in a comma delimited list.

If a range in included, all articles included in the range will be returned along with any additional articles outside of the range, but in the comma-delimited list.

Variables

  • from: Accepted date format YYYY-MM-DD
  • to: Accepted date format YYYY-MM-DD
  • datetype: The date field to be use to retrieve articles within the from and to range

Example:

https://www.domain.com/api/v1/articles/68283,20958,20959,52858

https://www.domain.com/api/v1/articles/4,13-27,91

2. Route: Date Range with Data Type filters

Purpose:

If no datetype is set, the default post_date will be used.

Options for datetype include:

  • post_date
  • pull_date
  • updated_date - Date the article was last updated by any user
  • created_date - Date the article was created

Find the Post Date (Go Live Date) and the Pull Date in your article in the Article Manager under General.

Example:

https://www.domain.com/api/v1/articles/from/2015-03-01/to/2016-01-01?datetype=pull_date

3. Route: Taxonomy Association

Purpose:

In a comma delimited list, put in the desired taxonomies.

NOTE: If a range of taxonomies is included, only the range will be included.

The articles contained using this route are limited to the 50 max articles returned with a single request.

Example:

https://www.domain.com/api/v1/articles/taxonomy/42

https://www.domain.com/api/v1/articles/taxonomy/42,235,654

4. Route: Publication/Publication Edition

Purpose:

Pull all of the articles / blog posts associated with a specific newsletter issue or publication edition.

This would not be comma delimited.

Only a single issue or edition would be returned.

Example:

https://www.domain.com/api/v1/articles/publication-edition/63

5. Route: Newsletter/Newsletter Issue

Purpose:

Pull all of the articles / blog posts associated with a specific newsletter issue or publication edition.

This would not be comma delimited.

Only a single issue or edition would be returned.

Example:

https://www.domain.com/api/v1/articles/newsletter-issue/45