RErecombee
Series

Insert to Series

Inserts an existing item/series into a series of the given seriesId at a position determined by time.

post/{databaseId}/series/{seriesId}/items/

Request

  • Base URL
    http://Based on the region of your database (see https://docs.recombee.com/regions).
  • URL
    http://Based on the region of your database (see https://docs.recombee.com/regions)./{databaseId}/series/{seriesId}/items/
  • Auth
    none declared

Path parameters

databaseIdstring required

ID of your database.

seriesIdstring required

ID of the series to be inserted into.

Request body

itemTypestring required

item iff the regular item from the catalog is to be inserted, series iff series is inserted as the item.

itemIdstring required

ID of the item iff itemType is item. ID of the series iff itemType is series.

timenumber double required

Time index used for sorting items in the series. According to time, items are sorted within series in ascending order. In the example of TV show episodes, the episode number is a natural choice to be passed as time.

cascadeCreateboolean

Indicates that any non-existing entity specified within the request should be created (as if corresponding PUT requests were invoked). This concerns both the seriesId and the itemId. If cascadeCreate is set to true, the behavior also depends on the itemType. In case of item, an item is created, in case of series a series + corresponding item with the same ID is created.

Response

Successful operation.

Changes

No recorded changes to this operation across all 3 revisions of this API.