public interface Scene7APIClient
Modifier and Type | Field and Description |
---|---|
static String |
CONTENTTYPE
default content-type (i.e.
|
static int |
RECORDS_PER_PAGE_NO_FILTER |
static int |
RECORDS_PER_PAGE_WITH_FILTER |
Modifier and Type | Method and Description |
---|---|
Document |
deleteAsset(String assetHandle,
S7Config s7Config)
Deletes an asset from Scene7.
|
Document |
deleteFolder(String folderHandle,
S7Config s7Config)
Deletes a folder from Scene7.
|
Document |
getActiveJobs(String jobHandle,
String originalName,
S7Config s7Config)
Gets all jobs that are currently active in the system.
|
Document |
getAssets(String[] assetHandles,
String[] responseFields,
String[] excludeFields,
S7Config s7Config)
Gets assets from IPS.
|
Document |
getAssociatedAssets(String assetHandle,
String[] responseFields,
String[] excludeFields,
S7Config s7Config)
Gets assets associated with the specified asset and details about their relationship.
|
Document |
getCompanyMembership(ResourceResolver resourceResolver,
String userHandle,
String email,
String password,
String region)
Gets a user's memberships.
|
Document |
getFolderTree(String folderPath,
int depth,
String[] responseFields,
String[] excludeFields,
S7Config s7Config)
Gets folders and sub-folders in a hierarchical tree structure.
|
Document |
getImagePresets(S7Config s7Config)
Gets the SPS image presets
|
InputStream |
getIPSFile(Scene7Asset asset,
S7Config s7Config)
Provides a way to get the published image for a Scene7 asset
|
Document |
getJobLogDetails(String jobHandle,
String originalName,
S7Config s7Config)
Gets the details of job logs of a company.
|
InputStream |
getOriginalFile(String assetHandle,
S7Config s7Config)
Provides a way to get the originally uploaded file to the Scene7 servers after an asset has been processed.
|
Document |
getPropertySets(String appSettingsTypeHandle,
S7Config s7Config)
Gets property sets associated with a type handle.
|
Document |
getPropertySetTypes(S7Config s7Config)
Gets the property set types associated with the specified company from the
S7Config object. |
Document |
getSystemProperties(S7Config s7Config)
Retrieves the system properties XML document served by the GetSystemProperties SPS servlet.
|
InputStream |
getThumbnailForAsset(Scene7Asset scene7Asset,
S7Config s7Config)
Retrieves a JPEG image in an InputStream that can be used as a thumbnail in CQ DAM.
|
Document |
getUserInfo(ResourceResolver resourceResolver,
String email,
String password,
String region)
Gets information about a user.
|
Document |
searchAssets(String folder,
Boolean includeSubfolders,
Boolean published,
String[] assetTypes,
String[] assetSubTypes,
String[] responseFields,
String[] excludeFields,
int recordsPerPage,
int resultsPage,
S7Config s7Config)
Searches for assets based on one or more filter criteria.
|
Document |
searchAssetsByMetadata(String folder,
Boolean includeSubfolders,
String[] assetTypes,
String[] assetSubTypes,
Boolean published,
MetadataCondition[] conditions,
int recordsPerPage,
int resultsPage,
S7Config s7Config)
Searches the metadata index repository for the given search terms, support loading assets by page
|
Document |
searchAssetsByMetadata(String folder,
Boolean includeSubfolders,
String[] assetTypes,
String[] assetSubTypes,
Boolean published,
MetadataCondition[] conditions,
S7Config s7Config)
Searches the metadata index repository for the given search terms.
|
Document |
setAssetPublishState(String assetHandle,
S7Config s7Config,
String publishState)
Sets the publish state of a given Scene7 asset
|
Document |
submitJob(String jobName,
Scene7JobType jobType,
S7Config s7Config)
Submits a job to the system.
|
static final String CONTENTTYPE
static final int RECORDS_PER_PAGE_NO_FILTER
static final int RECORDS_PER_PAGE_WITH_FILTER
Document deleteAsset(String assetHandle, S7Config s7Config)
assetHandle
- the handle to the asset to deletes7Config
- the Scene7 configurationDocument
Document deleteFolder(String folderHandle, S7Config s7Config)
folderHandle
- the handle to the folder to deletes7Config
- the Scene7 configurationDocument
Document getActiveJobs(String jobHandle, String originalName, S7Config s7Config)
jobHandle
- the handle to the joboriginalName
- the original name of the jobs7Config
- the Scene7 configurationDocument
Document getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config)
assetHandles
- the asset handlesresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responses7Config
- the Scene7 configurationDocument
Document getAssociatedAssets(String assetHandle, String[] responseFields, String[] excludeFields, S7Config s7Config)
assetHandle
- the handle to the assetresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responses7Config
- the Scene7 configurationDocument
Document getCompanyMembership(ResourceResolver resourceResolver, String userHandle, String email, String password, String region)
resourceResolver
- resource resolver used to access Scene7 configurationuserHandle
- the handle to the user whose memberships you want to obtainemail
- the user's emailpassword
- the user's passwordregion
- the user's regionDocument
Document getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config)
folderPath
- the root folder to retrieve folders and all subfolders to the leaflevel; if excluded, the company root is useddepth
- a value of zero gets the top-level folder; any other value specifies the depth to descend into the treeresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responses7Config
- the Scene7 configurationDocument
Document getJobLogDetails(String jobHandle, String originalName, S7Config s7Config)
jobHandle
- a handle to an active or completed joboriginalName
- the original name of the job logs7Config
- the Scene7 configurationDocument
Document getPropertySets(String appSettingsTypeHandle, S7Config s7Config)
appSettingsTypeHandle
- the handle to the property set types7Config
- the Scene7 configurationDocument
Document getPropertySetTypes(S7Config s7Config)
S7Config
object.s7Config
- the Scene7 configurationDocument
Document getImagePresets(S7Config s7Config)
s7Config
- the Scene7 configurationDocument
Document getUserInfo(ResourceResolver resourceResolver, String email, String password, String region)
resourceResolver
- resource resolver used to access Scene7 configurationemail
- the user's emailpassword
- the user's passwordregion
- the user's regionDocument
Document searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, int recordsPerPage, int resultsPage, S7Config s7Config)
folder
- the root path for searching for assets; if omitted, the company root folder will be usedincludeSubfolders
- if true, the search includes sub-folderspublished
- if true, the search will include only published assetsassetTypes
- array of Asset Types to include in searchassetSubTypes
- array of sub Asset Types to include in searchresponseFields
- a list of fields and subfields for inclusion in the responseexcludeFields
- a list of fields and subfields for exclusion from the responserecordsPerPage
- maximum number of results to returnresultsPage
- specifies the page of results to return, based on recordsPerPage
page sizes7Config
- the Scene7 configurationDocument
Document searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, S7Config s7Config)
folder
- the root path for searching for assets; if omitted, the company root folder will be usedincludeSubfolders
- if true, the search includes sub-foldersassetTypes
- array of Asset Types to include in searchassetSubTypes
- array of sub Asset Types to include in searchpublished
- if true, the search will include only published assetsconditions
- one or more query conditions that define the search criterias7Config
- the Scene7 configurationDocument
Document searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, int recordsPerPage, int resultsPage, S7Config s7Config)
folder
- the root path for searching for assets; if omitted, the company root folder will be usedincludeSubfolders
- if true, the search includes sub-foldersassetTypes
- array of Asset Types to include in searchassetSubTypes
- array of sub Asset Types to include in searchpublished
- if true, the search will include only published assetsconditions
- one or more query conditions that define the search criteriarecordsPerPage
- maximum number of results to returnresultsPage
- specifies the page of results to return, based on recordsPerPage
page sizes7Config
- the Scene7 configurationDocument
Document submitJob(String jobName, Scene7JobType jobType, S7Config s7Config)
jobName
- the name of the jobjobType
- the job's types7Config
- the Scene7 configurationDocument
Scene7JobType
Document getSystemProperties(S7Config s7Config)
s7Config
- Document
InputStream getOriginalFile(String assetHandle, S7Config s7Config)
assetHandle
- the asset's handle (unique id generated by Scene7)s7Config
- the Scene7 configurationInputStream getIPSFile(Scene7Asset asset, S7Config s7Config)
asset
- the Scene7Asset
asset objects7Config
- the S7Config
configurationInputStream
of the published image assetInputStream getThumbnailForAsset(Scene7Asset scene7Asset, S7Config s7Config)
scene7Asset
- the Scene7 asset abstractizations7Config
- the Scene7 configuration"Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"