setAssetPublishState
Last update: July 20, 2021
CREATED FOR:
- Developer
- Admin
Determines if an asset is ready to be published.
Syntax
Authorized User Types
IpsUser
IpsAdmin
IpsCompanyAdmin
ImagePortalContrib
ImagePortalContribUser
The user must have read and write access to the asset.
Parameters
Input (setAssetPublishStateParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string | Yes | The handle to the company. |
assetHandle | xsd:string | Yes | Asset handle. |
publishState | xsd:string | Yes |
Available states:
|
contextHandleArray | Code Phrase |
Output
The IPS API does not return a response for this operation.
Examples
This code sample sets the publication state of an asset using NotMarkedForPublish
.
Request
<setAssetPublishStateParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>47</companyHandle>
<assetHandle>24267|1|17063</assetHandle>
<publishState>NotMarkedForPublish</publishState>
</setAssetPublishStateParam>
Response
None.
Experience Manager
- About Dynamic Media Image Production System API
- Deprecated calls
- IPS Web Service WSDL versions
- Operation methods
- Operations methods
- Operation parameters
- Operation parameters overview
- addCompany
- addCompanyMembership
- addGroupMembers
- addGroupMembership
- addProjectAssets
- addTagFieldValues
- addUser
- batchGetAssetPublishContexts
- batchSetAssetMetadata
- batchSetFontFields
- batchSetIccProfileFields
- batchSetImageFields
- batchSetThumbAsset
- cdnCacheInvalidation
- checkAssetNames
- checkLogin
- copyImage
- createAssetSet
- createDerivedAsset
- createFolder
- createImageSet
- createMetadataField
- createProject
- createPropertySet
- createPropertySetType
- createTemplate
- createViewerPreset
- createVignettePublishFormat
- deleteAsset
- deleteAssets
- deleteAssetMetadata
- deleteFolder
- deleteGroup
- deleteImageFormat
- deleteImageMap
- deleteJob
- deleteMetadataField
- deleteProject
- deletePropertySet
- deletePropertySetType
- deleteTagFieldValues
- deleteVignettePublishFormat
- deleteZoomTarget
- emptyAssetsFromTrash
- executeJob
- forceRepublishAssets
- generatePassword
- getActiveJobs
- getActivePublishContext
- getAllCompanies
- getAllUsers
- getAssetCounts
- getAssetJobLogs
- getAssetMetadataFields
- getAssetPublishHistory
- getAssets
- getAssetsByName
- getAssociatedAssets
- getAutoCropRect
- getCompanyInfo
- getCompanyMembers
- getCompanyMembership
- getCompanySettings
- getDiskUsage
- getDistinctMetadataValues
- getFolders
- getFolderTree
- getGenerationInfo
- getGroupMembers
- getGroupMembership
- getGroups
- getImageFormats
- getImageRenderingPublishSettings
- getImageServingPublishSettings
- getImageSetMembers
- getJobLogs
- getJobLogDetails
- getMetadataFields
- getOriginalFilePaths
- getPhotoshopPath
- getPhotoshopPathNames
- getProjects
- getProperty
- getPropertySets
- getPropertySetType
- getPropertySetTypes
- getPublishContexts
- getScheduledJobs
- getSearchStrings
- getSystemProperties
- getTagFieldValues
- getUniqueMetadataValues
- getUserChars
- getUserInfo
- getUsers
- getViewerConfigSettings
- getVignettePublishFormats
- getXMPPacket
- getZipEntries
- moveAsset
- moveAssets
- moveFolder
- pauseJob
- removeAssetPermissions
- removeCompanyMembership
- removeFolderPermissions
- removeGroupMembers
- removeGroupMembership
- removeProjectAssets
- renameAsset
- renameFolder
- renameProject
- replaceImage
- restoreAssetsFromTrash
- resumeJob
- saveGroup
- saveImageFormat
- saveImageMap
- saveMetadataField
- saveZoomTarget
- searchAssets
- searchAssetsByMetadata
- setAssetsContextState
- setAssetMetadata
- setAssetPermissions
- setAssetPublishState
- setAssetsPublishState
- setAssetSetDefinition
- setCompanyMembership
- setCompanySettings
- setFolderPermissions
- setGroupMembers
- setGroupMembership
- setImageMaps
- setImageSetMembers
- setImageRenderingPublishSettings
- setImageServingPublishSettings
- setPassword
- setProjectAssets
- setTagFieldValues
- setUrlModifier
- setUserInfo
- setViewerConfigSettings
- setZoomTargets
- stopJob
- submitJob
- updateAssetPermissons
- updateAssetSet
- updateFolderPermissions
- updateImageSet
- updateMetadataField
- updatePropertySet
- updateTagFieldValues
- updateViewerConfigSettings
- updateVignettePublishFormat
- updateXMPPacket
- Data types
- Data types
- AcoInfo
- ActiveJob
- ActiveJobArray
- AnimatedGifInfo
- Asset
- AssetArray
- AssetContextStateUpdate
- AssetContextStateUpdateArray
- AssetCount
- AssetCountArray
- AssetJobLog
- AssetJobLogArray
- AssetMetadataFields
- AssetMetadataFieldsArray
- AssetMove
- AssetMoveArray
- AssetOperationFault
- AssetOperationFaultArray
- AssetPublishContexts
- AssetPublishContextArray
- AssetSetInfo
- AssetSummary
- AssetSummaryArray
- AudioInfo
- AutoColorCropOptions
- AutomatedSetGenerationJob
- AutoSetCreationOptions
- AutoTransparentCropOptions
- BatchMetadataUpdate
- BatchMetadataUpdateArray
- CabinetInfo
- ColorManagementOptions
- Company
- CompanyArray
- CompanyMember
- CompanyMemberArray
- CompanyMembership
- CompanyMembershipArray
- CompanyMembershipUpdate
- CompanyMembershipUpdateArray
- CompanyMetadataInfo
- CompanyMetadataInfoArray
- CompanySettings
- ConfigSetting
- ConfigSettingArray
- ContextStateUpdate
- ContextStateUpdateArray
- CreateVideoSitemapJob
- CssInfo
- CuePointInfo
- DiskUsage
- DiskUsageArray
- EmailConfirmation
- EmailArray
- ExcludeByproductArray
- ExcludeByproductCondition
- ExcelInfo
- ExportJob
- FlashInfo
- Folder
- FolderArray
- FontFieldUpdate
- FontFieldUpdateArray
- FontInfo
- GenerationAttribute
- GenerationAttributeArray
- GenerationInfo
- GenerationInfoArray
- Group
- GroupArray
- HandleArray
- IccProfileFieldUpdate
- IccProfileFieldUpdateArray
- IccProfileInfo
- IllustratorInfo
- IllustratorOptions
- ImageFieldUpdate
- ImageFieldUpdateArray
- ImageFormat
- ImageFormatArray
- ImageInfo
- ImageMap
- ImageMapArray
- ImageMapDefinition
- ImageMapDefinitionArray
- ImageRenderingPublishJob
- ImageServingPublishJob
- ImageSetMember
- ImageSetMemberArray
- ImageSetMemberUpdate
- ImageSetMemberUpdateArray
- InDesignInfo
- JavascriptInfo
- JobLog
- JobLogArray
- JobLogDetail
- JobLogDetailArray
- JobLogDetailAux
- JobLogDetailAuxArray
- Keywords
- KeywordsArray
- KnockoutBackgroundOptions
- LayerViewInfo
- ManualCropOptions
- Mask
- MaskArray
- MaskInfo
- MasterVideoInfo
- MediaOptions
- Metadata
- MetadataArray
- MetadataCondition
- MetadataConditionArray
- MetadataDelete
- MetadataDeleteArray
- MetadataField
- MetadataFieldArray
- MetadataPublishJobType
- MetadataUpdate
- MetadataUpdateArray
- MPEvent
- MPEventArray
- OperationFault
- OperationFaultArray
- OptimizeImagesJob
- PdfInfo
- PDFOptions
- PdfSettingsInfo
- Permission
- PermissionArray
- PermissonSet
- PermissionSetArray
- PermissionUpdate
- PermissionUpdateArray
- PerspectiveQuad
- PhotoshopOptions
- PhotoshopLayerOptions
- PostScriptInfo
- PostScriptOptions
- PowerPointInfo
- PremierExpressRemixInfo
- Project
- ProjectArray
- Property
- PropertyArray
- PropertySet
- PropertySetArray
- PropertySetType
- PropertySetTypeArray
- PsdInfo
- PublishContext
- PublishContextArray
- PublishHistory
- PublishHistoryArray
- PublishStateUpdate
- PublishStateUpdateArray
- RenderSceneInfo
- ReprocessAssetsJob
- RipPdfsJob
- RTFInfo
- ScheduledJob
- ScheduledJobArray
- SearchFilter
- SearchStrings
- SearchStringsArray
- ServerDirectoryPublishJob
- SetMetadataFault
- SetMetadataFaultArray
- SetPropertySetPermissions
- SvgInfo
- StringArray
- SwcInfo
- SystemFieldCondition
- SystemFieldConditionArray
- TagCondition
- TagConditionArray
- TagFieldValues
- TagFieldValuesArray
- TagValueUpdate
- TagValueUpdateArray
- TagValueUpdateFault
- TagValueUpdateFaultArray
- TaskItemProgress
- TaskItemProgressArray
- TaskProgress
- TaskProgressArray
- TemplateInfo
- ThumbAssetUpdate
- ThumbAssetUpdateArray
- ThumbnailOptions
- UnCompressOptions
- UnsharpMaskOptions
- UploadDirectoryJob
- UploadPostJob
- UploadUrl
- UploadUrlArray
- UploadUrlsJob
- UrlArray
- User
- UserArray
- VideoCaptionInfo
- VideoInfo
- VideoPublishJob
- ViewerPresetInfo
- ViewerSwfInfo
- VignetteInfo
- WatermarkInfo
- WindowCoveringInfo
- WordInfo
- XmlInfo
- XmpKeywords
- XslInfo
- ZipEntry
- ZipEntryArray
- ZipInfo
- ZoomTarget
- ZoomTargetArray
- ZoomTargetDefinition
- ZoomTargetDefinitionArray
- String constants
- String constants
- Active Job States
- Asset Search System Fields
- Asset Overwrite Modes
- Asset Sort Fields
- Asset Types
- AutoCrop Corner
- Color Management Modes
- Color Spaces
- Email Settings
- Font Styles
- Font Types
- Generation Info
- Illustrator Processes
- Job Log File Types
- Job Log Sort Fields
- Job Log Types
- Job Trigger States
- Job Types
- Metadata Field Types
- Numeric/Date Comparison Operators
- PDF Processes
- Permission Types
- Photoshop Anchor Modes
- Photoshop Layer Naming Modes
- PostScript Colorspace Modes
- Profile Classes
- Publish State
- Property Set Types
- Publish Context
- Publish Types
- Region Shape
- Search Match Modes
- Sort Directions
- String Comparison Operators
- Trash State
- User Char Filter Fields
- User Roles
- User Sort Fields
- Viewer Type
- Faults
- Change log
- Uploading assets by way of HTTP POSTs to the UploadFile…