API Changelog

User

User

EmailAddress not required

EmailAddress can now be null

See the change in Contracts.Generated.cs

Share

ShareUser

EmailHash not required

EmailHash can now be null

See the change in Contracts.Generated.cs

Named Caches

SchemaTagboxFilterLookupNamedCacheConfiguration

SchemaTagboxFilterLookupNamedCacheConfigurationis deprecated

SchemaTagboxFilterLookupNamedCacheConfiguration and property NamedCache in AssignTagboxItemsInLayerAction have been marked as deprecated. Directly use the new SchemaId property on AssignTagboxItemsInLayerAction instead.

See related Contracts.Generated.cs

Outputs

Output, Output.RenderingState, Output.FileVersion and more

Upcoming changes in Outputs, Output.RenderingState is deprecated

Significant internal changes for Output handling and rendering are being implemented and will be released in an upcoming version. In this release, some of the contract changes have been prepared. While we strive to minimize breaking changes, they cannot be prevented in all cases.

• RenderingState and property Output.RenderingState have been marked as deprecated. Use the new RenderingStateV2 property on Output instead.

• RenderingState.Skipped will be removed since it is badly defined. Static Outputs with RenderingState.Skipped will no longer be returned, while dynamic Outputs which have not been rendered will instead use OutputRenderingStateV2.Renderable. This also applies to the faked "Original" Output for Content with ContentType.Virtual which is returned in some Share endpoints.

• Output.FileVersion will be removed. Output.Audit.CreationDate can be used to determine ordering of file replacements.

• Output.BackupTimestamp will be removed. No direct replacement is available since backup of binary Content is now handled on a lower level.

• OutputDataBase.FilePath will be removed. No direct replacement is available since this information is not useful for external users. No data has been available in this field for several releases.

• Outputs.Search endpoint will be removed. This only covered static OutputFormats, please use the Content endpoints instead to resolve Outputs of any kind.

See related Contract changes

Content

Contents.TransferOwnershipByFilter and Contents.UpdatePermissionsByFilter

Additional endpoints for updating multiple content

These endpoints allow updating permissions or transferring ownership of many contents using a single API call.

See related OpenAPI spec

Exceptions

PictureparkDatabaseException

New base type for low-level database exceptions

Base for (already existing)
QueryException,
ObjectStoreException and
ObjectStoreResponseException

See related Merge Request

Exceptions

ContractMismatchException

Added property ExpectedType

Describes the type to which the system failed to convert the request to

See related Contracts.Generated.cs