@ProviderType 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 |
addUser(S7Config s7Config,
String firstName,
String lastName,
String email,
String defaultRole,
String password,
@Nullable Instant passwordExpires,
boolean isValid,
List<Scene7CompanyMembership> membershipArray)
Creates a user account and adds the account to one of more companies
|
Document |
batchSetAssetMetadata(S7Config s7Config,
List<Scene7MetadataUpdate> updates)
Sets asset metadata using batch mode.
|
Document |
batchSetImageFields(S7Config s7Config,
List<Scene7ImageFieldUpdate> updates)
Sets asset metadata using batch mode.
|
Document |
batchSetThumbAsset(S7Config s7Config,
List<ThumbAssetUpdate> thumbnailUpdates)
Sets the thumbnail image for one or more assets
|
Document |
createAssetSet(S7Config s7Config,
String folderHandle,
String name,
String type,
@Nullable String setDefinition,
@Nullable String thumbAssetHandle)
Create an AssetSet in a given Scene7 folder
|
Document |
createFolder(String folderPath,
S7Config s7Config)
Create a folder on Scene7 server
|
Document |
createImageSet(S7Config s7Config,
String folderHandle,
String name,
String type,
@Nullable String thumbAssetHandle)
Create an ImageSet in a given Scene7 folder
|
Document |
createViewerPreset(S7Config s7Config,
String folderHandle,
String name,
String type,
@Nullable List<Scene7ConfigSetting> configSettings)
Create a preset view to determine what users can see.
|
Document |
deleteAsset(String assetHandle,
S7Config s7Config)
Deletes an asset from Scene7.
|
Document |
deleteAssets(String[] assetHandleArr,
S7Config s7Config)
Delete multiple assets from Scene7.
|
Document |
deleteFolder(String folderHandle,
S7Config s7Config)
Deletes a folder from Scene7.
|
Document |
deleteImageFormat(S7Config s7Config,
String imageFormatHandle)
Deletes an image format.
|
Document |
deleteImageMap(S7Config s7Config,
String imageMapHandle)
Deletes an image map
|
Document |
getActiveJobs(String jobHandle,
String originalName,
S7Config s7Config)
Gets all jobs that are currently active in the system.
|
Document |
getAllUsers(@NotNull S7Config s7Config,
boolean includeInvalid)
Return all users
|
@Nullable String |
getAssetHandleByName(S7Config s7Config,
String assetName)
Search asset by name and return its handle, if exists.
|
String |
getAssetHandleByName(String assetName)
Gets assethandle
|
Document |
getAssets(String[] assetHandles,
String[] responseFields,
String[] excludeFields,
S7Config s7Config)
Gets assets from IPS.
|
List<Scene7Asset> |
getAssetsByName(String companyHandle,
String[] responseFields,
String[] names)
Gets assets by name.
|
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 |
getImageFormats(@NotNull S7Config s7Config)
Returns image formats, such as PDF, EPS, SWF, and others.
|
Document |
getImagePresets(S7Config s7Config)
Gets the SPS image presets
|
InputStream |
getIPSFile(Scene7Asset asset,
S7Config s7Config)
Deprecated.
Incompatible with Scene7 IPS SSL endpoint. Please use
getOriginalFile() instead.
|
Document |
getJobLogDetails(String jobHandle,
String originalName,
int resultsPage,
int recordsPerPage,
String sortBy,
String sortDirection,
S7Config s7Config)
Gets the details of job logs of a company with specified parameters
|
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)
Deprecated.
|
InputStream |
getThumbnailForAsset(Scene7Asset scene7Asset,
S7Config s7Config)
Retrieves a JPEG image in an InputStream that can be used as a thumbnail
in CQ DAM.
|
Document |
getUploadTaskStatus(String jobHandle,
S7Config s7Config)
Retrieves Scene7 upload job processing status
|
Document |
getUserInfo(ResourceResolver resourceResolver,
String email,
String password,
String region)
Gets information about a user.
|
Document |
getUsers(@NotNull S7Config s7Config,
@Nullable Boolean includeInactive,
@Nullable Boolean includeInvalid,
@Nullable List<String> companyHandleArray,
@Nullable List<String> groupHandleArray,
@Nullable List<String> userRoleArray,
@Nullable String charFilterField,
@Nullable String charFilter,
@Nullable String sortBy,
@Nullable Integer recordsPerPage,
@Nullable Integer resultsPage)
Return a optionally sorted, filtered and paged list user results
|
Document |
getViewerConfigSettings(S7Config s7Config,
String assetHandle)
Get all viewer configuration for the specified asset
|
Document |
getXMPPacket(S7Config s7Config,
String assetHandle)
Retrieves an XMP Metadata packet for the specified asset.
|
Document |
moveAsset(S7Config s7Config,
String assetHandle,
String folderHandle)
Moves an asset to a specific folder
|
Document |
moveAssets(S7Config s7Config,
Map<String,String> assetFolderHandles)
Moves multiple assets independently of each other.
|
Document |
moveFolder(S7Config s7Config,
String sourceFolderHandle,
String destinationFolderHandle)
Move a folder to a new location
|
Document |
renameAsset(S7Config s7Config,
String assetHandle,
String name,
boolean validateName)
Rename an asset
|
String |
renameAssetToUniqueName(S7Config s7Config,
String assetHandle,
String newDesiredName)
Tries to rename given asset to the new name, maintaining the requirement of
no duplicate asset names can exists in S7 for a given Company.
|
Document |
renameFolder(S7Config s7Config,
String folderHandle,
String folderName)
Rename a folder
|
Document |
saveImageFormat(S7Config s7Config,
@Nullable String imageFormatHandle,
String name,
String urlModifier)
Create an image format.
|
Document |
saveImageMap(S7Config s7Config,
String assetHandle,
@Nullable String imageMapHandle,
String name,
String shapeType,
String region,
String action,
int position,
boolean enabled)
Create a new image map or edit an existing map
|
Document |
searchAssets(String folder,
Boolean includeSubfolders,
Boolean published,
String[] assetTypes,
String[] assetSubTypes,
String[] responseFields,
String[] excludeFields,
int recordsPerPage,
int resultsPage,
String fileName,
String name,
S7Config s7Config)
Searches for assets based on one or more filter criteria.
|
Document |
searchAssets(String folder,
Boolean includeSubfolders,
Boolean published,
String[] assetTypes,
String[] assetSubTypes,
String[] responseFields,
String[] excludeFields,
int recordsPerPage,
int resultsPage,
String fileName,
String name,
String conditionMode,
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 |
setAssetsPublishState(Set<String> assetHandles,
S7Config s7Config,
String publishState)
Sets the publish state of a given Scene7 assets
|
Document |
setImageMaps(S7Config s7Config,
String assetHandle,
List<Scene7ImageMapDefinition> imageMap)
Sets the image map for an asset.
|
Document |
setUserInfo(S7Config s7Config,
@Nullable String userHandle,
String firstName,
String lastName,
String email,
String defaultRole,
@Nullable Instant passwordExpires,
boolean isValid,
List<Scene7CompanyMembership> membershipArray)
Set user attributes
|
Document |
setViewerConfigSettings(S7Config s7Config,
String assetHandle,
String name,
String type,
List<Scene7ConfigSetting> configSettings)
Attach viewer configuration settings to an asset
Can be viewer preset or the source asset for the viewer
|
Document |
submitJob(String jobName,
Scene7JobType jobType,
S7Config s7Config)
Submits a job to the system.
|
Document |
submitReprocessAssetsThumbnailJob(@NotNull String jobName,
@NotNull S7Config s7Config,
String assetHandle,
long thumbnailTime)
Submit a job to S7 for reprocessing video thumbnail to a specified video frame time
|
Document |
updateAssetSet(S7Config s7Config,
String assetHandle,
@Nullable String setDefinition,
@Nullable String thumbAssetHandle)
Update an AssetSet
|
Document |
updateImageSet(S7Config s7Config,
String assetHandle,
@Nullable ImageSetMemberUpdateArray members,
@Nullable String thumbAssetHandle)
Update an ImageSet
|
Document |
updateImageSet(S7Config s7Config,
String assetHandle,
List<String> setMemberHandles,
String thumbAssetHandle)
|
Document |
updateSmartCrops(S7Config s7Config,
SmartCropUpdateArray updateArray)
Update one or more Smart Crop sub asset(s)
|
Document |
updateViewerConfigSettings(S7Config s7Config,
String assetHandle,
List<Scene7ConfigSetting> configSettings)
Updates SWF viewer configuration settings.
|
Document |
updateXMPPacket(S7Config s7Config,
String assetHandle,
String xmpPacketAsXml)
Sets or updates an XMP metadata packet for an asset.
|
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) throws IpsApiException
assetHandle
- the handle to the asset to deletes7Config
- the Scene7 configurationDocument
IpsApiException
Document deleteAssets(String[] assetHandleArr, S7Config s7Config) throws IpsApiException
assetHandleArr
- the handle to the asset to deletes7Config
- the Scene7 configurationDocument
IpsApiException
Document deleteFolder(String folderHandle, S7Config s7Config) throws IpsApiException
folderHandle
- the handle to the folder to deletes7Config
- the Scene7 configurationDocument
IpsApiException
Document getActiveJobs(String jobHandle, String originalName, S7Config s7Config) throws IpsApiException
jobHandle
- the handle to the joboriginalName
- the original name of the jobs7Config
- the Scene7 configurationDocument
IpsApiException
Document getAssets(String[] assetHandles, String[] responseFields, String[] excludeFields, S7Config s7Config) throws IpsApiException
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
IpsApiException
Document getAssociatedAssets(String assetHandle, String[] responseFields, String[] excludeFields, S7Config s7Config) throws IpsApiException
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
IpsApiException
List<Scene7Asset> getAssetsByName(String companyHandle, String[] responseFields, String[] names) throws IpsApiException
companyHandle
- the handle to the companyresponseFields
- a list of fields and subfields for inclusion in the responsenames
- a string array of asset namesDocument
IpsApiException
String getAssetHandleByName(String assetName) throws IpsApiException
assetName
- a String array of asset namesIpsApiException
@Nullable @Nullable String getAssetHandleByName(S7Config s7Config, String assetName) throws IpsApiException
s7Config
- configuration to access Scene7 serverassetName
- asset name to look upIpsApiException
- on error at Scene7Document getCompanyMembership(ResourceResolver resourceResolver, String userHandle, String email, String password, String region) throws IpsApiException
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
IpsApiException
Document getFolderTree(String folderPath, int depth, String[] responseFields, String[] excludeFields, S7Config s7Config) throws IpsApiException
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
IpsApiException
Document getJobLogDetails(String jobHandle, String originalName, S7Config s7Config) throws IpsApiException
jobHandle
- a handle to an active or completed joboriginalName
- the original name of the job logs7Config
- the Scene7 configurationDocument
IpsApiException
Document getJobLogDetails(String jobHandle, String originalName, int resultsPage, int recordsPerPage, String sortBy, String sortDirection, S7Config s7Config) throws IpsApiException
jobHandle
- a handle to an active or completed joboriginalName
- the original name of the job logresultsPage
- page number of recordsPerPage-results to returnrecordsPerPage
- maximum number of detailArray items to returnsortBy
- one of the Job Detail Sort Field constant values (Date or
LogType)sortDirection
- one of the Sort Direction string constantss7Config
- the Scene7 configurationDocument
IpsApiException
Document getPropertySets(String appSettingsTypeHandle, S7Config s7Config) throws IpsApiException
appSettingsTypeHandle
- the handle to the property set types7Config
- the Scene7 configurationDocument
IpsApiException
Document getPropertySetTypes(S7Config s7Config) throws IpsApiException
S7Config
object.s7Config
- the Scene7 configurationDocument
IpsApiException
Document getImagePresets(S7Config s7Config) throws IpsApiException
s7Config
- the Scene7 configurationDocument
IpsApiException
Document getUserInfo(ResourceResolver resourceResolver, String email, String password, String region) throws IpsApiException
resourceResolver
- resource resolver used to access Scene7 configurationemail
- the user's emailpassword
- the user's passwordregion
- the user's regionDocument
IpsApiException
Document searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, int recordsPerPage, int resultsPage, String fileName, String name, S7Config s7Config) throws IpsApiException
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 sizefileName
- the filename for search assetname
- the Scene7 name used for search assets7Config
- the Scene7 configurationDocument
IpsApiException
Document searchAssets(String folder, Boolean includeSubfolders, Boolean published, String[] assetTypes, String[] assetSubTypes, String[] responseFields, String[] excludeFields, int recordsPerPage, int resultsPage, String fileName, String name, String conditionMode, S7Config s7Config) throws IpsApiException
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 sizefileName
- the filename for search assetname
- the Scene7 name used for search assetconditionMode
- filename and asset name string comparison operators7Config
- the Scene7 configurationDocument
IpsApiException
Document searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, S7Config s7Config) throws IpsApiException
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
IpsApiException
Document searchAssetsByMetadata(String folder, Boolean includeSubfolders, String[] assetTypes, String[] assetSubTypes, Boolean published, MetadataCondition[] conditions, int recordsPerPage, int resultsPage, S7Config s7Config) throws IpsApiException
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
IpsApiException
Document submitJob(String jobName, Scene7JobType jobType, S7Config s7Config) throws IpsApiException
jobName
- the name of the jobjobType
- the job's types7Config
- the Scene7 configurationDocument
IpsApiException
Scene7JobType
Document submitReprocessAssetsThumbnailJob(@NotNull @NotNull String jobName, @NotNull @NotNull S7Config s7Config, String assetHandle, long thumbnailTime) throws IpsApiException
jobName
- the name of the jobs7Config
- the Scene7 configurationassetHandle
- the asset handlethumbnailTime
- the frame timeDocument
IpsApiException
@Deprecated Document getSystemProperties(S7Config s7Config)
s7Config
- the Scene7 configurationDocument
InputStream getOriginalFile(String assetHandle, S7Config s7Config) throws IpsApiException
assetHandle
- the asset's handle (unique id generated by Scene7)s7Config
- the Scene7 configurationIpsApiException
@Deprecated InputStream getIPSFile(Scene7Asset asset, S7Config s7Config)
asset
- the Scene7Asset
asset objects7Config
- the S7Config
configurationInputStream
of the published image assetInputStream getThumbnailForAsset(Scene7Asset scene7Asset, S7Config s7Config) throws IpsApiException
scene7Asset
- the Scene7 asset abstractizations7Config
- the Scene7 configurationIpsApiException
Document setAssetPublishState(String assetHandle, S7Config s7Config, String publishState) throws IpsApiException
assetHandle
- the Scene7 asset handlepublishState
- the asset publish states7Config
- the Scene7 configurationDocument
IpsApiException
Document setAssetsPublishState(Set<String> assetHandles, S7Config s7Config, String publishState) throws IpsApiException
assetHandles
- the Scene7 asset handlespublishState
- the asset publish states7Config
- the Scene7 configurationDocument
IpsApiException
Document createImageSet(S7Config s7Config, String folderHandle, String name, String type, @Nullable @Nullable String thumbAssetHandle) throws IpsApiException
s7Config
- the Scene7 configurationfolderHandle
- Scene7 folder handlename
- name of image settype
- type of new image setthumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for
setDocument
IpsApiException
Document updateImageSet(S7Config s7Config, String assetHandle, @Nullable @Nullable ImageSetMemberUpdateArray members, @Nullable @Nullable String thumbAssetHandle) throws IpsApiException
s7Config
- the Scene7 configurationassetHandle
- asset handle of the image set to updatemembers
- (optional) list of imageset members (Null = not updated)thumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for
set (Null = not updated)Document
IpsApiException
@Deprecated Document updateImageSet(S7Config s7Config, String assetHandle, List<String> setMemberHandles, String thumbAssetHandle)
s7Config
- the Scene7 configurationassetHandle
- asset handle of the image set member arraysetMemberHandles
- list of image set member handlesthumbAssetHandle
- optional parameter to define set thumbnailDocument
Document createAssetSet(S7Config s7Config, String folderHandle, String name, String type, @Nullable @Nullable String setDefinition, @Nullable @Nullable String thumbAssetHandle) throws IpsApiException
s7Config
- the Scene7 configurationfolderHandle
- Scene7 folder handlename
- name for new asset settype
- type of new asset setsetDefinition
- (optional) set's definition stringthumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for
setDocument
IpsApiException
Document updateAssetSet(S7Config s7Config, String assetHandle, @Nullable @Nullable String setDefinition, @Nullable @Nullable String thumbAssetHandle) throws IpsApiException
s7Config
- the Scene7 configurationassetHandle
- asset handle of the asset set to updatesetDefinition
- (optional) set's definition string (Null = not updated)thumbAssetHandle
- (optional) asset handle of user-defined thumbnail image for
set (Null = not updated)Document
IpsApiException
Document createFolder(String folderPath, S7Config s7Config) throws IpsApiException
folderPath
- The root folder used to retrieve folders and all subfolders to
the leaf level. If excluded, the company root is used.s7Config
- the Scene7 configurationDocument
IpsApiException
Document createViewerPreset(S7Config s7Config, String folderHandle, String name, String type, @Nullable @Nullable List<Scene7ConfigSetting> configSettings) throws IpsApiException
s7Config
- the Scene7 configurationfolderHandle
- folder handle of the folder that contains the assetsname
- name for the viewertype
- type of any available viewer in IPSconfigSettings
- list containing Scene7ConfigSetting
values to applyDocument
IpsApiException
Document getViewerConfigSettings(S7Config s7Config, String assetHandle) throws IpsApiException
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset in questionDocument
IpsApiException
Document setViewerConfigSettings(S7Config s7Config, String assetHandle, String name, String type, List<Scene7ConfigSetting> configSettings) throws IpsApiException
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset to modifyname
- name of the assettype
- type of any available viewer in IPSconfigSettings
- list containing Scene7ConfigSetting
values to applyIpsApiException
Document updateViewerConfigSettings(S7Config s7Config, String assetHandle, List<Scene7ConfigSetting> configSettings) throws IpsApiException
s7Config
- the Scene7 configurationassetHandle
- asset handle for the asset to modifyconfigSettings
- list containing Scene7ConfigSetting
values to applyIpsApiException
Document addUser(S7Config s7Config, String firstName, String lastName, String email, String defaultRole, String password, @Nullable @Nullable Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray) throws IpsApiException
s7Config
- The Scene7 configurationfirstName
- The user's first namelastName
- The user's last nameemail
- The user's email addressdefaultRole
- The role for the user in the companies they belong, the
IpsAdmin role overrides other per-company settingspassword
- The user's passwordpasswordExpires
- The instant of expiration of the passwordisValid
- Determine the user's validitymembershipArray
- List of Scene7CompanyMembership
entries enumerating
the membership of the user.IpsApiException
Document getAllUsers(@NotNull @NotNull S7Config s7Config, boolean includeInvalid) throws IpsApiException
s7Config
- The Scene7 configurationincludeInvalid
- Indicate if invalid users should be includedIpsApiException
Document getUsers(@NotNull @NotNull S7Config s7Config, @Nullable @Nullable Boolean includeInactive, @Nullable @Nullable Boolean includeInvalid, @Nullable @Nullable List<String> companyHandleArray, @Nullable @Nullable List<String> groupHandleArray, @Nullable @Nullable List<String> userRoleArray, @Nullable @Nullable String charFilterField, @Nullable @Nullable String charFilter, @Nullable @Nullable String sortBy, @Nullable @Nullable Integer recordsPerPage, @Nullable @Nullable Integer resultsPage) throws IpsApiException
s7Config
- The Scene7 configincludeInactive
- Include or exclude inactive membersincludeInvalid
- Include or exclude invalid memberscompanyHandleArray
- Filter results be companygroupHandleArray
- Filter results by groupuserRoleArray
- Filter results by user rolecharFilterField
- Filter results by field's string prefixcharFilter
- Filter results by a specific charactersortBy
- Choice of user sort fieldrecordsPerPage
- Number of records per page to returnresultsPage
- The desired result pageIpsApiException
Document setUserInfo(S7Config s7Config, @Nullable @Nullable String userHandle, String firstName, String lastName, String email, String defaultRole, @Nullable @Nullable Instant passwordExpires, boolean isValid, List<Scene7CompanyMembership> membershipArray) throws IpsApiException
s7Config
- The Scene7 configuserHandle
- User handlefirstName
- First namelastName
- Last nameemail
- Email addressdefaultRole
- The role for the user in the companies they belong, the
IpsAdmin role overrides other per-company settingspasswordExpires
- The password's expirationisValid
- Determine if valid IPS usermembershipArray
- List of Scene7CompanyMembership
entries enumerating
the membership of the userIpsApiException
Document deleteImageFormat(S7Config s7Config, String imageFormatHandle) throws IpsApiException
s7Config
- The Scene7 configimageFormatHandle
- Handle to the image format. (This is returned from
saveImageFormat(S7Config, String, String, String)
)IpsApiException
Document getImageFormats(@NotNull @NotNull S7Config s7Config) throws IpsApiException
s7Config
- The Scene7 configIpsApiException
Document saveImageFormat(S7Config s7Config, @Nullable @Nullable String imageFormatHandle, String name, String urlModifier) throws IpsApiException
s7Config
- The Scene7 configimageFormatHandle
- Image format handle you want to savename
- Image format nameurlModifier
- IPS protocol query stringIpsApiException
Document deleteImageMap(S7Config s7Config, String imageMapHandle) throws IpsApiException
s7Config
- The Scene7 configimageMapHandle
- Handle for the image map to deleteIpsApiException
Document saveImageMap(S7Config s7Config, String assetHandle, @Nullable @Nullable String imageMapHandle, String name, String shapeType, String region, String action, int position, boolean enabled) throws IpsApiException
s7Config
- The Scene7 configassetHandle
- Handle to the asset the map belongs toimageMapHandle
- Handle to the image map.name
- Name of the image mapshapeType
- Choice of region shaperegion
- A comma delimited list of points that define the regionaction
- The href value associated with the image mapposition
- The order in the list of image mapsenabled
- Whether this map is enabledIpsApiException
Document setImageMaps(S7Config s7Config, String assetHandle, List<Scene7ImageMapDefinition> imageMap) throws IpsApiException
s7Config
- The Scene7 configassetHandle
- Handle to the assetimageMap
- list of predefined Scene7ImageMapDefinition
objectsIpsApiException
Document batchSetAssetMetadata(S7Config s7Config, List<Scene7MetadataUpdate> updates) throws IpsApiException
s7Config
- The Scene7 configupdates
- List of Scene7ImageFieldUpdate
to be appliedIpsApiException
Document batchSetImageFields(S7Config s7Config, List<Scene7ImageFieldUpdate> updates) throws IpsApiException
s7Config
- The Scene7 configupdates
- List of Scene7ImageFieldUpdate
to be appliedIpsApiException
Document getUploadTaskStatus(String jobHandle, S7Config s7Config) throws IpsApiException
jobHandle
- Scene7 upload job handles7Config
- Scene7 configuration objectDocument
IpsApiException
Document moveAsset(S7Config s7Config, String assetHandle, String folderHandle) throws IpsApiException
s7Config
- Scene7 configuration objectassetHandle
- Handle to the asset you want to movefolderHandle
- Handle to the destination folderDocument
IpsApiException
Document moveAssets(S7Config s7Config, Map<String,String> assetFolderHandles) throws IpsApiException
s7Config
- Scene7 configuration objectassetFolderHandles
- Map that contains an asset and an asset destination folderDocument
IpsApiException
Document moveFolder(S7Config s7Config, String sourceFolderHandle, String destinationFolderHandle) throws IpsApiException
s7Config
- Scene7 configuration objectsourceFolderHandle
- Handle to the source folderdestinationFolderHandle
- Handle to the destination folderDocument
IpsApiException
Document renameAsset(S7Config s7Config, String assetHandle, String name, boolean validateName) throws IpsApiException
s7Config
- Scene7 configuration objectassetHandle
- Handle to the asset you want to movename
- Asset's new namevalidateName
- If the validateName is true and the asset type requires a
unique IPS ID, then the new name is checked for global
uniqueness and renameAsset throws a fault if it is not unique.Document
IpsApiException
Document renameFolder(S7Config s7Config, String folderHandle, String folderName) throws IpsApiException
s7Config
- Scene7 configuration objectfolderHandle
- Handle to the folderfolderName
- New folder nameDocument
IpsApiException
String renameAssetToUniqueName(S7Config s7Config, String assetHandle, String newDesiredName) throws IpsApiException
s7Config
- configuration for access to Scene7 serverassetHandle
- asset handle (ID)newDesiredName
- new asset name, case-sensitiveIpsApiException
- on error at Scene7Document batchSetThumbAsset(S7Config s7Config, List<ThumbAssetUpdate> thumbnailUpdates) throws IpsApiException
s7Config
- Scene7 configuration objectthumbnailUpdates
- List of ThumbAssetUpdate
objects to be appliedDocument
IpsApiException
- in case of IPS failures or undefined data formatDocument updateSmartCrops(S7Config s7Config, SmartCropUpdateArray updateArray) throws IpsApiException
s7Config
- Scene7 configuration objectupdateArray
- Array of SmartCropUpdate objects containing subasset handles
and NormalizedCropRect valuesDocument
IpsApiException
Document getXMPPacket(S7Config s7Config, String assetHandle) throws IpsApiException
s7Config
- Scene7 configuration objectassetHandle
- Handle to the asset you want to get XMP metadataDocument
IpsApiException
- in case of IPS failures or undefined data formatDocument updateXMPPacket(S7Config s7Config, String assetHandle, String xmpPacketAsXml) throws IpsApiException
s7Config
- Scene7 configuration objectassetHandle
- Handle to the asset you want to update XMP metadataxmpPacketAsXml
- updated XMP packet to update asset metadata in XML formatDocument
IpsApiException
- in case of IPS failures or undefined data formatCopyright © 2010 - 2020 Adobe. All Rights Reserved