Package com.oracle.content.sdk.request.core

Interface RestApiInterfaceV1

public interface RestApiInterfaceV1

The interface used for defining the retrofit endpoints for all SDK REST API calls. - V1.1

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DIGITAL_ASSET_PATH

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<com.google.gson.JsonElement>	getApiInfo()	REST call to get API info.
retrofit2.Call<com.google.gson.JsonElement>	getContentItem(String ID, String links, String expand, String cacheControl)	REST call to get content item from delivery SDK.
retrofit2.Call<com.google.gson.JsonElement>	getContentItemBySlug(String slugId, String links, String expand, String cacheControl)	REST call to get content item from delivery SDK using a "slug".
retrofit2.Call<com.google.gson.JsonElement>	getItemLanguageVariations(String ID, String links)	REST call to get item language variations from delivery SDK.
retrofit2.Call<com.google.gson.JsonElement>	getItemLanguageVariationsBySlug(String slugId, String links)	REST call to get item language variations from delivery SDK.
retrofit2.Call<com.google.gson.JsonElement>	getPublishChannels(String fields, String links, Integer limit, Integer offset, Boolean totalResults)
retrofit2.Call<com.google.gson.JsonElement>	getTaxonomies(String expand, String links, Integer limit, Integer offset, Boolean totalResults)
retrofit2.Call<com.google.gson.JsonElement>	getTaxonomyCategories(String ID, String expand, String links, Integer limit, Integer offset, Boolean totalResults)
retrofit2.Call<com.google.gson.JsonElement>	searchBySCIMQuery(String query, String fields, String links, String defaultQuery, Integer limit, Integer offset, String orderBy, Boolean totalResults, String cacheControl)	REST call to search for content item based on a SCIM query string.

Field Details

DIGITAL_ASSET_PATH

static final String DIGITAL_ASSET_PATH

See Also:

• Constant Field Values

Method Details

getContentItem

@GET("content/published/api/v1.1/items/{ID}")
retrofit2.Call<com.google.gson.JsonElement> getContentItem(@Path("ID")
 String ID,
 @Query("links")
 String links,
 @Query("expand")
 String expand,
 @Header("Cache-Control")
 String cacheControl)

REST call to get content item from delivery SDK.

Parameters:

ID - Id of the content item.

links - links value (comma-delimited list)

expand - String value of expand parameter (e.g. "expand=all")

cacheControl - Override cache-control heading

Returns:

retrofit call object

getContentItemBySlug

@GET("content/published/api/v1.1/items/.by.slug/{slugId}")
retrofit2.Call<com.google.gson.JsonElement> getContentItemBySlug(@Path("slugId")
 String slugId,
 @Query("links")
 String links,
 @Query("expand")
 String expand,
 @Header("Cache-Control")
 String cacheControl)

REST call to get content item from delivery SDK using a "slug".

Parameters:

slugId - slug id of the content item.

links - links value (comma-delimited list)

expand - String value of expand parameter (e.g. "expand=all")

cacheControl - Override cache-control heading

Returns:

retrofit call object

getItemLanguageVariations

@GET("content/published/api/v1.1/items/{ID}/variations/language")
retrofit2.Call<com.google.gson.JsonElement> getItemLanguageVariations(@Path("ID")
 String ID,
 @Query("links")
 String links)

REST call to get item language variations from delivery SDK.

Parameters:

ID - Id of the content item.

links - links value (comma-delimited list)

Returns:

retrofit call object

getItemLanguageVariationsBySlug

@GET("content/published/api/v1.1/items/.by.slug/{slugId}/variations/language")
retrofit2.Call<com.google.gson.JsonElement> getItemLanguageVariationsBySlug(@Path("slugId")
 String slugId,
 @Query("links")
 String links)

REST call to get item language variations from delivery SDK.

Parameters:

slugId - slug id of the content item.

links - links value (comma-delimited list)

Returns:

retrofit call object

searchBySCIMQuery

@GET("content/published/api/v1.1/items")
retrofit2.Call<com.google.gson.JsonElement> searchBySCIMQuery(@Query("q")
 String query,
 @Query("fields")
 String fields,
 @Query("links")
 String links,
 @Query("default")
 String defaultQuery,
 @Query("limit")
 Integer limit,
 @Query("offset")
 Integer offset,
 @Query("orderBy")
 String orderBy,
 @Query("totalResults")
 Boolean totalResults,
 @Header("Cache-Control")
 String cacheControl)

REST call to search for content item based on a SCIM query string.

Parameters:

query - query string (e.g. "type cq 'mytype'")

fields - specific fields to retrieve

links - links value (comma-delimited list)

defaultQuery - default query string

limit - maximum number of items to request

offset - offset to start getting items from

orderBy - field to order results by

totalResults - true to get the total count of items

cacheControl - Override cache-control heading

Returns:

retrofit call object

getTaxonomies

@GET("/content/published/api/v1.1/taxonomies")
retrofit2.Call<com.google.gson.JsonElement> getTaxonomies(@Query("expand")
 String expand,
 @Query("links")
 String links,
 @Query("limit")
 Integer limit,
 @Query("offset")
 Integer offset,
 @Query("totalResults")
 Boolean totalResults)

getTaxonomyCategories

@GET("/content/published/api/v1.1/taxonomies/{ID}/categories")
retrofit2.Call<com.google.gson.JsonElement> getTaxonomyCategories(@Path("ID")
 String ID,
 @Query("expand")
 String expand,
 @Query("links")
 String links,
 @Query("limit")
 Integer limit,
 @Query("offset")
 Integer offset,
 @Query("totalResults")
 Boolean totalResults)

getApiInfo

@GET("content/published/api/v1.1")
retrofit2.Call<com.google.gson.JsonElement> getApiInfo()

REST call to get API info.

Returns:

retrofit call object

getPublishChannels

@Headers("X-Requested-With: XMLHttpRequest")
@GET("/content/management/api/v1.1/channels")
retrofit2.Call<com.google.gson.JsonElement> getPublishChannels(@Query("fields")
 String fields,
 @Query("links")
 String links,
 @Query("limit")
 Integer limit,
 @Query("offset")
 Integer offset,
 @Query("totalResults")
 Boolean totalResults)

• About Oracle
• Contact Us
• Legal Notices
• Terms of Use
• Your Privacy Rights
• Cookie Preferences
• Ad Choices