This document contains Web Service descriptions for the following services.
Name | Description |
---|---|
ExtendedPublicService |
Name | Description |
---|---|
AddAssets2AssetContainers | Add (assign) assets to asset containers |
AddAssetVersions | Add asset versions (currently: language version or slide) |
ConfirmSubscriptionInfoReceived | Call directly after successfully receiving data from GetSubscriptionInfo in order to delete the history. |
CreateAssetContainer | Create an asset container |
CreateAssetLink |
Creates a link to a business process (mailing without recipient) and returns a BusinessProcessShort object. Please note: The link goes always to the latest versions of the files. There are no old versions, unless the versioning feature is used, but even then, the link will return the most actual derivatives. |
CreateRenderingJob | Creates a rendering job and returns the rendering job id, needed for some webservices like ImportSingleAsset and UpdateOriginalDerivative. |
CreateSession | Create a session |
CreateTraceJob | Creates a trace job and returns the trace job id, sometimes needed for some webservices like CreateSession. |
CreateUser | Create a user |
DeleteAssetLinks | Delete assetlinks |
DeleteDerivative |
Delete a custom derivative (only custom derivatives may be deleted) See SaveDerivative on how to upload / create a custom derivative. |
Download | Download a collection of assets as defined by assetSelection |
DownloadExtended | Download a collection of assets with additional options |
GetAssetContainerRights | Get access rights to asset containers for all user groups. |
GetAssetContainers | Get a list of AssetContainerItems |
GetAssetFields | Get a list of all asset Field definitions. |
GetAssetLinksById | Get a list of assetlinks |
GetAssetRights | Get access rights to assets for all user groups. |
GetAssets | Get an AssetItemCollection as defined by extendedAssetFilter |
GetAssets2 | Get a collection of those PortAssetItems which match an active facet |
GetAssetsByIds | Get an AssetItemCollection as defined by the array of asset ids |
GetAssetsMetadata |
Get a list of AssetFieldValues See also similar webservice GetMetadata. |
GetAssetVersions | Get asset AssetVersions |
GetConfiguration | Get the PublicConfiguration of the Picturepark |
GetConfigurationModificationDate | Get the last modification date of the customer configuration |
GetContentLanguages | Get the list of Language4Content for this Picturepark |
GetDerivativeRights | Get a list of UserDerivativeRights |
GetDerivatives | Get certain Derivatives for one or more assets |
GetFacetConfigurationExtended | Get the FacetConfigurationExtended of a certain facet, usually needed for GetFacets and/or GetAssets2 |
GetFacets | Get FacetResults, which contains the structure of the left panel in the new UI. |
GetFieldSetIdByFieldName | Gets the field set ID that matches the field's name (case sensitive!). |
GetLanguageConfiguration | Get the LanguageConfiguration for a user |
GetMetadata |
Get AssetMetadata of an asset See also similar webservice GetAssetsMetadata. |
GetRights |
Get a collection of rights for the current user The returned Rights contain: DerivativeDefinitionRights, FieldRights, UserRights, UserGroupRights and RightTemplates. |
GetSecurityToken | Get a security token, which is needed for LoginWithSecurityToken |
GetSubscriptionInfo | Returns a list of UserActionHistoryInfo which is needed by the Event Subscription Service (ESS) |
GetTotalAssets | |
GetUserById | Get UserData for a user |
GetUsers | Get a UserCollection |
ImportSingleAsset | Import a single asset |
IsValid | Check the validity of a session |
Login | Log in |
LoginWithSecurityToken | Log in with a security token as a PAS (Picturepark Authentication Service) user |
LoginWithSecurityToken2 | Log in with a security token as a PAS (Picturepark Authentication Service) user |
MoveAssetContainer | Move an asset container |
RemoveAssetContainer | Remove (delete) an asset container |
RemoveAssets | Remove (delete) assets |
RemoveAssetsFromAssetContainers | Remove (un-assign) assets from asset containers |
RemoveAssetVersions | Remove asset versions (currently: language version or slide) |
RemoveUsers | Remove (delete) users |
RenewSession | Renew a session (prevent a timeout) |
SaveAssetContainerRights | Save the access rights for an asset container |
SaveAssetsRights | Save (modify) asset rights |
SaveDerivative |
Save (upload) a custom derivative Custom derivatives (which must be defined in the Picturepark Management Console) are independent files, which are assigned to an asset like a regular derivative and are offered for download just like regular derivates. |
SaveDerivativeRights | Save (modify) derivative rights |
UpdateAssetContainer | Update an asset container (modify names and descriptions) |
UpdateAssetLinks | Update assetlinks |
UpdateAssetMetadata | Update asset metadata |
UpdateAssetsMetadata | Update metadata of several assets (batch update) |
UpdateFieldSetDefaultValue | Sets default value(s) for the provided asset container ID / field set ID combination. |
UpdateOriginalDerivative | Replace the original file of an asset |
UpdateUser | Update user data |
UploadChunk | Upload file by chunks. Use this method to upload the remaining chunks following the first chunk uploaded by UploadFirstChunk. |
UploadFile | Upload a file by streaming |
UploadFirstChunk | Upload file by chunks. Use this method to upload the first chunk. |
Add (assign) assets to asset containers
The input of this method is the document element AddAssets2AssetContainers having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | Array of asset ids. |
assetContainerIds | ArrayOfint | Array of asset container ids. |
The output of this method is the document element AddAssets2AssetContainersResponse that is always empty.
PictureparkErrorType InsufficientRights:
> the user does not have the AssetRight EditContainerAssignments for all assets;
> the user does not have the AssetContainerRight AssignAssets for all asset containers;
> the user does not have the AssetRight EditContainerAssignments for all assigned versions of the assets.
AddAssets2AssetContainers
// Assign assets 111 and 222 to asset containers 11, 22 and 33.
.
List<int> assetIds = new List<int> {111, 222};
List<int> assetContainerIds = new List<int> {11, 22, 33};
.
PictureparkService.AddAssets2AssetContainers(coreInfo, assetIds, assetContainerIds);
Add asset versions (currently: language version or slide)
The input of this method is the document element AddAssetVersions having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetVersions | ArrayOfAssetVersion |
A list of AssetVersions. There are currently two types of assetversions: languages and slides. |
The output of this method is the document element AddAssetVersionsResponse that is always empty.
PictureparkErrorType InsufficientRights:
> the user does not have the AssetRight EditVersions for all assets in the list;
> the user does not have the AssetRight EditVersions for all parent assets in the list.
AddAssetVersions
// Create language versions for languages 2 and 3 (engl and french) for the (parent) asset 481.
.
List<AssetVersion> assetVersions = new List<AssetVersion>
{
. new AssetVersion
. {
. Asset = new AssetItem {AssetId = 483},
. ParentAssetId = 481,
. LanguageId = 3,
. VersionTypeId = 1 // Version type "Language"
. },
. new AssetVersion
. {
. Asset = new AssetItem {AssetId = 482},
. ParentAssetId = 481,
. LanguageId = 2,
. VersionTypeId = 1
. }
};
.
PictureparkService.AddAssetVersions(coreInfo, assetVersions);
Call directly after successfully receiving data from GetSubscriptionInfo in order to delete the history.
The input of this method is the document element ConfirmSubscriptionInfoReceived having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
subscriptionActionId | int | The id of the subscription action. |
batchGuid | string | The guid received from GetSubscriptionInfo |
A UserActionHistoryInfoCollection, which is a list of UserActionHistoryInfos for the subscriptionActionId
ConfirmSubscriptionInfoReceived
// Delete the history entries by confirming the reception
// When calling ConfirmSubscriptionInfoReceived() a NotificationDate is set and the info is not returned again.
// subscriptionInfoAfter therefore should not contain the UserActionHistoryInfos of subscriptionInfoBefore
.
int subscriptionActionId = 2;
bool distinct = true;
.
UserActionHistoryInfoCollection subscriptionInfoBefore = PictureparkService.GetSubscriptionInfo(coreInfo, subscriptionActionId, distinct);
PictureparkService.ConfirmSubscriptionInfoReceived(coreInfo, subscriptionActionId, subscriptionInfoBefore.BatchGuid);
UserActionHistoryInfoCollection subscriptionInfoAfter = PictureparkService.GetSubscriptionInfo(coreInfo, subscriptionActionId, distinct);
Create an asset container
The input of this method is the document element CreateAssetContainer having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
parentAssetContainerId | int | The id of the asset container where the new container is created. |
assetContainerTranslations | ArrayOfAssetContainerTranslation | A list of AssetContainerTranslations with the language specific asset container names and descriptions. |
The id of the new asset container.
Element | Type | Description |
---|---|---|
CreateAssetContainerResult | int | |
PictureparkErrorType InsufficientRights is thrown, if the user lacks the necessary rights.
This exception is also thrown, if the parentAssetContainerId does not exist.
PictureparkErrorType FalseParameters is thrown, if the list of translations is incomplete.
CreateAssetContainer
// Create an asset container with names and descriptions in 4 different languages in the parent container 48.
.
int parentAssetContainerId = 48;
List<AssetContainerTranslation> assetContainerTranslations = new List<AssetContainerTranslation>
{
. new AssetContainerTranslation {Description = "Ein weisses Haus", LanguageId = 1, Name = "Haus"},
. new AssetContainerTranslation {Description = "A white house", LanguageId = 2, Name = "House"},
. new AssetContainerTranslation {Description = "Une maison blanche", LanguageId = 3, Name = "Maison"},
. new AssetContainerTranslation {Description = "Una casa blanca", LanguageId = 75, Name = "Casa"}
};
.
int newAssetContainerId = PictureparkService.CreateAssetContainer(coreInfo, parentAssetContainerId, assetContainerTranslations);
Creates a link to a business process (mailing without recipient) and returns a BusinessProcessShort object.
Please note: The link goes always to the latest versions of the files.
There are no old versions, unless the versioning feature is used, but even then, the link will return the most actual derivatives.
The input of this method is the document element CreateAssetLink having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
name | string | The name. |
description | string | The description. |
assetSelections | ArrayOfAssetSelection | A list of asset selections. |
expirationDate | DateTimeOffset | The expiry date. |
A BusinessProcessShort datatype.
Element | Type | Description |
---|---|---|
CreateAssetLinkResult | BusinessProcessShort | |
CreateAssetLink
// Create an asset link for a collection of asset derivatives.
.
List<AssetSelection> assetSelection = new List<AssetSelection>();
assetSelection.Add(new AssetSelection() { AssetId = 512, DerivativeDefinitionId = 7 });
assetSelection.Add(new AssetSelection() { AssetId = 507, DerivativeDefinitionId = 8 });
assetSelection.Add(new AssetSelection() { AssetId = 505, DerivativeDefinitionId = 6 });
.
DateTimeOffset expirationDate = new DateTimeOffset(2020, 7, 31, 0, 0, 0, TimeSpan.Zero);
string assetLinkName = "Images Collection 2014";
string assetLinkDescription = "Contains pictures about the latest collection.";
.
BusinessProcessShort assetLink = PictureparkService.CreateAssetLink(coreInfo, assetLinkName, assetLinkDescription, assetSelection, expirationDate);
Creates a rendering job and returns the rendering job id, needed for some webservices like ImportSingleAsset and UpdateOriginalDerivative.
The input of this method is the document element CreateRenderingJob having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
renderingClient | RenderingClient | The RenderingClient. |
The id of the rendering job.
Element | Type | Description |
---|---|---|
CreateRenderingJobResult | int | |
CreateRenderingJob
// Create a rendering job of type "RenderingClient.Import".
.
RenderingClient renderingClient = RenderingClient.Import;
int renderingJobId = PictureparkService.CreateRenderingJob(coreInfo, renderingClient);
Create a session
The input of this method is the document element CreateSession having the structure defined by the following table.
Element | Type | Description |
---|---|---|
customerId | int | The id of the customer (picturepark), e.g. 123. |
language | ApplicationLanguage |
The ui language, e.g. "English" or "Norwegian". This value is written to the session log and never used again for any other purposes. Neither is it returned in coreInfo. After a user logs in, the language for this user is taken from the language defined for this user in the database. |
language4ContentId | int |
Optional. The id of the content language. The Language4Content is not a language, but a language configuration set, which defines the respective languages for metadata, asset containers and searching. If null, the default language4contentId for this Picturepark is used for CreateSession. As with the ui language, this value is written to the session log and never used again for any other purposes. Neither is it returned in coreInfo. After a user logs in, the content language for this user is taken from the content language defined for this user in the database. |
aspNetSessionId | string | Optional. The aspNetSessionId (if known), which enables the system to retrieve a lost session, e.g. in case of a browser reload. |
skin | SkinColor |
Optional. Available options: "SkinColor.Blue" and "SkinColor.Gray". SkinColor? skin = SkinColor.Blue; |
clientGuid | string | The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server. |
httpContextRequestInfo | HttpContextRequestInfo |
Optional. These informations, which are needed for logging purposes, must be gathered and submitted only by the web ui. In all other cases null should be submitted. |
traceJobId | int |
Optional. Only submit this parameter if the method call is part of a trace job. The traces within a trace job are pooled for special reporting capabilities. To get a traceJobId, you must call the webservice CreateTraceJob, which is only available in the extended public webservices. Needed for tracing purposes only. |
Returns a CoreInfo object with the session data.
Element | Type | Description |
---|---|---|
CreateSessionResult | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
CreateSession
// Create a session for customer 123.
.
int customerId = 123;
ApplicationLanguage applicationLanguage = ApplicationLanguage.English;
int? contentLanguageId = null;
string aspNetSessionId = null;
SkinColor? skin = null;
string clientGuid = "04515589-EDF0-F09B-80E0-B28AB0123B97";
HttpContextRequestInfo httpContextRequestInfo = null;
int? traceJobId = null;
.
CoreInfo coreInfo = PictureparkService.CreateSession(customerId, applicationLanguage, contentLanguageId, aspNetSessionId, skin, clientGuid, httpContextRequestInfo, traceJobId);
Creates a trace job and returns the trace job id, sometimes needed for some webservices like CreateSession.
The input of this method is the document element CreateTraceJob having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
traceJobType | TraceJobType | The TraceJobType. |
The id of the trace job.
Element | Type | Description |
---|---|---|
CreateTraceJobResult | int | |
CreateTraceJob
// Create a trace job of type TraceJobType.AssetImport.
.
TraceJobType traceJobType = TraceJobType.AssetImport;
int traceJobId = PictureparkService.CreateTraceJob(coreInfo, traceJobType);
Create a user
The input of this method is the document element CreateUser having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
userData | UserData | UserData for the new user. |
password | string | The password. Must have the minimum strength as defined for this customer. |
The id of the new user.
Element | Type | Description |
---|---|---|
CreateUserResult | int | |
PictureparkErrorType InsufficientRights: the current user does not have the UserGroupRight AssignUsers.
PictureparkErrorType WeakPassword_1: the password is not strong enough.
PictureparkErrorType EmailAlreadyInUse: a user with this email exists already.
An exception is thrown, if not all required field values are present and content matches with content rules.
CreateUser
// Create a user "hansueli@huerlimann.ch" and assign this user to user groups 55 and 66.
.
List<int> userGroupIds = new List<int> {55,66};
.
UserData userData = new UserData
{
. EmailAddress = "hansueli@huerlimann.ch",
. CanBeInternalContact = false,
. CanChangeOwnProfile = true,
. FirstName = "Hans-Ueli",
. LastName = "Hürlimann",
. Address = "Am Abgrund 123",
. Zip = "CH-6318",
. City = "Walchwil",
. Phone = "+41 11 22 333",
. Company = "Fa. Hürlimann und Hürlifrau GmbH",
. Department = "Sales",
. LanguageId = 1,
. UserGroupIds = userGroupIds
};
.
string password = "mySecretPassword12345";
.
int newUserId = PictureparkService.CreateUser(coreInfo, userData, password);
Delete assetlinks
The input of this method is the document element DeleteAssetLinks having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
businessProcessIds | ArrayOfint | A list of the businessprocess ids to be deleted. |
The output of this method is the document element DeleteAssetLinksResponse that is always empty.
DeleteAssetLinks
// Delete asset links with ids 1,2,3.
.
List<int> assetIds = new List<int>() { 1, 2, 3 };
PictureparkService.DeleteAssetLinks(coreInfo, assetIds);
Delete a custom derivative (only custom derivatives may be deleted)
See SaveDerivative on how to upload / create a custom derivative.
The input of this method is the document element DeleteDerivative having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
derivativeDefinitionId | int | The derivative definition id. |
The output of this method is the document element DeleteDerivativeResponse that is always empty.
DeleteDerivative
// Delete the custom derivative pdf for asset 525
.
int assetId = 525; // Green mamba
int derivativeDefinitionId = 13; // Pdf custom derivative id
.
PictureparkService.DeleteDerivative(coreInfo, assetId, derivativeDefinitionId);
Download a collection of assets as defined by assetSelection
The input of this method is the document element Download having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetSelection | ArrayOfAssetSelection | A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds. |
downloadOptions | DownloadOptions | Defines the download options. |
Returns a Download object.
Element | Type | Description |
---|---|---|
DownloadResult | Download | |
PictureparkErrorType EmptyDownloadArray is thrown, if there is not at least one download item.
Exception No access to AssetId: {AssetId} is thrown, if there are one or more not accessible assets in the download collection.
Exception No access to AssetId: {AssetId} and DerivativeDefinitionId: {DerivativeDefinitionId}. Same as above for non accessible derivatives.
Exception DownloadOptions.UserAction is not valid. is thrown in one of the following cases:
. > downloadOptions.UserAction != UserAction.DerivativeDownload
. > downloadOptions.UserAction != UserAction.DerivativeView
. > downloadOptions.UserAction != UserAction.AssetReplication
Download
// Download 2 formats of asset 4 and 1 format of asset 6.
.
List<AssetSelection> assetSelection = new List<AssetSelection>();
assetSelection.Add(new AssetSelection() {AssetId = 4, DerivativeDefinitionId = 2});
assetSelection.Add(new AssetSelection() {AssetId = 4, DerivativeDefinitionId = 6});
assetSelection.Add(new AssetSelection() {AssetId = 6, DerivativeDefinitionId = 7});
.
DownloadOptions downloadOptions = new DownloadOptions()
{
. CreateZip4SingleFile = false,
. UsagePurpose = "Just a test by the programmer",
. UserAction = UserAction.DerivativeDownload
};
.
Download download = PictureparkService.Download(coreInfo, assetSelection, downloadOptions);
Download a collection of assets with additional options
The input of this method is the document element DownloadExtended having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetSelection | ArrayOfAssetSelection | A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds. |
downloadOptions | DownloadOptions | Defines the download options. |
createSingleDownload4MultipleFiles | boolean |
If true, a zipfile which contains all files is created on the server for download. You get ONE link to this zip file. Otherwise you get one Link for each derivative. |
provideUniqueFileName | boolean |
If true, the system provides for a (pseudo) unique name for each derivative. Depending on the download configuration of a particular Picturepark, each derivative normally has a unique name. If this is the case, the provideUniqueFileName-parameter is ignored. But if for some reason identically named derivatives are downloaded as discrete files one by one, they would be overwritten by their namesakes. In this case, if provideUniqueFileName is true, the system will append the derivative definition short name, e.g. "Internet" in order to create a (pseudo) unique file name. |
Returns a data type Dictionary<Download, List<AssetSelection>>.
Element | Type | Description |
---|---|---|
DownloadExtendedResult | ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK | |
DownloadExtended
.
List<AssetSelection> assetSelection = new List<AssetSelection>();
assetSelection.Add(new AssetSelection() {AssetId = 4, DerivativeDefinitionId = 1});
assetSelection.Add(new AssetSelection() {AssetId = 4, DerivativeDefinitionId = 6});
assetSelection.Add(new AssetSelection() {AssetId = 6, DerivativeDefinitionId = 7});
.
DownloadOptions downloadOptions = new DownloadOptions()
{
. CreateZip4SingleFile = false,
. UsagePurpose = "Just a test by the programmer",
. UserAction = UserAction.DerivativeDownload
};
.
Dictionary<Download, List<AssetSelection>> download = PictureparkService.DownloadExtended(coreInfo, assetSelection, downloadOptions, createSingleDownload4MultipleFiles: true, provideUniqueFileName: true);
Get access rights to asset containers for all user groups.
The input of this method is the document element GetAssetContainerRights having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The id of the asset container. |
A List<UserGroupAssetContainerRights>.
Element | Type | Description |
---|---|---|
GetAssetContainerRightsResult | ArrayOfUserGroupAssetContainerRights | |
PictureparkErrorType InsufficientRights is thrown, if the user lacks the AssetContainerRight EditAssetContainerRights.
GetAssetContainerRights
// Get asset container rights for asset container 1234.
.
int assetContainerId = 1234;
List<UserGroupAssetContainerRights> userGroupAssetContainerRights = PictureparkService.GetAssetContainerRights(coreInfo, assetContainerId);
Get a list of AssetContainerItems
The input of this method is the document element GetAssetContainers having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
parentAssetContainerId | int | The id of the AssetContainer (category or asset class) for which the children are to be returned. |
assetContainerType | AssetContainerType |
Optional. Either Category or AssetClass. AssetContainerType? assetContainerType = AssetContainerType.AssetClass; |
openAssetContainerId | int |
Optional. This parameter is needed in order to display the opened part of a category branch. You define a parent id (a) and an openedAssetContainerId (aaaa) below the parent and you will get the nodes on the line of descendants (a, aa, aaa, aaaa) plus all siblings of these nodes: a (Parent) aa bb cc dd ee (Child aa plus siblings bb, cc ..) aaa bbb (Child aaa of aa plus siblings bbb ..) aaaa bbbb cccc (Child aaaa of aaa plus siblings bbbb, cccc..) |
totalLayers | int | Number of layers (children, grand-children ..) to be returned. 1 = only the parentAssetContainerId is returned, 0 = all. |
searchString | string |
Optional. If not empty, only asset containers with matching names and/or descriptions are returned. Please note: there is always the complete line of parent nodes returned down to the matching nodes. |
desiredAssetContainerLanguage | ApplicationLanguage |
Optional. The language (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..). ApplicationLanguage? desiredAssetContainerLanguage = ApplicationLanguage.English; |
Returns a list of AssetContainerItems.
Element | Type | Description |
---|---|---|
GetAssetContainersResult | ArrayOfAssetContainerItem | |
Exception AssetContainerTranslation for language {desiredAssetContainerLanguage} could not be found. is thrown if the submitted desiredAssetContainerLanguage is not found.
GetAssetContainers
// Get all asset containers (categories and asset classes), which are in the parent container 120.
.
int parentAssetContainerId = 120;
int? openAssetContainerId = null;
AssetContainerType? assetContainerType = null;
int totalLayers = 0;
string searchString = null;
ApplicationLanguage desiredAssetContainerLanguage = null;
.
List<AssetContainerItem> assetContainers =
. PictureparkService.GetAssetContainers(coreInfo, parentAssetContainerId, assetContainerType, openAssetContainerId, totalLayers, searchString, desiredAssetContainerLanguage);
Get a list of all asset Field definitions.
The input of this method is the document element GetAssetFields having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Returns a list of asset field definitions.
Element | Type | Description |
---|---|---|
GetAssetFieldsResult | ArrayOfField | |
GetAssetFields
List<Field> assetFields = PictureparkService.GetAssetFields(coreInfo);
Get a list of assetlinks
The input of this method is the document element GetAssetLinksById having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
businessProcessIds | ArrayOfint | A list of businessprocess ids. |
startRow | int | Start row. |
limit | int | Number of maximally returned itens. |
A list of assetlinks, a BusinessProcessShort datatype.
Element | Type | Description |
---|---|---|
GetAssetLinksByIdResult | ArrayOfBusinessProcessShort | |
GetAssetLinksById
.
List<int> businessProcessIds = new List<int> { 2, 4, 10, 11, 12 };
int startRow = 0;
int limit = 100;
.
List<BusinessProcessShort> businessProcesses = PictureparkService.GetAssetLinksById(coreInfo, businessProcessIds, startRow, limit);
Get access rights to assets for all user groups.
The input of this method is the document element GetAssetRights having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
A List<UserGroupAssetRights>
Element | Type | Description |
---|---|---|
GetAssetRightsResult | ArrayOfUserGroupAssetRights | |
GetAssetRights
// Get asset rights for asset 123.
.
int assetId = 123;
List<UserGroupAssetRights> userGroupAssetRights = PictureparkService.GetAssetRights(coreInfo, assetId);
Get an AssetItemCollection as defined by extendedAssetFilter
The input of this method is the document element GetAssets having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
extendedAssetFilter | ExtendedAssetFilter | The extendedAssetFilter allows the definition of many additional parameters. |
Returns an AssetItemCollection.
Element | Type | Description |
---|---|---|
GetAssetsResult | AssetItemCollection | |
GetAssets
// Get all assets sorted by asset id ascending.
// See the general API docu overview for further examples!
.
List<SortInfo> sortInfos = new List<SortInfo> { new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Asc }};
ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter() { SortInfos = sortInfos };
.
AssetItemCollection assetItemCollection = PictureparkService.GetAssets(coreInfo, extendedAssetFilter);
Get a collection of those PortAssetItems which match an active facet
The input of this method is the document element GetAssets2 having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetFilter | ExtendedAssetFilter | An asset filter. |
portName | string | |
A collection of asset items.
Element | Type | Description |
---|---|---|
GetAssets2Result | PortAssetItemCollection | |
GetAssets2
// Get the first 50 assets which match the facet "Facet2"
.
FacetConfigurationExtended extendedFacetConfiguration = PictureparkService.GetFacetConfigurationExtended(coreInfo, "Facet2");
ExtendedAssetFilter extendedAssetFilter = extendedFacetConfiguration.InitialAssetFilter;
extendedAssetFilter.StartRow = 0;
extendedAssetFilter.Limit = 50;
.
PortAssetItemCollection portAssetItemCollection = PictureparkService.GetAssets2(coreInfo, extendedAssetFilter);
Get an AssetItemCollection as defined by the array of asset ids
The input of this method is the document element GetAssetsByIds having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | The int array of asset ids to be returned. |
assetFilter | AssetFilter | The assetFilter allows the definition of some additional parameters. |
Returns an AssetItemCollection.
Element | Type | Description |
---|---|---|
GetAssetsByIdsResult | AssetItemCollection | |
GetAssetsByIds
// Get an AssetItemCollection for assets 11,22,33,44.
.
AssetFilter assetFilter = new AssetFilter();
List<int> assetIds = new List<int> { 11, 33, 22, 44 };
.
AssetItemCollection assetItemCollection = PictureparkService.GetAssetsByIds(coreInfo, assetIds, assetFilter);
Get a list of AssetFieldValues
See also similar webservice GetMetadata.
The input of this method is the document element GetAssetsMetadata having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | A list of asset ids. |
fieldIds | ArrayOfint | A list of field ids. |
Returns a list of AssetFieldValues.
Element | Type | Description |
---|---|---|
GetAssetsMetadataResult | ArrayOfAssetFieldValues | |
GetAssetsMetadata
// Get field values 11,22,33,44 for assets 111,222,333.
.
List<int> assetIds = new List<int> { 111, 222, 333 };
List<int> fieldIds = new List<int> { 11, 22, 33, 44 };
.
List<AssetFieldValues> assetFieldValues = PictureparkService.GetAssetsMetadata(coreInfo, assetIds, fieldIds);
Get asset AssetVersions
The input of this method is the document element GetAssetVersions having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
assetFilter | AssetFilter | An asset filter, may be empty. |
A list of AssetVersions.
Element | Type | Description |
---|---|---|
GetAssetVersionsResult | ArrayOfAssetVersion | |
GetAssetVersions
// Get asset versions for asset 45
.
int assetId = 45;
AssetFilter assetFilter = new AssetFilter();
.
List<AssetVersion> assetVersions = PictureparkService.GetAssetVersions(coreInfo, assetId, assetFilter);
Get the PublicConfiguration of the Picturepark
The input of this method is the document element GetConfiguration having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
The PublicConfiguration.
Element | Type | Description |
---|---|---|
GetConfigurationResult | PublicConfiguration | |
GetConfiguration
PublicConfiguration publicConfiguration = PictureparkService.GetConfiguration(coreInfo);
Get the last modification date of the customer configuration
The input of this method is the document element GetConfigurationModificationDate having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
DateTimeOffset configurationModificationDate.
Element | Type | Description |
---|---|---|
GetConfigurationModificationDateResult | DateTimeOffset | |
GetConfigurationModificationDate
System.DateTimeOffset configurationModificationDate = PictureparkService.GetConfigurationModificationDate(coreInfo);
Get the list of Language4Content for this Picturepark
The input of this method is the document element GetContentLanguages having the structure defined by the following table.
Element | Type | Description |
---|---|---|
customerId | int | The customer id. |
A list of the content languages.
Element | Type | Description |
---|---|---|
GetContentLanguagesResult | ArrayOfLanguage4Content | |
GetContentLanguages
int customerId = 123;
List<Language4Content> contentLanguages = PictureparkService.GetContentLanguages(customerId);
Get a list of UserDerivativeRights
The input of this method is the document element GetDerivativeRights having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
A List<UserDerivativeRights>
Element | Type | Description |
---|---|---|
GetDerivativeRightsResult | ArrayOfUserDerivativeRights | |
PictureparkErrorType InsufficientRights: the user does not have the AssetRight ViewDerivativeRights.
GetDerivativeRights
// Get rights to asset derivatives for asset 123.
.
int assetId = 123;
List<UserDerivativeRights> userDerivativeRights = PictureparkService.GetDerivativeRights(coreInfo, assetId);
Get certain Derivatives for one or more assets
The input of this method is the document element GetDerivatives having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetSelection | ArrayOfAssetSelection | A list of AssetSelections. |
A list of ExtendedDerivatives.
Element | Type | Description |
---|---|---|
GetDerivativesResult | ArrayOfExtendedDerivative | |
GetDerivatives
// Get certain derivatives for asset 550 and 551
.
List<AssetSelection> assetSelections = new List<AssetSelection>();
assetSelections.Add(new AssetSelection() { AssetId = 550, DerivativeDefinitionId = 1 });
assetSelections.Add(new AssetSelection() { AssetId = 550, DerivativeDefinitionId = 6 });
assetSelections.Add(new AssetSelection() { AssetId = 551, DerivativeDefinitionId = 7 });
.
List<ExtendedDerivative> derivatives = PictureparkService.GetDerivatives(coreInfo, assetSelections);
Get the FacetConfigurationExtended of a certain facet, usually needed for GetFacets and/or GetAssets2
The input of this method is the document element GetFacetConfigurationExtended having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
name | string | The facet name. |
A facet configuration.
Element | Type | Description |
---|---|---|
GetFacetConfigurationExtendedResult | FacetConfigurationExtended | |
GetFacetConfigurationExtended
// Get the facet configuration for "Facet2"
string facetName = "Facet2";
extendedFacetConfiguration = PictureparkService.GetFacetConfigurationExtended(coreInfo, facetName);
Get FacetResults, which contains the structure of the left panel in the new UI.
The input of this method is the document element GetFacets having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
searchParameters | ArrayOfFacetSearchParameter | A list of FacetSearchParameter. |
selectedFacetValues | ArrayOfFacetValue | A list of FacetValue, can be null. |
Returns FacetResults
Element | Type | Description |
---|---|---|
GetFacetsResult | FacetResults | |
GetFacets
// Get facets for "Facet2" for the first 50 assets
.
FacetConfigurationExtended extendedFacetConfiguration = PictureparkService.GetFacetConfigurationExtended(coreInfo, "Facet2");
ExtendedAssetFilter initialAssetFilter = extendedFacetConfiguration.InitialAssetFilter;
initialAssetFilter.StartRow = 0;
initialAssetFilter.Limit = 50;
.
List<FacetSearchParameter> facetSearchParameters = new List<FacetSearchParameter>();
.
FacetSearchParameter facetSearchParameter = new FacetSearchParameter()
{
FacetConfigurationId = extendedFacetConfiguration.FacetConfigurationId,
SearchFilter = initialAssetFilter,
FieldIdsOfFacets = extendedFacetConfiguration.FieldIds
};
facetSearchParameters.Add(facetSearchParameter);
.
FacetResults facetResults = PictureparkService.GetFacets(coreInfo, facetSearchParameters, null);
facetResults.writeUnitTestResultToXml<FacetResults>("FacetResults.xml");
Gets the field set ID that matches the field's name (case sensitive!).
The input of this method is the document element GetFieldSetIdByFieldName having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The asset container ID. |
fieldName | string | The field name (case sensitive!). |
The field set ID.
Element | Type | Description |
---|---|---|
GetFieldSetIdByFieldNameResult | int | |
Get the LanguageConfiguration for a user
The input of this method is the document element GetLanguageConfiguration having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
The language configuration for the currently logged in user.
Element | Type | Description |
---|---|---|
GetLanguageConfigurationResult | LanguageConfiguration | |
GetLanguageConfiguration
// Get the language configuration for this Picturepark.
.
LanguageConfiguration languageConfiguration = PictureparkService.GetLanguageConfiguration(coreInfo);
Get AssetMetadata of an asset
See also similar webservice GetAssetsMetadata.
The input of this method is the document element GetMetadata having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
updateStatistic | boolean | If true, the action is recorded in the statistics table. |
businessProcessId | int | Optional. Not needed by integrators. |
businessProcessToken | string | Optional. Not needed by integrators. |
Returns the AssetMetadata for an asset.
Element | Type | Description |
---|---|---|
GetMetadataResult | AssetMetadata | Represents the metadata of an asset. |
GetMetadata
// Get the metadata for asset 1000.
.
int assetId = 1000;
bool updateStatistic = true;
int? businessProcessId = null;
string businessProcessToken = null;
.
AssetMetadata assetMetadata = PictureparkService.GetMetadata(coreInfo, assetId, updateStatistic, businessProcessId, businessProcessToken);
Get a collection of rights for the current user
The returned Rights contain: DerivativeDefinitionRights, FieldRights, UserRights, UserGroupRights and RightTemplates.
The input of this method is the document element GetRights having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
The rights for a user
Element | Type | Description |
---|---|---|
GetRightsResult | Rights | |
GetRights
// Get a collection of all rights.
.
Rights rights = PictureparkService.GetRights(coreInfo);
Get a security token, which is needed for LoginWithSecurityToken
The input of this method is the document element GetSecurityToken having the structure defined by the following table.
Element | Type | Description |
---|---|---|
customerId | int | The id of the customer (picturepark), e.g. 27. |
clientGuid | string | The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server. |
authenticationUser | string | The email address of the user, who serves to authenticate the connection. |
authenticationUserPassword | string | The password of that user. |
emailAddress | string | The email address of the (PAS) user, who will later log in from the publisher with the security token |
userData | UserData | UserData for the user, who will later log in with the security token. Needed only if the PAS user does not yet exist, because in this case a new user account will be created for the PAS user. |
traceJobId | int |
Only submit this parameter if the method call is part of a trace job. The traces within a trace job are pooled for special reporting capabilities." To get a traceJobId, you must call the webservice CreateTraceJob, which is only available in the extended public webservices. Needed for tracing purposes only. |
Returns a security token, which is a guid, e.g. "59fa91c1-73ea-46f0-b2ae-76c0457c7b16".
Element | Type | Description |
---|---|---|
GetSecurityTokenResult | string | |
The email and password of the PAS authenticationUser are usually stored in a web.config file.
GetSecurityToken
// Get a security token for authentication user "support@vit.ch" on behalf of "regula.huerlimann@switzerland.ch".
// If the user does not exist, it will be created.
.
// Make sure to submit all required data (in this case including special field "FieldValues")
// Required data depend on customer specific Picturepark configuration.
.
List<int> userGroupIds = new List<int> { 17, 3 };
.
UserData userData = new UserData()
{
. EmailAddress = "regula.huerlimann@switzerland.ch",
. FieldValues = new List<FieldValue>() {new FieldValue() {FieldId = 132, ValueString = "anything"}},
. FirstName = "Regula",
. LanguageId = (int)ApplicationLanguage.English,
. LastName = "Huerlimann",
. UserGroupIds = userGroupIds
};
.
int customerId = 123;
string ClientGuid = "6ED2FBE4-F272-7E34-A216-23F961736729";
string authenticationUser = "support@vit.ch";
string authenticationUserPassword = "kuckuck3107";
string emailAddress = userData.EmailAddress;
int? traceJobId = null;
.
string securityToken = PictureparkService.GetSecurityToken(customerId, clientGuid, authenticationUser, authenticationUserPassword, emailAddress, userData, traceJobId);
Returns a list of UserActionHistoryInfo which is needed by the Event Subscription Service (ESS)
The input of this method is the document element GetSubscriptionInfo having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
subscriptionActionId | int | The id of the subscription action. |
distinct | boolean | Flag: return distinct values only. |
A UserActionHistoryInfoCollection, which is a list of UserActionHistoryInfos for the subscriptionActionId
Element | Type | Description |
---|---|---|
GetSubscriptionInfoResult | UserActionHistoryInfoCollection | |
GetSubscriptionInfo
// Get subscription infos
int subscriptionActionId = 2;
bool distinct = true;
.
UserActionHistoryInfoCollection subscriptionInfo = PictureparkService.GetSubscriptionInfo(coreInfo, subscriptionActionId, distinct);
The input of this method is the document element GetTotalAssets having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
assetContainerIds | ArrayOfint | |
The output of this method is the document element GetTotalAssetsResponse having the structure defined by the following table.
Element | Type | Description |
---|---|---|
GetTotalAssetsResult | ArrayOfAssetContainerTotalAssets | |
Get UserData for a user
The input of this method is the document element GetUserById having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
userId | int | The id of the user. |
A UserData object.
Element | Type | Description |
---|---|---|
GetUserByIdResult | UserData | |
PictureparkErrorType InsufficientRights is thrown, if the user lacks the UserGroupRight ViewUserGroup.
This exception is also thrown, if the user does not exist.
GetUserById
// Get user data for user 1234.
.
int userId = 1234;
UserData userData = PictureparkService.GetUserById(coreInfo, userId);
Get a UserCollection
The input of this method is the document element GetUsers having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
start | int | Optional. The row in the query, from where on to return the users. Default is 0. |
limit | int | Optional. The maximal number of rows returned. Default is unlimited. |
searchString | string | Optional. A search string, e.g. "berg". Leave empty, if you wish to get all users. |
userGroupId | int | Optional. The id of a user group, if you wish to get only users from a certain group. |
registrationState | RegistrationState | Optional. The RegistrationState, if you wish to get only users with a certain regristration state. |
renewalState | RenewalState | Optional. The RenewalState, if you wish to get only users with a certain renewal state. |
sortField | string | Optional. A sortfield, e.g. "EmailAddress". |
sortDirection | SortDirection | Optional. The SortDirection (ascending or descending), default is ascending. |
additionalUserRightsCheck | UserRight | Optional. Get only users with this UserRight. |
additionalUserGroupRightsCheck | UserGroupRight | Optional. Get only users in groups to which the current user has a certain UserGroupRight. |
onlyLocked | boolean | Get only locked users. |
onlyExpired | boolean | Get only expired users. |
onlyExpiredRenewals | boolean | Get only users with expired renewals. |
onlyActive | boolean | Get only active users. |
Element | Type | Description |
---|---|---|
GetUsersResult | UserCollection | |
GetUsers
// Get a collection of the first 100 users which match "iller" ordered by email address.
.
int? start = null;
int? limit = 100;
int? userGroupId = null;
string searchString = "iller";
string sortField = "EmailAddress";
RegistrationState? registrationState = null;
RenewalState? renewalState = null;
SortDirection? sortDirection = SortDirection.Asc;
UserRight? additionalUserRightsCheck = null;
UserGroupRight? additionalUserGroupRightsCheck = null;
bool onlyLocked = false;
bool onlyExpired = false;
bool onlyExpiredRenewals = false;
bool onlyActive = false;
.
UserCollection userCollection = PictureparkService.GetUsers
(
. coreInfo,
. start,
. limit,
. searchString,
. userGroupId,
. registrationState,
. renewalState,
. sortField,
. sortDirection,
. additionalUserRightsCheck,
. additionalUserGroupRightsCheck,
. onlyLocked,
. onlyExpired,
. onlyExpiredRenewals,
. onlyActive
);
Import a single asset
The input of this method is the document element ImportSingleAsset having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
renderingJobId | int |
The rendering job id. Each import must be assigned to a rendering job. Call CreateRenderingJob first to get a renderingJobId. This allows several imports to be pooled to one job. |
assetImportOptions | AssetImportOptions |
A complex datatype for import options. If you wish to upload by streaming (recommended), you must provide the properties ImportGuid and FileName. See under UploadFile how to proceed. |
The id of the imported asset.
Element | Type | Description |
---|---|---|
ImportSingleAssetResult | int | |
PictureparkErrorType InsufficientRights:
> the user does not have the UserRight CreateAssets;
> the user does not have the AssetContainerRight AssignAssets for all asset containers in assetContainerIds;
> the user does not have the FieldRight EditFieldValues for all modified asset fields.
An exception is thrown, if not all required field values are present and content matches with content rules.
ImportSingleAsset
// ---------------------------------------------------------------------------
// EXAMPLE 1: Import asset WITHOUT STREAMING
// ---------------------------------------------------------------------------
.
AssetContainerAssignmentExtended categories = new AssetContainerAssignmentExtended() { AssetContainerId = 121, AssetContainerType = AssetContainerType.Category };
.
List<FieldValue> fieldValues = new List<FieldValue>
{
. new FieldValue {FieldId = 2, ValueString = "Dachs", LanguageId = 1 },
. new FieldValue {FieldId = 2, ValueString = "Badger", LanguageId = 2 },
. new FieldValue {FieldId = 2, ValueString = "Blaireau", LanguageId = 3 },
. new FieldValue {FieldId = 6, FieldOptionId = 291},
. new FieldValue {FieldId = 11, ValueString = "Modified by SAF" },
. new FieldValue {FieldId = 35, ValueUserShort = new UserShort {UserId = coreInfo.User.UserId}},
. new FieldValue {FieldId = 100, ValueAssetContainerAssignment = categories}
};
.
string importUrl = "http://vit.com/test/dog.jpg";
List<int> assetContainerIds = new List<int> { 118 };
int renderingJobId = PictureparkService.CreateRenderingJob(coreInfo, RenderingClient.Import);
int assetRightTemplateId = 5;
int derivativeRightTemplateId = 1;
.
AssetImportOptions assetImportOptions = new AssetImportOptions()
{
. AssetContainerIds = assetContainerIds,
. AssetRightTemplateId = assetRightTemplateId,
. DerivativeRightTemplateId = derivativeRightTemplateId,
. FieldValues = fieldValues,
. ImportUrl = importUrl
};
.
PictureparkService.ImportSingleAsset(coreInfo, renderingJobId, assetImportOptions);
.
.
// ---------------------------------------------------------------------------
// EXAMPLE 2: Import asset BY STREAMING (you must use MTOM-binding!)
// ---------------------------------------------------------------------------
// Like example 1 with 2 minor modifications:
.
// ---------------------------
// First step: get a guid
// ---------------------------
Guid? guid = null;
string fileName = "dog.jpg";
using (FileStream fileStream = new FileStream(@"E:\Temp\" + fileName, FileMode.Open))
. guid = PictureparkServiceMtom.UploadFile(fileStream);
.
// ---------------------------
// Second step: provide additional parameters ImportGuid (instead of ImportUrl) and FileName
// ---------------------------
AssetImportOptions assetImportOptions = new AssetImportOptions()
{
. AssetContainerIds = assetContainerIds,
. AssetRightTemplateId = assetRightTemplateId,
. DerivativeRightTemplateId = derivativeRightTemplateId,
. FieldValues = fieldValues,
. ImportGuid = guid,
. FileName = fileName,
};
.
PictureparkServiceMtom.ImportSingleAsset(coreInfo, renderingJobId, assetImportOptions);
Check the validity of a session
The input of this method is the document element IsValid having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
True or false
Element | Type | Description |
---|---|---|
IsValidResult | boolean | |
IsValid
// Check validity of this session (includes session renewal).
.
bool isValid = PictureparkService.IsValid(coreInfo);
Log in
The input of this method is the document element Login having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Returns an object of type CoreInfo with the updated session data.
If successful, CoreInfo.User.LoginStatus is "LoggedIn", otherwise the exception UserNotFound is thrown.
Element | Type | Description |
---|---|---|
LoginResult | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
PictureparkErrorType UserNotFound is thrown if a user with this password is not found and none of the below listed cases apply.
PictureparkErrorType DeletedUser is thrown if a user has been deleted.
PictureparkErrorType ExpiredUser is thrown if a user has been expired.
PictureparkErrorType LockedUser is thrown if a user has been locked (too many invalid login attempts).
PictureparkErrorType RenewalExpiredUser is thrown if a user account has not been renewed in time.
PictureparkErrorType DisapprovedUser is thrown if a user has been disapproved by an admin or a contact person.
PictureparkErrorType UnconfirmedUser is thrown if a newly registered user failed to confirm his registration.
PictureparkErrorType UserUnapproved is thrown if a user has not yet been confirmed by an admin or a contact person.
Login
// Log in user "support@picturepark.ch" (you must first create a session).
.
coreInfo.User = new User
{
. Email = "support@picturepark.ch",
. Password = "easy2RememberAndDifficult2GuessButAlso2LongMayBe",
. Language = ApplicationLanguage.English
};
.
// Logs in the specified user
coreInfo = PictureparkService.Login(coreInfo);
Log in with a security token as a PAS (Picturepark Authentication Service) user
The input of this method is the document element LoginWithSecurityToken having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
clientGuid | string | The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server. |
securityToken | string | The security token, which has been returned by GetSecurityToken. |
Returns the updated CoreInfo object, which now contains the user data.
Element | Type | Description |
---|---|---|
LoginWithSecurityTokenResult | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
PictureparkErrorType SecurityTokenExpired is thrown, if the token is not found.
PictureparkErrorType SecurityTokenExpired is thrown, if a token is found, which is no more valid.
PictureparkErrorType UserNotFound is thrown, if the user that is associated with the token is not found.
LoginWithSecurityToken
// Log in with security token (you must first get a security token).
.
string ClientGuid = "6ED2FBE4-F272-7E34-A216-23F961736729";
string securityToken = PictureparkService.GetSecurityToken();
.
coreInfo = PictureparkService.LoginWithSecurityToken(coreInfo, clientGuid, securityToken);
Log in with a security token as a PAS (Picturepark Authentication Service) user
The input of this method is the document element LoginWithSecurityToken2 having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
clientGuid | string | The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server. |
securityToken | string | The security token, which has been returned by GetSecurityToken. |
language4ContentId | int | The ID of the language for content which is used initially for this session. Behind this ID is a set of languages (user interface , metadata, asset containers). |
Returns the updated CoreInfo object, which now contains the user data.
Element | Type | Description |
---|---|---|
LoginWithSecurityToken2Result | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
PictureparkErrorType SecurityTokenExpired is thrown, if the token is not found.
PictureparkErrorType SecurityTokenExpired is thrown, if a token is found, which is no more valid.
PictureparkErrorType UserNotFound is thrown, if the user that is associated with the token is not found.
LoginWithSecurityToken
// Log in with security token (you must first get a security token).
.
string ClientGuid = "6ED2FBE4-F272-7E34-A216-23F961736729";
string securityToken = PictureparkService.GetSecurityToken();
.
coreInfo = PictureparkService.LoginWithSecurityToken(coreInfo, clientGuid, securityToken);
Move an asset container
The input of this method is the document element MoveAssetContainer having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
sourceAssetContainerId | int | The id of the source asset container. |
destinationAssetContainerId | int | The id of the new parent asset container. |
insertBeforeAssetContainerId | int |
The id of the sibling container before which the source shall be inserted. Set to 0 if you wish to insert the moved container at the last position. |
The output of this method is the document element MoveAssetContainerResponse that is always empty.
PictureparkErrorType InsufficientRights is thrown, if the user lacks one of the following AssetContainerRights:
> Move for the source container;
> CreateSubContainer for the destination container.
PictureparkErrorType IllegalAssetContainerMove is thrown, if the target container is a descendant of the source.
MoveAssetContainer
// Move container 11 into container 22 in front of container 221.
.
int sourceAssetContainerId = 11;
int destinationAssetContainerId = 22;
int insertBeforeAssetContainerId = 221;
.
PictureparkService.MoveAssetContainer(coreInfo, sourceAssetContainerId, destinationAssetContainerId, insertBeforeAssetContainerId);
Remove (delete) an asset container
The input of this method is the document element RemoveAssetContainer having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int |
The id of the asset container. The deletion of an asset container includes the deletion of all sub containers! |
The output of this method is the document element RemoveAssetContainerResponse that is always empty.
PictureparkErrorType InsufficientRights is thrown, if the user lacks the necessary rights.
This exception is also thrown, if the assetContainerId does not exist.
PictureparkErrorType IdNotFound is thrown, if the asset container does not exist.
PictureparkErrorType DeletionFailure is thrown, if a tab is assigned to the asset container.
RemoveAssetContainer
// Delete asset container 1234 (does not delete assets in container).
.
int assetId = 1234;
PictureparkService.RemoveAssetContainer(coreInfo, assetId);
Remove (delete) assets
The input of this method is the document element RemoveAssets having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | An array of asset ids. |
deleteDependentAssets | boolean |
If true, asset versions depending on the deleted assets are also deleted. Assets versions are currently either language versions or slides (belonging to a Powerpoint presentation). |
The output of this method is the document element RemoveAssetsResponse that is always empty.
PictureparkErrorType InsufficientRights:
> the user does not have the AssetRight Delete for all assets.
> the user does not have the AssetRight Delete for all asset versions (if deleteDependentAssets = true).
RemoveAssets
// Delete assets 111, 222 and 333.
.
List<int> assetIds = new List<int> {111, 222, 333};
bool deleteDependentAssets = false;
.
PictureparkService.RemoveAssets(coreInfo, assetIds, deleteDependentAssets);
Remove (un-assign) assets from asset containers
The input of this method is the document element RemoveAssetsFromAssetContainers having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | List of asset ids. |
assetContainerIds | ArrayOfint | List of asset container ids. |
The output of this method is the document element RemoveAssetsFromAssetContainersResponse that is always empty.
PictureparkErrorType InsufficientRights:
> the user does not have the AssetRight EditContainerAssignments for all assets;
> the user does not have the AssetContainerRight AssignAssets for all asset containers;
> the user does not have the AssetRight EditContainerAssignments for all assigned versions of the assets.
RemoveAssetsFromAssetContainers
// Remove assets 111 and 222 from asset containers 11, 22 and 33.
.
List<int> assetIds = new List<int> {111, 222};
List<int> assetContainerIds = new List<int> {11, 22, 33};
.
PictureparkService.RemoveAssetsFromAssetContainers(coreInfo, assetIds, assetContainerIds);
Remove asset versions (currently: language version or slide)
The input of this method is the document element RemoveAssetVersions having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetVersions | ArrayOfAssetVersion | A list of AssetVersions. |
The output of this method is the document element RemoveAssetVersionsResponse that is always empty.
PictureparkErrorType InsufficientRights:
> the user does not have the AssetRight EditVersions for all assets in the list;
> the user does not have the AssetRight EditVersions for all parent assets in the list.
RemoveAssetVersions
List<AssetVersion> assetVersions = new List<AssetVersion>
{
new AssetVersion
{
Asset = new AssetItem { AssetId = 45 },
ParentAssetId = 47,
AssetVersionId = 62
},
new AssetVersion
{
Asset = new AssetItem { AssetId = 44 },
ParentAssetId = 47,
AssetVersionId = 63
}
};
PictureparkService.RemoveAssetVersions(coreInfo, assetVersions);
Remove (delete) users
The input of this method is the document element RemoveUsers having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
userIds | ArrayOfint | A list of user ids. |
substituteUserId | int |
If a substitute user is submitted, all references to the deleted users will be replaced by the substitute. E.g. the substitute will be registered as the new responsible user for all assets, for which the deleted users had been responsible before. |
The output of this method is the document element RemoveUsersResponse that is always empty.
PictureparkErrorType UserNotFound
> one of the users to be deleted is not found.
> the substitute user is not found.
PictureparkErrorType InsufficientRights: the user does not have the UserGroupRight EditUsers.
RemoveUsers
// Delete users 55,66,77 and set the user 99 as the new responsible user.
.
List<int> userIds = new List<int> {55,66,77};
int? substituteUserId = 99;
.
PictureparkService.RemoveUsers(coreInfo, userIds, substituteUserId);
Renew a session (prevent a timeout)
The input of this method is the document element RenewSession having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
The updated CoreInfo object.
Element | Type | Description |
---|---|---|
RenewSessionResult | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
RenewSession
// Renew this session (prevent timeout).
.
PictureparkService.RenewSession(coreInfo);
Save the access rights for an asset container
The input of this method is the document element SaveAssetContainerRights having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The id of the asset container. |
rightTemplateId | int | The id of a right template. |
isRightTemplateOverridden | boolean | If true, the right template is not used. |
userGroupAssetContainerRights | ArrayOfUserGroupAssetContainerRights | The list of UserGroupAssetContainerRights which defines the rights for each usergroup in the list. |
exceptedAssetContainerIds | ArrayOfint | A list of sub containers to be excluded (if IncludeSubAssetContainers is true ) |
The output of this method is the document element SaveAssetContainerRightsResponse that is always empty.
PictureparkErrorType InsufficientRights is thrown, if the user lacks the following rights:
> the AssetContainerRight EditAssetContainerRights
> the UserRight EditRightsWithoutTemplate is needed in addition, if isRightTemplateOverridden is true.
SaveAssetContainerRights
// Set rights for container 1111 (exclude sub container 2222) for user groups 55 and 66.
.
int assetContainerId = 1111;
int rightTemplateId = 2;
bool isRightTemplateOverridden = false;
.
List<int> exceptedAssetContainerIds = new List<int> {2222};
.
UserGroupItem userGroup55 = new UserGroupItem {UserGroupId = 55};
UserGroupItem userGroup66 = new UserGroupItem {UserGroupId = 66};
.
List<AssetContainerRight> rights4Group55 = new List<AssetContainerRight>>
{
. AssetContainerRight.AssignAssets,
. AssetContainerRight.List,
. AssetContainerRight.ViewContent
};
.
List<AssetContainerRight> rights4Group66 = new List<AssetContainerRight>
{
. AssetContainerRight.AssignAssets,
. AssetContainerRight.CreateSubContainer,
. AssetContainerRight.List,
. AssetContainerRight.ReorderContainer,
. AssetContainerRight.ViewAssetContainerRights,
. AssetContainerRight.ViewContent
};
.
List<UserGroupAssetContainerRights> userGroupAssetContainerRights = new List<UserGroupAssetContainerRights>
{
. new UserGroupAssetContainerRights {AssetContainerRights = rights4Group55, IncludeSubAssetContainers = true, UserGroup = userGroup55},
. new UserGroupAssetContainerRights {AssetContainerRights = rights4Group66, IncludeSubAssetContainers = false, UserGroup = userGroup66}
};
.
PictureparkService.SaveAssetContainerRights(coreInfo, assetContainerId, rightTemplateId, isRightTemplateOverridden, userGroupAssetContainerRights, exceptedAssetContainerIds);
Save (modify) asset rights
The input of this method is the document element SaveAssetsRights having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
rightTemplateId | int |
The id of the right template. Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true). |
isAssetRightTemplateOverridden | boolean |
If true, the right template is not used and the individual right assignments are applied instead. If false, user groups in UserGroupAssetRights are ignored and can be set to null. |
assetIds | ArrayOfint | List of asset ids. |
userGroupAssetRights | ArrayOfUserGroupAssetRights | List<UserGroupAssetRights> |
The output of this method is the document element SaveAssetsRightsResponse that is always empty.
SaveAssetsRights
// Set asset rights for assets 44,55,66
.
List<int> assetIds = new List<int> { 44, 55, 66 };
int rightTemplateId = 6;
bool isAssetRightTemplateOverridden = false;
.
List<AssetRight> assetRightsForGroup1 = new List<AssetRight>
{
. AssetRight.List,
. AssetRight.ViewMetadata
};
List<AssetRight> assetRightsForGroup2 = new List<AssetRight>
{
. AssetRight.List,
. AssetRight.ViewVersions,
. AssetRight.ViewJournal,
. AssetRight.ViewStatistics,
. AssetRight.ViewMetadata
};
.
List<UserGroupAssetRights> userGroupAssetRights = new List<UserGroupAssetRights>
{
. new UserGroupAssetRights{AssetRights = assetRightsForGroup1, UserGroup = new UserGroupItem{UserGroupId = 11}},
. new UserGroupAssetRights{AssetRights = assetRightsForGroup2, UserGroup = new UserGroupItem{UserGroupId = 22}}
};
.
PictureparkService.SaveAssetsRights(coreInfo, rightTemplateId, isAssetRightTemplateOverridden, assetIds, userGroupAssetRights);
Save (upload) a custom derivative
Custom derivatives (which must be defined in the Picturepark Management Console) are independent files, which are assigned to an asset like a regular derivative and are offered for download just like regular derivates.
The input of this method is the document element SaveDerivative having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
renderingJobId | int |
The rendering job id. Call CreateRenderingJob to get a renderingJobId. This allows several updates to be pooled to one job. |
derivativeUpdateOptions | DerivativeUpdateOptions | Complex data type containing multiple update parameters. |
The output of this method is the document element SaveDerivativeResponse that is always empty.
SaveDerivative
// Upload a Pdf about a green mamba to a green mamba picture
.
RenderingClient renderingClient = RenderingClient.Import;
int renderingJobId = PictureparkService.CreateRenderingJob(coreInfo, renderingClient);
int assetId = 525; // Green mamba image
string customDerivativePath = @"D:\Snakes\GreenMamba.pdf";
string fileName = "GreenMamba.pdf";
int derivativeDefinitionId = 13; // Pdf derivative
Guid? guid;
.
using (FileStream fileStream = new FileStream(customDerivativePath, FileMode.Open))
. guid = PictureparkServiceMtom.UploadFile(fileStream);
.
DerivativeUpdateOptions derivativeUpdateOptions = new DerivativeUpdateOptions()
{
. AssetId = assetId,
. DerivativeDefinitionId = derivativeDefinitionId,
. FileName = fileName,
. ImportGuid = guid
};
.
PictureparkService.SaveDerivative(coreInfo, renderingJobId, derivativeUpdateOptions);
Save (modify) derivative rights
The input of this method is the document element SaveDerivativeRights having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
rightTemplateId | int |
The id of the right template. Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true). |
isDerivativeRightTemplateOverridden | boolean |
If true, the right template is not used and the individual right assignments are applied instead. If false, user groups in UserGroupDerivativeRights are ignored and can be set to null. |
assetIds | ArrayOfint | List of asset ids. |
userGroupDerivativeRights | ArrayOfUserGroupDerivativeRights | List of datatype UserGroupDerivativeRights. |
The output of this method is the document element SaveDerivativeRightsResponse that is always empty.
SaveDerivativeRights
// Set derivative rights for assets 44,55,66
.
List<int> assetIds = new List<int> { 44, 55, 66 };
bool isDerivativeRightTemplateOverridden = true;
int rightTemplateId = 4;
.
List<DerivativeRight> derivativeRightsList = new List<DerivativeRight> { DerivativeRight.Download };
DerivativeDefinition derivativeDefinition = new DerivativeDefinition { DerivativeDefinitionId = 7 };
.
Dictionary<DerivativeDefinition, List<DerivativeRight>> derivativeDef2DerivativeRights = new Dictionary<DerivativeDefinition, List<DerivativeRight>>();
derivativeDef2DerivativeRights.Add(derivativeDefinition, derivativeRightsList);
.
List<UserGroupDerivativeRights> userGroupDerivativeRights = new List<UserGroupDerivativeRights>
{
. new UserGroupDerivativeRights{DerivativeRights = derivativeDef2DerivativeRights, UserGroup = new UserGroupItem{UserGroupId = 22}},
. new UserGroupDerivativeRights{DerivativeRights = derivativeDef2DerivativeRights, UserGroup = new UserGroupItem{UserGroupId = 33}}
};
.
PictureparkService.SaveDerivativeRights(coreInfo, rightTemplateId, isDerivativeRightTemplateOverridden, assetIds, userGroupDerivativeRights);
Update an asset container (modify names and descriptions)
The input of this method is the document element UpdateAssetContainer having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The id of the asset container. |
assetContainerTranslations | ArrayOfAssetContainerTranslation | A list of AssetContainerTranslations with the language specific asset container names and descriptions. |
The output of this method is the document element UpdateAssetContainerResponse that is always empty.
PictureparkErrorType InsufficientRights is thrown, if the user lacks the necessary rights.
This exception is also thrown, if the assetContainerId does not exist.
UpdateAssetContainer
// Update name and descriptions for asset container 121.
.
int parentAssetContainerId = 120;
int assetContainerId = 121;
.
AssetContainerType? assetContainerType = AssetContainerType.Category;
int? openAssetContainerId = null;
int totalLayers = 1;
string searchString = "";
ApplicationLanguage? desiredAssetContainerLanguage = null;
.
List<AssetContainerItem> assetContainers = PictureparkService.GetAssetContainers
. (coreInfo, parentAssetContainerId, assetContainerType, openAssetContainerId, totalLayers, searchString, desiredAssetContainerLanguage);
.
var assetContainer = assetContainers.Where(i => i.AssetContainerId == assetContainerId).Select(i => i).Single();
.
foreach (var assetContainerTranslation in assetContainer.Translations)
{
. switch (assetContainerTranslation.LanguageId)
. {
. case 1:
. assetContainerTranslation.Name = "Blaues Haus";
. assetContainerTranslation.Description = "Ein schönes blaues Haus";
. break;
. case 2:
. assetContainerTranslation.Name = "Blue house";
. assetContainerTranslation.Description = "A beautiful blue house";
. break;
. case 3:
. assetContainerTranslation.Name = "Maison bleue";
. assetContainerTranslation.Description = "Une belle maison bleue";
. break;
. case 75:
. assetContainerTranslation.Name = "Casa azul";
. assetContainerTranslation.Description = "Una bonita casa azul";
. break;
. }
}
.
PictureparkService.UpdateAssetContainer(coreInfo, assetContainerId, assetContainer.Translations);
Update assetlinks
The input of this method is the document element UpdateAssetLinks having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetLinks | ArrayOfBusinessProcessShort | An array of BusinessProcessShort. |
The output of this method is the document element UpdateAssetLinksResponse that is always empty.
UpdateAssetLinks
// Update asset links with ids 10,11,12. Please note the logic for the parameter "SelectedAssets"!
.
List<AssetSelection> assetSelection = new List<AssetSelection>();
assetSelection.Add(new AssetSelection() { AssetId = 500, DerivativeDefinitionId = 7 });
assetSelection.Add(new AssetSelection() { AssetId = 510, DerivativeDefinitionId = 6 });
assetSelection.Add(new AssetSelection() { AssetId = 520, DerivativeDefinitionId = 1 });
assetSelection.Add(new AssetSelection() { AssetId = 530, DerivativeDefinitionId = 8 });
.
List<BusinessProcessShort> assetLinks = new List<BusinessProcessShort>();
// Assigned assets will not be changed, because property SelectedAssets is not defined
BusinessProcessShort bps1 = new BusinessProcessShort()
{
. BusinessProcessId = 10,
. BusinessProcessType = BusinessProcessType.AssetLink,
. Description = "New description of business process 10",
. ExpirationDate = new DateTimeOffset(2016, 5, 31, 0, 0, 0, TimeSpan.Zero),
. Name = "Business process 10 modified",
};
.
// Assigned assets will be deleted, because property SelectedAssets is defined and is empty
BusinessProcessShort bps2 = new BusinessProcessShort()
{
. BusinessProcessId = 11,
. BusinessProcessType = BusinessProcessType.AssetLink,
. Description = "New description of business process 11",
. ExpirationDate = new DateTimeOffset(2018, 11, 22, 0, 0, 0, TimeSpan.Zero),
. Name = "Business process 11 modified",
. SelectedAssets = new List<AssetSelection>()
};
.
// Assigned assets will be replaced by assetSelection
BusinessProcessShort bps3 = new BusinessProcessShort()
{
. BusinessProcessId = 12,
. BusinessProcessType = BusinessProcessType.AssetLink,
. Description = "New description of business process 12",
. ExpirationDate = new DateTimeOffset(2020, 9, 10, 0, 0, 0, TimeSpan.Zero),
. Name = "Business process 12 modified",
. SelectedAssets = assetSelection
};
.
assetLinks.Add(bps1);
assetLinks.Add(bps2);
assetLinks.Add(bps3);
.
PictureparkService.UpdateAssetLinks(coreInfo, assetLinks);
Update asset metadata
The input of this method is the document element UpdateAssetMetadata having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id |
fieldValues | ArrayOfFieldValue | A list of FieldValues. |
fieldValues2Remove | ArrayOfFieldValue | A list of field values to be deleted. |
The output of this method is the document element UpdateAssetMetadataResponse that is always empty.
UpdateAssetMetadata
// Combine these 3 examples to update, create and delete asset metadata with one webservice call
//---------------------------------------------------------------------
// Example 1 (update field values):
//---------------------------------------------------------------------
int assetId = 47;
List<int> assetIds = new List<int> { assetId };
List<int> fieldIds = new List<int> { 1, 6 };
List<FieldValue> fieldValuesForUpdate = new List<FieldValue>();
string valueString;
int fieldOptionId;
.
List<AssetFieldValues> assetFieldValues =
. PictureparkService.GetAssetsMetadata(coreInfo, assetIds, fieldIds);
.
foreach (var assetFieldValue in assetFieldValues)
{
. foreach (FieldValue fieldValueForAsset in assetFieldValues.SelectMany(i => i.FieldValues).ToList())
. {
. valueString = null;
. fieldOptionId = 0;
.
. switch (fieldValueForAsset.FieldId)
. {
. case 1: // FieldId 1: AssetName (language specific)
. switch (fieldValueForAsset.LanguageId)
. {
. case 1: valueString = "Alte Frau"; break;
. case 2: valueString = "Old woman"; break;
. case 3: valueString = "Vielle femme"; break;
. }
. break;
.
. case 6: // FieldId 6: Copyright
. fieldOptionId = 290; break;
. }
.
. if (valueString != null)
. {
. fieldValueForAsset.ValueString = valueString;
. fieldValuesForUpdate.Add(fieldValueForAsset);
. }
. else if (fieldOptionId != 0)
. {
. fieldValueForAsset.FieldOptionId = fieldOptionId;
. fieldValuesForUpdate.Add(fieldValueForAsset);
. }
. }
.}
.
PictureparkService.UpdateAssetMetadata(coreInfo, assetId, fieldValuesForUpdate, null);
.
.
//---------------------------------------------------------------------
// Example 2 (create field values):
//---------------------------------------------------------------------
int assetId = 47;
List<int> assetIds = new List<int> { assetId };
List<FieldValue> fieldValuesForUpdate = new List<FieldValue>();
.
fieldValuesForUpdate.Add(
new FieldValue { FieldId = 96, ValueString = "Madagascar" }); // FieldId 96: Country
.
fieldValuesForUpdate.Add(
new FieldValue { FieldId = 93, ValueDate = DateTime.Now }); // FieldId 93: ExpiryDate
.
fieldValuesForUpdate.Add(
new FieldValue { FieldId = 94, ValueDateTime = DateTime.Now }); // FieldId 94: CaptureDate
.
PictureparkService.UpdateAssetMetadata(coreInfo, assetId, fieldValuesForUpdate, null);
.
.
//---------------------------------------------------------------------
// Example 3 (delete field values):
//---------------------------------------------------------------------
int assetId = 47;
List<int> assetIds = new List<int> { assetId };
List<int> fieldIds = new List<int> { 93, 97 }; // 93:ExpiryDate, 97:City
List<FieldValue> fieldValues2Remove = new List<FieldValue>();
.
List<AssetFieldValues> assetFieldValues =
. PictureparkService.GetAssetsMetadata(coreInfo, assetIds, fieldIds);
.
foreach (var assetFieldValue in assetFieldValues)
{
. foreach (FieldValue fieldValueForAsset in assetFieldValues.SelectMany(i => i.FieldValues).ToList())
. {
. if (fieldValueForAsset.FieldId == 93 || fieldValueForAsset.FieldId == 97)
. fieldValues2Remove.Add(fieldValueForAsset);
. }
}
.
PictureparkService.UpdateAssetMetadata(coreInfo, assetId, null, fieldValues2Remove);
Update metadata of several assets (batch update)
The input of this method is the document element UpdateAssetsMetadata having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetFieldValues | ArrayOfAssetFieldValues | The list of AssetFieldValues to be updated. |
assetFieldValues2Remove | ArrayOfAssetFieldValues | The list of AssetFieldValues to be removed. |
The output of this method is the document element UpdateAssetsMetadataResponse that is always empty.
UpdateAssetsMetadata
// Update/add some fields and delete other fields
List<AssetFieldValues> assetFieldValuesToChange = new List<AssetFieldValues>();
List<AssetFieldValues> assetFieldValuesToRemove = new List<AssetFieldValues>();
.
List<FieldValue> fieldValues1 = new List<FieldValue>
{
new FieldValue {FieldId = 2, ValueString = "Nebel", LanguageId = 1 },
new FieldValue {FieldId = 2, ValueString = "Fog", LanguageId = 2 },
new FieldValue {FieldId = 2, ValueString = "Brume", LanguageId = 3 },
new FieldValue {FieldId = 3, ValueString = "Mr.Spock" },
new FieldValue {FieldId = 6, FieldOptionId = 289},
new FieldValue {FieldId = 35,ValueUserShort = new UserShort {UserId = coreInfo.User.UserId}},
};
.
List<FieldValue> fieldValues2 = new List<FieldValue>
{
new FieldValue {FieldValueId = 1050, FieldId = 1},
new FieldValue {FieldValueId = 1528, FieldId = 3},
};
.
AssetFieldValues assetFieldValues1 = new AssetFieldValues()
{
AssetId = 505,
FieldValues = fieldValues1,
UrlThumbnailSmall = "https://picturepark.com/wp-content/uploads/2014/01/LearnDAM-Logo-150x150.png"
};
.
AssetFieldValues assetFieldValues2 = new AssetFieldValues()
{
AssetId = 505,
FieldValues = fieldValues2
};
.
assetFieldValuesToChange.Add(assetFieldValues1);
assetFieldValuesToRemove.Add(assetFieldValues2);
.
PictureparkService.UpdateAssetsMetadata(coreInfo, assetFieldValuesToChange, assetFieldValuesToRemove);
Sets default value(s) for the provided asset container ID / field set ID combination.
The input of this method is the document element UpdateFieldSetDefaultValue having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The asset container ID. |
fieldSetId | int | The field set ID to apply the new default value to. It can be obtained by calling GetFieldSetIdByFieldName |
defaultValues | ArrayOfFieldValue | The new default value. |
The output of this method is the document element UpdateFieldSetDefaultValueResponse that is always empty.
Set default value
// Set the default value of the field AssetDescription to 'Default Asset Description'.
var assetContainerId = 123;
var fieldName = "AssetDescription";
// Example for a non language specific string field
var newDefaultValues = new List<FieldValue>()
{
new FieldValue(){ ValueString = "Default Asset Description" }
};
// Example for a Language specific string field
var newDefaultValues = new List<FieldValue>()
{
new FieldValue(){ LanguageId = 2, ValueString = "Default Asset Description" },
new FieldValue(){ LanguageId = 1, ValueString = "Standard Asset Beschreibung" }
};
var fieldSetId = PictureparkService.GetFieldSetIdByFieldName(coreInfo, 123, fieldName);
PictureparkService.UpdateFieldSetDefaultValue(coreInfo, assetContainerId, fieldSetId, newFieldValues);
----------------------------------------------------------------------------------------------------------
// Set the default values of the field CarColor to 'Red' and 'Green'.
var assetContainerId = 987;
var fieldName = "CarColor";
// Example for a tag box
var newDefaultValues = new List<FieldValue>()
{
new FieldValue(){ ValueAssetContainerId = 110 }, // Red
new FieldValue(){ ValueAssetContainerId = 111 } // Green
};
var fieldSetId = PictureparkService.GetFieldSetIdByFieldName(coreInfo, assetContainerId, fieldName);
PictureparkService.UpdateFieldSetDefaultValue(coreInfo, assetContainerId, fieldSetId, newDefaultValues);
Replace the original file of an asset
The input of this method is the document element UpdateOriginalDerivative having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
renderingJobId | int |
The rendering job id. Each update must be assigned to a rendering job. Call CreateRenderingJob first to get a renderingJobId. This allows several updates to be pooled to one job. |
assetUpdateOptions | AssetUpdateOptions | Complex data type containing multiple update parameters. |
The output of this method is the document element UpdateOriginalDerivativeResponse that is always empty.
UpdateOriginalDerivative
//-------------------------------------------------------------------
// Example 1: Upload by default binding(no streaming):
//-------------------------------------------------------------------
int assetId = 49;
int renderingJobId = PictureparkService.CreateRenderingJob(coreInfo, RenderingClient.Update);
Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");
.
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
. AbsoluteImportFilePath = uri,
. AssetId = assetId
};
.
PictureparkService.UpdateOriginalDerivative(coreInfo, renderingJobId, assetUpdateOptions);
.
//-------------------------------------------------------------------
// Example 2: AssetUpdateOptions with additional data for history management
//-------------------------------------------------------------------
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
. AbsoluteImportFilePath = uri,
. AssetId = assetId,
.
. CreateHistoricVersion = true,
. HistoricVersionDescription = "Version 2012",
. HistoricVersionDescription4Master = "Version 2012 master",
. HistoricVersionName = "Version2012",
. HistoricVersionName4Master = "Version2012ForMaster",
. KeepAssetId4NewFileOnHistorize = true,
};
.
//-------------------------------------------------------------------
// Example 3: Using guid and mtom
//-------------------------------------------------------------------
int assetId = 49;
string fileName = "cactus.jpg"; // with extension!
int renderingJobId = PublicService.CreateRenderingJob(coreInfo, RenderingClient.Update);
Guid? guid;
.
using (FileStream fileStream = new FileStream(@"E:\cactus.jpg", FileMode.Open))
. guid = PictureparkServiceMtom.UploadFile(fileStream);
.
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
. AssetId = assetId,
. FileName = fileName,
. ImportGuid = guid,
. CreateHistoricVersion = true
};
.
PictureparkServiceMtom.UpdateOriginalDerivative(coreInfo, renderingJobId, assetUpdateOptions);
Update user data
The input of this method is the document element UpdateUser having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
userData | UserData | The (modified) UserData. |
The output of this method is the document element UpdateUserResponse that is always empty.
PictureparkErrorType InsufficientRights
> the current user does not have the UserGroupRight EditUsers for the update user.
> the current user does not have the UserGroupRight AssignUsers for all user groups to which the update user is assigned.
PictureparkErrorType EmailAlreadyInUse: the email has been changed and a user with this email exists already.
An exception is thrown, if not all required field values are present and content matches with content rules.
UpdateUser
// Update user data for user 55.
.
int userId = 55;
UserData userData = PictureparkService.GetUserById(coreInfo, userId);
userData.City = "Aarau";
userData.Zip = "5000";
.
PictureparkService.UpdateUser(coreInfo, userData);
Upload file by chunks. Use this method to upload the remaining chunks following the first chunk uploaded by UploadFirstChunk.
The input of this method is the document element UploadChunk having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
transferGuid | guid | The guid which has been returned by UploadFirstChunk |
buffer | base64Binary | The buffer containing the chunk |
offset | long | The start index of the current chunk in the source/destination file. |
The output of this method is the document element UploadChunkResponse that is always empty.
UploadChunk
// Upload the first chunk of a file by streaming and then use the guid to upload the rest in chunks.
.
string filePath = @"D:\TheSlip.jpg";
.
int chunkSizeInByte = 1024 * 1024 * 10;
Guid transferGuid = Guid.Empty;
.
using (FileStream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read))
{
byte[] transferBuffer;
byte[] chunkBuffer = new byte[chunkSizeInByte];
long bytesToRead = fileStream.Length;
long bytesRead = 0;
int bytesInBuffer;
.
while (bytesToRead > 0)
{
bytesInBuffer = fileStream.Read(chunkBuffer, 0, chunkSizeInByte);
.
if (bytesInBuffer == 0)
break;
.
transferBuffer = chunkBuffer;
.
if (bytesInBuffer < chunkSizeInByte)
{
transferBuffer = new Byte[bytesInBuffer];
Buffer.BlockCopy(chunkBuffer, 0, transferBuffer, 0, bytesInBuffer);
}
.
if (bytesRead == 0)
transferGuid = PictureparkService.UploadFirstChunk(coreInfo, transferBuffer);
else
PictureparkService.UploadChunk(coreInfo, transferGuid, transferBuffer, bytesRead);
.
bytesRead += bytesInBuffer;
bytesToRead -= bytesInBuffer;
}
}
Upload a file by streaming
The input of this method is the document element UploadFile having the structure defined by the following table.
Element | Type | Description |
---|---|---|
stream | StreamBody | A file stream |
The guid of the uploaded file, which must then be submitted to ImportSingleAsset.
Element | Type | Description |
---|---|---|
UploadFileResult | guid | |
Uploading by streaming is the preferred method for performance reasons and should be used if available.
In order to use streaming you must use the mtom binding (see example).
The mtom bindung can be used for all webservices. No need to use the default binding, if mtom is available.
See under ImportSingleAsset how to use the guid.
UploadFile
// Upload a file by streaming and then use the guid to import an asset.
.
// Create mtom binding
ExtendedPublicServiceClient PictureparkServiceMtom = new ExtendedPublicServiceClient("Mtom");
.
Guid? guid = null;
using (FileStream fileStream = new FileStream(@"E:\Temp\dog.jpg", FileMode.Open))
. guid = PictureparkServiceMtom.UploadFile(fileStream);
Upload file by chunks. Use this method to upload the first chunk.
The input of this method is the document element UploadFirstChunk having the structure defined by the following table.
Element | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
buffer | base64Binary | The buffer containing the first chunk. |
The guid to upload the remaining chunks by calling UploadChunk. This is also the guid which must then be submitted to ImportSingleAsset call.
Element | Type | Description |
---|---|---|
UploadFirstChunkResult | guid | |
UploadFirstChunk
// Upload the first chunk of a file by streaming and then use the guid to upload the rest in chunks by calling UploadChunk().
.
Guid? guid = null;
string filePath = @"D:\TheSlip.jpg";
int chunkSizeInByte = 100000;
byte[] chunkBuffer = new byte[chunkSizeInByte];
.
using (FileStream fileStream = new FileStream(filePath, FileMode.Open))
. fileStream.Read(chunkBuffer, 0, chunkSizeInByte);
.
guid = PictureparkService.UploadFirstChunk(coreInfo, chunkBuffer);
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperations | ArrayOfComparisonOperation | |
LogicalOperations | ArrayOfLogicalOperation | |
Element AndOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerAssignmentExtended | AssetContainerAssignmentExtended | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerComparisonOperation | AssetContainerComparisonOperation | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerIndex | AssetContainerIndex | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerItem | AssetContainerItem | An AssetContainerItem represents the attributes of one asset container including relations to other asset containers. |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerLogicalOperation | AssetContainerLogicalOperation | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRight | AssetContainerRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTotalAssets | AssetContainerTotalAssets | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTranslation | AssetContainerTranslation | Language specific data of one asset container. One item per asset container language. |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetFieldValues | AssetFieldValues | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetItem | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
Element ArrayOfAssetItem
Element ParentAsset [type AssetMetadata]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetObject | AssetObject | |
Element ArrayOfAssetObject
Element AssetObjects [type DocumentPage]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetRight | AssetRight | |
Element ArrayOfAssetRight
Element AssetRights [type AssetItem]
Element AssetRights [type AssetMetadata]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetSelection | AssetSelection | |
Element ArrayOfAssetSelection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Element ArrayOfAssetVersion
Element AssetVersions [type AssetItem]
Element GetAssetVersionsResult [element GetAssetVersionsResponse]
Element MasterVersions [type AssetItem]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioStream | AudioStream | |
Element ArrayOfAudioStream
Element AudioStreams [type MediaInfo]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessLink | BusinessProcessLink | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessShort | BusinessProcessShort | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroup | ClaimGroup | |
Element ArrayOfClaimGroup
Element ClaimGroups [type UserGroupItem]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperation | ComparisonOperation | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Country | Country | |
Element ArrayOfCountry
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CountryTranslation | CountryTranslation | |
Element ArrayOfCountryTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Derivative | Derivative | A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
Element ArrayOfDerivative
Element Derivatives [type AssetItem]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinition | DerivativeDefinition | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinition2AssetType | DerivativeDefinition2AssetType | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRight | DerivativeDefinitionRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRights | DerivativeDefinitionRights | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionTranslation | DerivativeDefinitionTranslation | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeRight | DerivativeRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Document | Document | |
Element ArrayOfDocument
Element Documents [type AssetMetadata]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DocumentPage | DocumentPage | |
Element ArrayOfDocumentPage
Element DocumentPages [type Document]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ExtendedDerivative | ExtendedDerivative | An extended derivative provides more detailed information than the usual derivative. |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationElement | FacetConfigurationElement | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationGroup | FacetConfigurationGroup | |
Element ArrayOfFacetConfigurationGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationRange | FacetConfigurationRange | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationTranslation | FacetConfigurationTranslation | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetResult | FacetResult | |
Element ArrayOfFacetResult
Element Group [type FacetResult]
Element Results [type FacetResults]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetSearchParameter | FacetSearchParameter | |
Element ArrayOfFacetSearchParameter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetValue | FacetValue | |
Element ArrayOfFacetValue
Element Values [type FacetResult]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Field | Field | Defines the attributes of a Field (Asset-, User- or AssetContainerField) |
Element ArrayOfField
Element GetAssetFieldsResult [element GetAssetFieldsResponse]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOption | FieldOption | |
Element ArrayOfFieldOption
Element Options [type Field]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOptionTranslation | FieldOptionTranslation | |
Element ArrayOfFieldOptionTranslation
Element Translations [type FieldOption]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldRight | FieldRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldTranslation | FieldTranslation | |
Element ArrayOfFieldTranslation
Element Translations [type Field]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Element ArrayOfFieldValue
Element FieldValues [type AssetMetadata]
Element FieldValues [type UserData]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
float | float | |
Element ArrayOffloat
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element ArrayOfint
Element assetContainerIds [element AddAssets2AssetContainers]
Element assetContainerIds [element RemoveAssetsFromAssetContainers]
Element assetIds [element RemoveAssets]
Element AssetTypeIds [type Field]
Element exceptedAssetContainerIds [element SaveAssetContainerRights]
Element FieldIdsOfUncollapsedFacets [type FacetSearchParameter]
Element FieldSetIds [type AssetItem]
Element UserGroupIds [type UserData]
Element UserGroups [type User]
Element userIds [element RemoveUsers]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfFieldRightuUS27HWe | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfPersonalItemRightuUS27HWe | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfSiteRightuUS27HWe | anyType (restriction) | |
Element SiteRights [type Rights]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfUserGroupRightuUS27HWe | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfWidgetRightuUS27HWe | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintPortViewField6jg_STziK | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KnownFieldValue | KnownFieldValue | |
Element ArrayOfKnownFieldValue
Element FieldValues [type AssetItem]
Element FieldValues [type UserShort]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4AssetContainer | Language4AssetContainer | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Content | Language4Content | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4FullTextIndex | Language4FullTextIndex | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Metadata | Language4Metadata | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4UserInterface | Language4UserInterface | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Version | Language4Version | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LanguageFallback | LanguageFallback | |
Element ArrayOfLanguageFallback
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LdapSecurityGroup | LdapSecurityGroup | |
Element ArrayOfLdapSecurityGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LogicalOperation | LogicalOperation | |
Element ArrayOfLogicalOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
MediaInfo | MediaInfo | |
Element ArrayOfMediaInfo
Element MediaInfos [type AssetMetadata]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
MetadataProperty | MetadataProperty | |
Element ArrayOfMetadataProperty
Element MetadataMapping [type Field]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PersonalItemRight | PersonalItemRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PortAssetItem | PortAssetItem | An AssetItem represents the attributes of one asset including relations to other assets. The structure is built to be directly shwoed in web |
Element ArrayOfPortAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PortDerivative | PortDerivative | A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionArgumentValue | RenderingActionArgumentValue | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionValue | RenderingActionValue | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate | RightTemplate | |
Element ArrayOfRightTemplate
Element RightTemplates [type Rights]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2AssetType | RightTemplate2AssetType | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2Right | RightTemplate2Right | |
Element ArrayOfRightTemplate2Right
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2UserGroup | RightTemplate2UserGroup | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SiteRight | SiteRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SortInfo | SortInfo | |
Element ArrayOfSortInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserActionHistoryInfo | UserActionHistoryInfo | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserDerivativeRights | UserDerivativeRights | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetContainerRights | UserGroupAssetContainerRights | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetRights | UserGroupAssetRights | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupDerivativeRights | UserGroupDerivativeRights | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupRight | UserGroupRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupTranslation | UserGroupTranslation | |
Element ArrayOfUserGroupTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserRight | UserRight | |
Element ArrayOfUserRight
Element UserRights [type Rights]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserShort | UserShort | |
Element ArrayOfUserShort
Element Users [type UserCollection]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
VideoStream | VideoStream | |
Element ArrayOfVideoStream
Element VideoStreams [type MediaInfo]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
WidgetRight | WidgetRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
XmpItem | XmpItem | |
Element ArrayOfXmpItem
Element children [type XmpItem]
Element XmpItems [type AssetMetadata]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperations | ArrayOfAssetContainerComparisonOperation | |
LogicalOperations | ArrayOfAssetContainerLogicalOperation | |
Element AssetContainerAndOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
FieldId | int | |
Element AssetContainerAssignment
Complex Type AssetContainerAssignmentExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
FieldId | int | |
AssetContainerType | AssetContainerType | |
ExclusivityGroupId | int | |
FieldSetIds | ArrayOfint | |
IconId | int | |
Indexes | ArrayOfAssetContainerIndex | |
Translations | ArrayOfAssetContainerTranslation | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Element AssetContainerComparisonOperation [type ArrayOfAssetContainerComparisonOperation]
Complex Type AssetContainerExcludeOperation
Complex Type AssetContainerIncludeOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Element AssetContainerExcludeOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Element AssetContainerIncludeOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsolutePath | string | |
AbsolutePathById | string | |
AssetContainerIndexId | int | |
LanguageId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedRightTemplateId | int | The id of the applied right template.Is ignored, if IsRightTemplateOverridden = true |
AssetContainerId | int | The id of the asset container. |
AssetContainerName | string | The asset container name depends on the parameter desiredAssetContainerLanguage in GetAssetContainers. |
AssetContainerType | AssetContainerType | The asset container type, either Category or AssetClass. |
Children | ArrayOfAssetContainerItem | An array with child AssetContainerItems. |
CreatedByUserId | int | The id of the user who created the container. |
CreationDate | DateTimeOffset | The creation date. |
ExclusivityGroupId | int |
The id of an exclusivity group. An exclusivity group is a list of mutually exclusive categories, e.g. countries or sex. In the case of countries an exclusivity group would prevent an asset to be assigned to more than one countries, in the case of sex it could be assigned to either male or female, but not to both. |
FieldSetIds | ArrayOfint |
A list of assigned field set ids. FieldSetIds define which fields are assigned to an asset container. Needed for AssetClasses. |
IconId | int | The id of the icon used for the display of the asset container. |
Indexes | ArrayOfAssetContainerIndex | An array with the indexes for each asset container language (contains the language specific absolute paths, e.g. "animals\pets\dogs\") |
IsRightTemplateOverridden | boolean | If true, the applied right template is ignored and the rights particularly assigned to this asset container are applied. |
ModificationDate | DateTimeOffset | The modification date. |
ModifiedByUserId | int | The id of the last user who edited the container. |
ParentAssetContainerId | int | The id of the parent asset containert, is null for containers on the highest level. |
Permissions | ArrayOfAssetContainerRight | An array with the AssetContainerRights for the current user. |
SortChildrenAlphabetically | boolean |
Flag: sort child nodes alphabetically. If true, child nodes are sorted alphabetically and sort order numbering is ignored. |
SortOrder | int | The relative sort order of siblings. |
SubAssetContainers | int | The number of child nodes (children only, not grand children etc). |
Translations | ArrayOfAssetContainerTranslation | An array with the AssetContainerTranslations (names and descriptions) for each asset container language. |
ts | base64Binary | |
Element AssetContainerLogicalOperation [type ArrayOfAssetContainerLogicalOperation]
Element AssetContainerLogicalOperation
Element AssetContainerSearchOperation [type ExtendedAssetFilter]
Complex Type AssetContainerAndOperation
Complex Type AssetContainerOrOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperations | ArrayOfAssetContainerComparisonOperation | |
LogicalOperations | ArrayOfAssetContainerLogicalOperation | |
Element AssetContainerOrOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
TotalAssets | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetContainerTranslationId | int | |
Description | string | The asset container description in the language defined by LanguageId. |
LanguageId | int | The language id (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..). |
Name | string | The asset container name in the language defined by LanguageId. |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | The asset id. |
FieldSetIds | ArrayOfint | The fieldSetIds for this asset. |
FieldValues | ArrayOfFieldValue | Array of field values for this asset. |
UrlThumbnailSmall | string | The small thumbnail for preview in batch editor. |
Element AssetFieldValues
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
Element AssetFilter
Complex Type ExtendedAssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerIds | ArrayOfint |
List of the AssetClass ids to be assigned to the asset. Not nillable, but the list may be empty. An AssetClass defines the available attributes of an asset. It is implemented as a new type of asset container alongside categories. Category assignments are now an asset field value for an asset field of type ValueAssetContainerAssignment. See under param FieldValues for an example. |
AssetRightTemplateId | int | The id of an AssetRightTemplate. |
AssetVersions | ArrayOfAssetVersion | Optional. List of asset versions. |
DerivativeRightTemplateId | int | The id of a DerivativeRightTemplate. |
FieldValues | ArrayOfFieldValue |
List of field values. Which field values are required - and must therefore be submitted - depends on the configuration of this Picturepark. Please note: categories are defined as a special field value of type ValueAssetContainerAssignment (see code example).
|
FileName | string | The file name with extension, needed only for an upload by MTOM. |
ImportGuid | guid |
Needed only for an upload by MTOM.
|
ImportRelativeFilePath | string | Needed only for batch import, which is not available for public webservices. |
ImportUrl | string |
The url of the file to be imported, not needed for upload by MTOM. For an upload by MTOM (recommended) the ImportGuid is needed instead.
|
IsAssetRightTemplateOverridden | boolean |
Optional. If true, the assigned AssetRightTemplateId is ignored and rights specifically assigned to this asset are applied. Default is false. If true, UserGroupAssetRights must be provided. |
IsDerivativeRightTemplateOverridden | boolean | Optional. If true, the assigned DerivativeRightTemplateId is ignored and rights specifically assigned to this derivative are applied. Default is false. |
OnlyCreateOriginalDerivative | boolean |
Optional. If true, derivatives are not created (except the original derivative). Default is false. Needed only in special cases where the user wishes to import his own derivatives. |
UserGroupAssetRights | ArrayOfUserGroupAssetRights |
The assignment of certain rights for certain groups to this asset. Needed only if IsAssetRightTemplateOverridden = true.
|
UserGroupDerivativeRights | ArrayOfUserGroupDerivativeRights | Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter. |
Element AssetImportOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the asset right template. Is ignored, if IsAssetRightTemplateOverridden = true. |
AppliedDerivativeRightTemplateId | int | The id of the derivative right template. Is ignored, if IsDerivativeRightTemplateOverridden = true. |
AssetId | int | The asset id. |
AssetRights | ArrayOfAssetRight | An array with all AssetRights for the current user. |
AssetTypeId | AssetType | In Picturepark, assets are categorized into AssetTypes according to their file extensions. |
AssetVersions | ArrayOfAssetVersion |
An array with all AssetVersions for this asset. In Picturepark, the version logic is implemented as an assignment of one or more assets to a parent asset. Thus, an asset can either have a parent or be a parent. AssetVersion contains the assets, for which it is the parent, while MasterVersions contain the parents. Currently, version types are either language versions or slides. |
AvailableDerivativeDefinitions | ArrayOfint | An array with all available derivative definitions for this asset, ignoring the Usergroups rights. Needed to order derivatives which the user has no right to download. |
Derivatives | ArrayOfDerivative |
An array of Derivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
FieldSetIds | ArrayOfint |
A list of assigned field set ids. FieldSetIds define which fields are assigned to an asset. Needed for AssetClasses. |
FieldValues | ArrayOfKnownFieldValue |
Array of KnownFieldValues. This array contains one entry for each field value. For which fields the values are returned depends on the parameters AdditionalSelectFields in ExtendedAssetFilter. |
IsAssetRightTemplateOverridden | boolean | If true, the applied asset right template is ignored and the rights particularly assigned to this asset are applied. |
IsDerivativeRightTemplateOverridden | boolean | If true, the applied derivative right template is ignored and the rights particularly assigned to the derivatives are applied. |
MasterVersions | ArrayOfAssetVersion | See above under AssetVersions. |
XmpOutOfSync | boolean | Technical flag concerning the rendering state. |
XmpSyncFailed | boolean | Technical flag concerning the rendering state. |
Element Asset [type AssetVersion]
Element AssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AllQueryAssetIds | ArrayOfint |
A list of all asset ids in the query. This list is only returned if the param ReturnAllQueryAssetIds in the AssetFilter is true. These asset ids are not necessarily identical with the assets items in the Assets property, e.g. due to the Limit parameter. |
Assets | ArrayOfAssetItem | An array of AssetItem. |
MediaTypeCounts | ArrayOfint |
The number of assets per media type in the order of MediaTypeId. E.g. 111,22,33. 111 assets belong to the first media type (e.g. "all"), 22 to the second and 33 to the third etc. Please note: as with TotalAssets, these figures refer to the whole query, not just to the assets returned. |
TotalAssets | int |
The number of assets in the query. Please note: this figure is not necessarily identical with the number of AssetItems. Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter. |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the assigned right template. |
AppliedDerivativeRightTemplateId | int | The id of the right template used to define the access rights for the derivative formats. |
AssetContainerAssignments | ArrayOfAssetContainerAssignmentExtended |
An array with all AssetContainerAssignmentExtendeds for this asset. An asset can be assigned to many asset containers. |
AssetRights | ArrayOfAssetRight | array with all AssetRights for the current user. |
AssetTypeId | AssetType | Bitmap, VectorGraphic, TextDocument, Audio, Video .. |
AssetVersions | ArrayOfAssetVersion |
An array with all AssetVersions for this asset. This array contains all asset versions which have this asset as a parent. |
DerivativeLock | DerivativeLock | DerivativeLock. If not null this asset is locked. |
Derivatives | ArrayOfExtendedDerivative |
An array with all assigned ExtendedDerivatives to which access rights exist. Please note: the data for the original are returned independently of access rights in the property OriginalDerivative. |
Documents | ArrayOfDocument | An array with all assigned Documents. |
FieldValues | ArrayOfFieldValue | An array with all FieldValues for this asset. |
IsAssetRightTemplateOverridden | boolean | If true, there are more specific access rights defined for this asset and the settings of the AppliedAssetRightTemplateId are ignored. |
IsDerivativeRightTemplateOverridden | boolean | Same logic as with IsAssetRightTemplateOverridden. |
MasterVersions | ArrayOfAssetVersion |
An array with all master AssetVersions for this asset. This array contains all assets which are a parent version for this asset. |
MediaInfos | ArrayOfMediaInfo | A list of MediaInfos if the asset is an audio or a video. |
OriginalDerivative | ExtendedDerivative |
Original ExtendedDerivative. The data for the original are always returned, even if there are no access rights to the original. |
ParentAsset | ArrayOfAssetItem |
An array with all parent AssetItems. An asset can have more than one parent. |
ParentAssetId | int | The id of the parent asset. |
ReferencedAssets | ArrayOfAssetItem | An array with all AssetItems to which this asset refers (from Documents). |
ReferringAssets | ArrayOfAssetItem | An array with all AssetItems which refer to this asset (from AssetObjects). |
XmpItems | ArrayOfXmpItem | An array with XmpItems if the asset is an image and metadata mapping is enabled. |
Element AssetMetadata
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
AssetObjectId | int | |
AssetObjectType | AssetObjectType | |
CommentId | int | |
DerivativeDefinitionId | int | |
DocumentPageId | int | |
HeightInCm | double | |
JsonSerializedSvgAttributes | string | |
LinkedAssetId | int | |
LinkedUrl | string | |
PositionLeftInCm | double | |
PositionTopInCm | double | |
RelativeFilePath | string | |
SortOrder | int | |
WidthInCm | double | |
ts | base64Binary | |
Element AssetObject
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
Element AssetSelection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteImportFilePath | anyURI |
The uri of the import file path. Not needed if MTOM is used.
|
AssetId | int | The asset id. |
CreateHistoricVersion | boolean | Optional. If true, the old asset is not overwritten, but kept as a historic version. Default is false. |
DeleteDependentAssets | boolean | Optional. If true, dependent assets like versions are deleted. Default is false. |
FileName | string | The file name, which must have an extension. Needed only for an upload by MTOM. |
HistoricVersionDescription | string | Optional. Same logic as HistoricVersionName. |
HistoricVersionDescription4Master | string | Optional. Same logic as HistoricVersionName4Master. |
HistoricVersionName | string | Optional. The name of the newly created historic version (if param CreateHistoricVersion = true). |
HistoricVersionName4Master | string | Optional. The historic version name of the newly uploaded asset (if param CreateHistoricVersion = true). |
ImportGuid | guid |
The guid, needed for an upload by MTOM (as is recommended). Please note: the file name, which must have an extension, is also needed for an upload by MTOM.
|
KeepAssetId4NewFileOnHistorize | boolean | If true, the new file inherits the asset id of the old. |
OnlyCreateOriginalDerivative | boolean |
Optional. If true, derivatives are not created (except the original derivative). Default is false. Needed only in special cases where the user wishes to import his own derivatives. |
TemporaryFileHandling | TemporaryFileHandling |
Optional. How to handle the temporary files. Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.
|
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Asset | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
AssetVersionId | int | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Description | string | |
LanguageId | int | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
ParentAssetId | int | The id of the parent asset. Null, if this version is a master. |
SortOrder | int | |
Version | string | The name of the version, e.g. "English" or "French". |
VersionOptionId | int | |
VersionTypeId | int |
Versiontypes are e.g. Languages, History, Associated, Presentation etc. They are individually configurable for each Picturepark. Language usually exists and has the id = 1. |
ts | base64Binary | |
Element AssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioBitRate | int | |
AudioBitRateMode | BitrateMode | |
AudioChannelPositions | string | |
AudioChannels | int | |
AudioCodec | string | |
AudioDuration | duration | |
AudioFormat | string | |
AudioLanguage | string | |
AudioResolution | int | |
AudioSamplingRate | int | |
AudioStreamSize | long | |
Element AudioStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
BusinessProcessUrl | anyURI | |
DerivativeDefinitionId | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessId | int | |
BusinessProcessType | BusinessProcessType | |
Description | string | |
ExpirationDate | DateTimeOffset | |
FacetConfigurationId | int | |
LinkToken | string | |
MailingUrl | anyURI | |
MailingUrlForDownload | anyURI | |
MailingUrlsForDownload | ArrayOfBusinessProcessLink | |
MailingUrlsForView | ArrayOfBusinessProcessLink | |
Name | string | |
SelectedAssets | ArrayOfAssetSelection | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GroupSid | string | |
IdentityProviderId | int | |
UserGroupId | int | |
UserGroups2ClaimGroupId | int | |
Element ClaimGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Element ComparisonOperation [type ArrayOfComparisonOperation]
Element ComparisonOperation
Complex Type AssetContainerExcludeFieldOperation
Complex Type AssetContainerIncludeFieldOperation
Complex Type DateTimeAfterOperation
Complex Type DateTimeBeforeOperation
Complex Type DateTimeBetweenOperation
Complex Type DateTimeEqualOperation
Complex Type DateTimeNowAfterOperation
Complex Type DateTimeNowAfterOrEqualOperation
Complex Type DateTimeNowBeforeOrEqualOperation
Complex Type DateTimeNowLastOperation
Complex Type DateTimeNowNextOperation
Complex Type DateTimeNowOlderOperation
Complex Type NumericBetweenOperation
Complex Type NumericEqualOperation
Complex Type NumericLargerThanOperation
Complex Type NumericListEqualOperation
Complex Type NumericNotEqualOperation
Complex Type NumericSmallerThanOperation
Complex Type StringContainsOperation
Complex Type StringEmptyOperation
Complex Type StringEqualOperation
Complex Type StringListContainsExactOperation
Complex Type StringListContainsOperation
Complex Type StringListEqualOperation
Complex Type StringNotContainsOperation
Complex Type StringNotEmptyOperation
Complex Type StringNotEqualOperation
Complex Type StringStartsWithOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element coreInfo [element CreateUser]
Element coreInfo [element Download]
Element coreInfo [element GetAssets]
Element coreInfo [element GetAssets2]
Element coreInfo [element GetFacets]
Element coreInfo [element GetMetadata]
Element coreInfo [element GetRights]
Element coreInfo [element GetUserById]
Element coreInfo [element GetUsers]
Element coreInfo [element IsValid]
Element coreInfo [element Login]
Element coreInfo [element RemoveAssets]
Element coreInfo [element RemoveUsers]
Element coreInfo [element RenewSession]
Element coreInfo [element UpdateUser]
Element coreInfo [element UploadChunk]
Element CoreInfo
Element LoginWithSecurityToken2Result [element LoginWithSecurityToken2Response]
Element LoginWithSecurityTokenResult [element LoginWithSecurityTokenResponse]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Code | string | |
CountryId | int | |
Name | string | |
Element Country [type ArrayOfCountry]
Element Country [type UserData]
Element Country
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CountryId | int | The id of the country. |
CountryName | string |
The name of the country in german(1), english(2) or french(3). E.g. "Deutschland", "Germany", "Allemagne". |
CountryTranslationId | int | |
LanguageId | int |
The id of the language which determines the country name (NOT the language spoken in this country). Country names are available in the languages: 1:german, 2:english, 3:french. |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
AfterDateTime | DateTimeOffset | |
Element DateTimeAfterOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
BeforeDateTime | DateTimeOffset | |
Element DateTimeBeforeOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
AfterDateTime | DateTimeOffset | |
BeforeDateTime | DateTimeOffset | |
Element DateTimeBetweenOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualDateTime | DateTimeOffset | |
Element DateTimeEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Element DateTimeNowAfterOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Element DateTimeNowAfterOrEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Element DateTimeNowLastOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Element DateTimeNowNextOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Element DateTimeNowOlderOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Element CreationDate [type AssetVersion]
Element CreationDate [type Skin]
Element CreationDate [type UserData]
Element CreationDate [type UserShort]
Element DateTimeOffset
Element ExpirationDate [type UserData]
Element ExpirationDate [type UserShort]
Element GetConfigurationModificationDateResult [element GetConfigurationModificationDateResponse]
Element LastLoginDate [type UserData]
Element LastLoginDate [type UserShort]
Element LockDate [type UserData]
Element LockDate [type UserShort]
Element ModificationDate [type Skin]
Element ModificationDate [type UserData]
Element OriginalDerivativeModificationDate [type DerivativeLock]
Element RenewalUntilDate [type UserData]
Element ValueDate [type FieldValue]
Element ValueDateTime [type FieldValue]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
DerivativeId | int | |
FileExtensionId | int | |
FileName | string | E.g. "Matterhorn1.jpg". |
FileSizeInBytes | long | |
ImageHeight | int | |
ImageWidth | int | |
PublicAbsoluteUrl | string | E.g. http://picturepark.vit.local/Public/1/ThumbnailSmall/1031.jpg. |
RenderingState | RenderingState | Technical flag concerning the rendering state. |
VideoDurationInSeconds | double | |
VideoHeight | int | |
VideoWidth | int | |
ts | base64Binary | |
Element Derivative
Complex Type ExtendedDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioBitrate | int | |
AudioQuality | int | |
AudioSamplingFrequency | int | |
AudioUse4Preview | boolean | |
AvPresetId | guid | |
DerivativeDefinition2AssetTypes | ArrayOfDerivativeDefinition2AssetType | |
DerivativeDefinitionId | int | |
DerivativeType | DerivativeType | |
Group | int | |
IconId | int | |
ImageColorProfileId | int | |
ImageColorTransformationIntentId | int | |
ImageEncodingOptionId | int | |
ImageKeepClippingPath | boolean | |
ImageResolution | int | |
Name | string | |
OutputFileExtensionId | int | |
ProvideAsDownload | boolean | |
RelativeBasePath | string | |
RenderingActionValues | ArrayOfRenderingActionValue | |
SortOrder | int | |
TrackUsagePurpose | boolean | |
Translations | ArrayOfDerivativeDefinitionTranslation | |
Use4AssetConversion | boolean | |
UseGuid4FileName | boolean | |
UsePublicFileDirectory | boolean | |
UseVideo4Thumbnails | boolean | |
VideoAudioBitrate | int | |
VideoAudioCodecId | int | |
VideoBitrate | int | |
VideoCodecId | int | |
WriteXmp2File | boolean | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetTypeId | int | |
DerivativeDefinition2AssetTypeId | int | |
DerivativeDefinitionId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionId | int | |
DerivativeRights | ArrayOfDerivativeRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionId | int | |
DerivativeDefinitionTranslationId | int | |
Description | string | |
LanguageId | int | |
Name | string | |
ShortName | string | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteCheckoutFilePath | string | |
AssetId | int | |
CheckoutReason | string | |
ClientComputerName | string | |
ClientFileModificationDate | DateTimeOffset | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
DerivativeDefinitionId | int | |
DerivativeId | int | |
DerivativeLockId | int | |
DerivativeModificationDate | DateTimeOffset | |
DerivativeModifiedByUser | UserCompact | |
FieldValues | ArrayOfKnownFieldValue | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
OriginalDerivativeModificationDate | DateTimeOffset | |
UrlThumbnailSmall | string | |
UserId | int | |
ts | base64Binary | |
Element DerivativeLock
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteImportFilePath | anyURI |
The uri of the import file path. Not needed if MTOM is used.
|
AssetId | int | The asset id. |
DerivativeDefinitionId | int | The deriviative definition id. |
FileName | string | The file name, which must have an extension. Needed only for an upload by MTOM. |
ImportGuid | guid |
The guid, needed for an upload by MTOM (as is recommended). Please note: the file name, which must have an extension, is also needed for an upload by MTOM.
|
TemporaryFileHandling | TemporaryFileHandling |
Optional. How to handle the temporary files. Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.
|
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DocumentId | int | |
DocumentPages | ArrayOfDocumentPage | |
LargePageImageMaxHeight | int | |
LargePageImageMaxWidth | int | |
SmallPageImageMaxHeight | int | |
SmallPageImageMaxWidth | int | |
ts | base64Binary | |
Element Document [type ArrayOfDocument]
Element Document
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetObjects | ArrayOfAssetObject | |
DocumentId | int | |
DocumentPageId | int | |
HeightInCm | double | |
LargePageImageResolution | double | |
LargePageImageUrl | string | |
PageNumber | int | |
RotationInDegrees | int | |
SmallPageImageResolution | double | |
SmallPageImageUrl | string | |
WidthInCm | double | |
ts | base64Binary | |
Element DocumentPage
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsolutePath | string | |
AvailableUntilDate | DateTimeOffset | |
DownloadFileName | string | |
DownloadToken | string | |
FileSize | long | |
URL | string | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessId | int |
A mailing id. Valid only in combination with a valid MailingToken. Needed for access rights, does not cause the download to return all assets in a mailing. |
BusinessProcessToken | string | Token for a business process, must be given in combination with a BusinessProcessId. |
CreateZip4SingleFile | boolean | If false and the download contains only one file, then the file is not zipped. |
KeepOriginalFileName | boolean | If false the original filename is taken and the configured download filename rules are ignored. |
MailingRecipientId | int | Needed only for logging purposes. |
UsagePurpose | string | Any text, needed only for logging purposes. |
UserAction | UserAction | Needed for logging purposes. Must be one of DerivativeDownload, DerivativeView or AssetReplication. |
Element DownloadOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
AssetContainerSearchOperation | AssetContainerLogicalOperation |
Optional. Define from which asset containers to get assets. See the general API docu overview for further examples! // EXAMPLE: Get assets from asset container id 123 plus all sub-containers: |
AssetTypeIds | ArrayOfint |
Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images. Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized. Default: all AssetTypeIds = new List<int> {2, 6, 20} |
Limit | int | Optional. The maximal number of assets returned. Default is unlimited. |
MediaTypeIds | ArrayOfint |
Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies. Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia". Default: all MediaTypeIds = new List<int> {1,4,3} |
ReturnMediaTypeCounts | boolean |
Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned. For performance reasons, this paramter should be set to false if not needed. Default: false |
SearchDesiredMetadataLanguageOnly | boolean | Optional. If true, a search is done only within language specific metadata. Default: false. |
SearchOnlyDeletedAssets | boolean | Optional. |
SearchOperation | LogicalOperation |
Optional. Define search parameters for a complex search. See the general API docu overview for further examples! See ComparisonOperation for available operators. // EXAMPLE: Get asset with AssetId 111: |
SimpleSearchString | string |
Optional. Use simple search, if you wish to search within all fields for a simple string.
|
SortInfos | ArrayOfSortInfo |
Sort parameters: the asset field and the direction (ascending or descending). This is the only required parameter! You may define several sort infos, e.g. AssetName asc, AssetId desc. List<SortInfo> sortInfos = new List<SortInfo>(); |
StartRow | int | Optional. The row in the query, from where on to return the assets. Default is 0. |
UnassignedAssetsOnly | boolean | Optional. If true, only assets which are in no category are returned. Default: false. |
VersionTypeIds | ArrayOfint |
Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions). This is not a filter for the assets, thus has no impact on the number of assets returned by the query. VersionTypeIds = new List<int> { 1, 3 } |
Element assetFilter [element GetAssets2]
Element ExtendedAssetFilter
Element InitialAssetFilter [type FacetConfigurationExtended]
Example
ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
DesiredMetadataLanguage = ApplicationLanguage.English,
Limit = 10,
MediaTypeIds = new List<int> { 8, 9, 10 },
SortInfos = new List<SortInfo> { new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Asc } },
SimpleSearchString = "mail",
StartRow = 100,
VersionTypeIds = new List<int> { 1, 4 }
};
Contains elements as defined in the following table.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
IsInitiallyOpen | boolean | |
Ranges | ArrayOfFacetConfigurationRange | |
SelectionBehavior | FacetInnerSelectionBehavior | |
SortOrder | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BaseAssetContainerId | int | |
FacetConfigurationId | int | |
FacetConfigurationJson | FacetConfigurationJson | |
HideBackendLink | boolean | |
IsDefault | boolean | |
ListViewFieldGroupId | int | |
LogoutUrl | string | |
Name | string | |
NewFlagDays | int | |
OverlayFieldId | int | |
OverviewFieldGroupId | int | |
OverviewUiElementId | int | |
OverviewUrl | string | |
ShareListViewFieldGroupId | int | |
ShareOverviewFieldGroupId | int | |
Skin | Skin | |
SkinId | int | |
SuggestionSourceId | SuggestionSource | |
TermsAndConditions | string | |
Title | string | |
FieldIds | ArrayOfint | |
InitialAssetFilter | ExtendedAssetFilter | The assetFilter is a set of parameters, that define which assets are returned from GetAssets |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | Used in UI set to user language4content's caption |
FieldIds | ArrayOfint | |
IsInitiallyOpen | boolean | |
SortOrder | int | |
Translations | ArrayOfFacetConfigurationTranslation | Used for configuration (read / save) |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Elements | ArrayOfFacetConfigurationElement | |
Groups | ArrayOfFacetConfigurationGroup | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | Used in UI set to user language4content's caption |
DateRange | FacetDateRange | |
FromNumeric | float | |
Name | string | |
SortOrder | int | |
ToNumeric | float | |
Translations | ArrayOfFacetConfigurationTranslation | Used for configuration (read / save) |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
LanguageId | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BaseAssetContainerId | int | |
FacetConfigurationId | int | |
FacetConfigurationJson | FacetConfigurationJson | |
HideBackendLink | boolean | |
IsDefault | boolean | |
ListViewFieldGroupId | int | |
LogoutUrl | string | |
Name | string | |
NewFlagDays | int | |
OverlayFieldId | int | |
OverviewFieldGroupId | int | |
OverviewUiElementId | int | |
OverviewUrl | string | |
ShareListViewFieldGroupId | int | |
ShareOverviewFieldGroupId | int | |
Skin | Skin | |
SkinId | int | |
SuggestionSourceId | SuggestionSource | |
TermsAndConditions | string | |
Title | string | |
Element FacetConfigurationViewItem
Complex Type FacetConfigurationExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
From | string | |
To | string | |
Element FacetDateRange
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
FieldId | int | Serves as identifier for the UI |
Group | ArrayOfFacetResult | |
IsInitiallyOpen | boolean | |
IsOpen | boolean | |
RemainingHits | int | |
RemainingTerms | ArrayOfstring | |
RemainingTermsCount | int | |
SelectionBehavior | FacetInnerSelectionBehavior | |
SortOrder | int | |
Values | ArrayOfFacetValue | |
Element FacetResult
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ProvidedSearchFilter | ExtendedAssetFilter | Holds the asset filter that has been provided for searching |
Results | ArrayOfFacetResult | A result per field (facet) |
Element FacetResults
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CaptionsOfUncollapsedFacetGroups | ArrayOfstring | The captions of the facet groups that are not collapsed (open). These are necessary to tell the UI which ones to open so that the user has the same state after fetching data. |
FacetConfigurationId | int | |
FieldIdsOfFacets | ArrayOfint | This is used when facets have already (a) filter(s) applied and therefore it's not possible to use the FieldIds from the facet configuration |
FieldIdsOfUncollapsedFacets | ArrayOfint | The FieldIds of the facets that are not collapsed (open). These are necessary to tell the UI which ones to open so that the user has the same state after fetching data. |
SearchFilter | ExtendedAssetFilter | The assetFilter is a set of parameters, that define which assets are returned from GetAssets |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
Average | double | |
ComparisonOperation | ComparisonOperation | |
ComparisonOperationType | ComparisonOperationType | |
Count | int | |
FieldId | int | |
FieldName | string | |
Hits | int | |
IsSelected | boolean | |
Max | double | |
Min | double | |
Range | string | |
RangeConfiguration | FacetConfigurationRange | |
SortOrder | int | |
Sum | double | |
Element FacetValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Analyzed | boolean | Defines if the field gets analyzed by RavenDB |
AssetContainerType | AssetContainerType |
The asset container type, either Category or AssetClass. This property is needed for asset classes. |
AssetTypeIds | ArrayOfint | An array with the ids of asset types assigned to this field. Currently not used. |
BaseAssetContainerId | int | Needed for control type TagBox and defines root of the tagbox. |
Boost | float | Defines the boost factor for Fulltext search |
ControlType | ControlType | ComboBox, DateField, Checkbox .. |
DataType | DataType | Integer32, String, Date, Boolean .. |
DefaultGridColumnWidth | int | The default field column width for the asset browser grid view. |
FieldControlInfos | FieldControlInfos | Control Infos. |
FieldId | int | The id of the field. |
FieldLookupEntity | FieldLookupEntity | The name of the table to which the field belongs: FieldValues, Assets, Derivatives .. |
FieldLookupEntityId | int | The id of the FieldLookupEntity (see there). |
FieldOptionsLookupEntity | FieldOptionsLookupEntity |
The name of the table to which the field option belongs: Countries, Users .. Is null, if the options are not stored in one of these tables. |
FieldOptionsLookupEntityId | int | The id of the FieldOptionsLookupEntityId (see there). |
FieldType | FieldType | AssetField, UserField or AssetContainerField. |
IncludeInAssetIndexFullTexts | boolean | If true, this field is searched in case of a full text search. |
IncludeInCustomDBIndex | boolean | If true, this field is searched in case of a full text index. |
IsLanguageSpecific | boolean | Language specific fields like AssetName and AssetDescription may have different values depending on the language. |
IsReadOnly | boolean | A read only field can be updated only by the system, not by a user. |
IsRequired | boolean | If true, this field cannot be empty or null. |
IsSystemField | boolean | A system field like Sha1Hash or Fulltext is needed for programming purposes and not visible for a user. |
MetadataMapping | ArrayOfMetadataProperty |
List of xmp mappings, shows which Picturepark fields are mapped to which metadata fields in the image file. This allows for the mappings to be displayed in the UI, e.g. in the upload mask. |
Name | string | The field name, e.g. AssetName, AssetDescription, FileSizeInBytes, CDF8 .. |
Options | ArrayOfFieldOption |
An array with all available options for this field. Needed for ComboBox- and MultiCheckbox fields). |
ReplaceDelimiters | boolean | If true, field value will be splitted and formated by its special characters. The results will be added to the full text search index. |
Translation | FieldTranslation |
The field data in the language of the current user. Translation.Caption contains the field name in this language. |
Translations | ArrayOfFieldTranslation | Currently not used. |
ValidationRegEx | string | A regular expression used to check the input data, e.g. to enforce the input of an email address in a correct format. |
ts | base64Binary | Time stamp. |
Element Field [type ArrayOfField]
Element Field
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldControlInfoId | int | The id of the field control info. |
FieldId | int | The id of the field. |
MaxTextLength | int | Max count of chars. |
TagBoxShowFullPath | boolean | Should the TagBox show the full path or only the Tag (AssetContainerName). |
TotalTextAreaRows | int | The numbers of rows of a textarea. |
ts | base64Binary | Time stamp. |
Element FieldControlInfos [type Field]
Element FieldControlInfos
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
SortOrder | int | |
Translations | ArrayOfFieldOptionTranslation | |
ValueString | string | |
ts | base64Binary | |
Element FieldOption
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOptionId | int | |
FieldOptionTranslationId | int | |
LanguageId | int | |
ValueString | string | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalText | string | |
Caption | string | |
FieldId | int | |
FieldTranslationId | int | |
LanguageId | int | |
ToolTip | string | |
ts | base64Binary | |
Element FieldTranslation
Element Translation [type Field]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
FieldId | int | |
FieldOptionId | int | |
FieldValueId | int | |
LanguageId | int | |
Source | FieldValueSource | |
UserId | int | |
ValueAssetContainerAssignment | AssetContainerAssignmentExtended | |
ValueAssetContainerId | int | |
ValueBoolean | boolean | |
ValueDate | DateTimeOffset | |
ValueDateTime | DateTimeOffset | |
ValueDouble | double | |
ValueInteger32 | int | |
ValueInteger64 | long | |
ValueString | string | |
ValueUserShort | UserShort | |
ts | base64Binary | |
Element FieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UrlEntryPoint | string | E.g. "https//customer.picturepark.com/Website/default.aspx". |
UrlReferrer | string | E.g. "http://start-picturepark.vit.local/development/" |
UserAgent | string | E.g. "Mozilla/5.0 (Windows NT 6.1; rv:2.0) Gecko/20100101 Firefox/4.0". |
UserHostAddress | string | The ip address of the user host. |
UserHostName | string | The DNS name of the user host. |
Element HttpContextRequestInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ImpersonatedEmailAddress | string | |
ImpersonationId | int | |
Element Impersonation [type UserData]
Element Impersonation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Element KnownFieldValue
Complex Type KnownFieldValueAssetContainerAssignment
Complex Type KnownFieldValueBoolean
Complex Type KnownFieldValueDateTime
Complex Type KnownFieldValueDouble
Complex Type KnownFieldValueInteger32
Complex Type KnownFieldValueInteger64
Complex Type KnownFieldValueString
Complex Type KnownFieldValueUserShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | AssetContainerAssignmentExtended | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | boolean | |
Element KnownFieldValueBoolean
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | DateTimeOffset | |
Element KnownFieldValueDateTime
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | double | |
Element KnownFieldValueDouble
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | int | |
Element KnownFieldValueInteger32
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | long | |
Element KnownFieldValueInteger64
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
LanguageId | int | |
Value | string | |
Element KnownFieldValueString
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | UserShort | |
Element KnownFieldValueUserShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Abbreviation | string | |
AbbreviationISO6392 | string | |
Available4UserInterface | boolean | |
CatalogLanguageSqlName | string | |
EnglishName | string | |
IetfLanguageTag | string | |
IsNeutralCulture | boolean | |
LanguageId | int | |
LanguageTranslation | string | |
ts | base64Binary | |
Element Language [type Language4Content]
Element Language [type Language4Version]
Element Language
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CopyLanguageId | int | |
Language | Language | |
Language4AssetContainerId | int | |
LanguageId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ContentLanguageId | int | |
DefaultLanguage4AssetContainerId | int | |
DefaultLanguage4MetadataId | int | |
IsDefaultLanguage4Content | boolean | |
Language | Language | |
Language4ContentId | int | |
ts | base64Binary | |
Element Language4Content
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CatalogLanguageId | int | |
Language | Language | |
Language4FullTextIndexId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
IsRequired | boolean | |
Language | Language | |
Language4MetadataId | int | |
LanguageFallbacks | ArrayOfLanguageFallback | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Element Language4Metadata
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DefaultLanguage4ContentId | int | |
IsDefault | boolean | |
Language | Language | |
Language4UserInterfaceId | int | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
IsFavorite | boolean | |
Language | Language | |
Language4VersionId | int | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Element Language4Version
Contains elements as defined in the following table.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FallbackLanguage | string | |
FallbackLanguageId | int | |
Language4MetadataId | int | |
LanguageFallbackId | int | |
SortOrder | int | |
ts | base64Binary | |
Element LanguageFallback
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SecurityGroupDistinguishedName | string | |
UserGroup2LdapSecurityGroupId | int | |
UserGroupId | int | |
ts | base64Binary | |
Element LdapSecurityGroup
Element LogicalOperation
Complex Type AndOperation
Complex Type OrOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioCount | int | |
AudioStreams | ArrayOfAudioStream | |
Codec | string | |
DerivativeDefinitionId | int | |
DurationInSeconds | duration | |
Format | string | |
OverallBitRate | int | |
VideoCount | int | |
VideoStreams | ArrayOfVideoStream | |
Element MediaInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
DataType | DataType | |
DataTypeId | int | |
IsArray | boolean | |
IsMappable | boolean | |
MetadataParentPropertyId | int | |
MetadataPropertyId | int | |
MetadataSchema | MetadataSchema | |
MetadataSchemaId | int | |
PropertyName | string | |
ts | base64Binary | |
Element MetadataProperty
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
MetadataSchemaId | int | |
Schema | string | |
ts | base64Binary | |
Element MetadataSchema
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
IncludeMax | boolean | Include upper boundarie's value in result. Lucene syntax only! |
IncludeMin | boolean | Include lower boundarie's value in result. Lucene syntax only! |
LargerThanNumeric | float | |
SmallerThanNumeric | float | |
Element NumericBetweenOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualNumeric | float | |
Element NumericEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
IncludeMin | boolean | Include lower boundarie's value in result. Lucene syntax only! |
LargerThanNumeric | float | |
Element NumericLargerThanOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualNumericList | ArrayOffloat | |
Element NumericListEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
NotEqualNumeric | float | |
Element NumericNotEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
IncludeMax | boolean | Include upper boundarie's value in result. Lucene syntax only! |
SmallerThanNumeric | float | |
Element NumericSmallerThanOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperations | ArrayOfComparisonOperation | |
LogicalOperations | ArrayOfLogicalOperation | |
Element OrOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ErrorCode | int | |
Language | ApplicationLanguage | |
Message | string | |
Type | PictureparkErrorType |
This is an enumeration, which is normally submitted in a form like "PictureparkErrorType.UnknownError" or "PictureparkErrorType.InvalidSession" etc. Due to the SOAP specification enumeration values are sent and received with its name in the String format, e.g. "UnknownError" or "InvalidSession" etc. Depending on the generated webservice proxy code the numeric values of the enums might be needed. In this latter unlikely case see here for the numeric values: http://webservice8.picturepark.com/PublicService.svc?xsd=xsd2 |
Element PictureparkFault
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the asset right template. |
AppliedAssetRightTemplateName | string | The translation of the asset right template in current user language. |
AssetId | int | The asset id. |
AssetTypeId | AssetType | |
AssetTypeTranslation | string | |
Copyright | string | |
CreationDate | string | |
Description | string | The asset's further description (in most cases it'll be the field AssetDescription). |
DownloadableDerivatives | ArrayOfPortDerivative |
An array of PortDerivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
FileExtension | string | |
FileSize | string | |
LargeThumbnailUrl | string | |
ListViewFields | ArrayOfKeyValueOfintPortViewField6jg_STziK | |
MediumThumbnailUrl | string | |
OrderableDerivatives | ArrayOfPortDerivative |
An array of PortDerivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
OverlayText | string | |
OverviewFields | ArrayOfKeyValueOfintPortViewField6jg_STziK | |
SmallThumbnailUrl | string | |
SubTitle | string | The asset's sub title in more detailed views. |
Title | string | The asset's title which is used all over the new port (in most cases it'll be the field AssetName). |
Element PortAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Assets | ArrayOfPortAssetItem | An array of AssetItem. |
TotalAssets | int |
The number of assets in the query. Please note: this figure is not necessarily identical with the number of AssetItems. Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter. |
Element PortAssetItemCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
DerivativeDefinitionTranslation | string | |
DerivativeId | int | |
FileSize | string | |
Height | int | |
TraceUsagePurpose | boolean | |
Use4Preview | boolean | |
VersionOptionId | int | |
VersionTypeId | int | |
Width | int | |
Element PortDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
IsFullWidth | boolean | |
Position | int | |
Values | ArrayOfstring | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Countries | ArrayOfCountry | |
DerivativeDefinitions | ArrayOfDerivativeDefinition | |
PictureparkVersion | Version | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionArgumentId | int | |
RenderingActionArgumentValueId | int | |
RenderingActionValueId | int | |
Value | string | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetTypeId | int | |
DerivativeDefinitionId | int | |
RenderingActionArgumentValues | ArrayOfRenderingActionArgumentValue | |
RenderingActionId | int | |
RenderingActionValueId | int | |
SortOrder | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Element Rights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Applicable | boolean | |
AssetTypeIds | ArrayOfint | |
Assigned | boolean | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Description | string | |
Editable | boolean | |
IsDefault | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Name | string | |
RightTemplateId | int | |
RightTemplateType | RightTemplateType | |
RightTemplates2AssetTypes | ArrayOfRightTemplate2AssetType | |
RightTemplates2Rights | ArrayOfRightTemplate2Right | |
RightTemplates2UserGroups | ArrayOfRightTemplate2UserGroup | |
SortOrder | int | |
ts | base64Binary | |
Element RightTemplate
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetType | AssetType | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2AssetTypeId | int | |
RightTemplateId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRightId | int | |
AssetRightId | int | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
DerivativeDefinitionId | int | |
DerivativeDefinitionRightId | int | |
DerivativeRightId | int | |
FieldRightId | int | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2RightId | int | |
RightTemplateId | int | |
UserGroupId | int | |
UserGroupRightId | int | |
UserRightId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2UserGroupId | int | |
RightTemplateId | int | |
RightTemplateRight | RightTemplateRight | |
UserGroupId | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CanManage | boolean | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
CssSource | string | |
Deleted | boolean | |
HtmlSource | string | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Name | string | |
NamesOfMappedSitesWithSiteRightManage | ArrayOfstring | |
SkinId | int | |
TotalCountOfSiteMappings | int | |
ts | base64Binary | |
Element Skin
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SortDirection | SortDirection | |
SortField | string | |
Element SortInfo [type ArrayOfSortInfo]
Element SortInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
ContainsString | string | |
Element StringContainsOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Element StringEmptyOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualString | string | |
Element StringEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
ContainsExactStringList | ArrayOfstring | |
Element StringListContainsExactOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
ContainsStringList | ArrayOfstring | |
Element StringListContainsOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualStringList | ArrayOfstring | |
Element StringListEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
NotContainsString | string | |
Element StringNotContainsOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Element StringNotEmptyOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
NotEqualString | string | |
Element StringNotEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
StartsWithString | string | |
Element StringStartsWithOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DisplayName | string | First name plus last name |
string | ||
Language | ApplicationLanguage | The gui language for this user, which is stored in the user profile, e.g. "English". |
Language4ContentId | int |
The id of a content language. Language4Content is not a language, but a set of languages for specific purposes. Different languages can be assigned for content, metadata, asset containers and fulltext indexing. |
LoginStatus | LoginStatus | LoggedIn, NotLoggedIn or LoggedInAsGuest. |
Password | string | The password must be submitted for Login, but is never returned. |
Skin | SkinColor | Available options:Gray=0, Blue=1, White=2. |
UserGroups | ArrayOfint | Array of the ids of the assigned user groups. |
UserId | int | |
Element GlobalUser [type CoreInfo]
Element User [type CoreInfo]
Element User
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
DerivativeDefinitionId | int | |
UrlThumbnailSmall | string | |
UserAction | UserAction | |
UserActionDate | DateTimeOffset | |
UserActionHistoryId | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BatchGuid | string | |
TotalUserActionHistoryInfos | int | |
UserActionHistoryInfos | ArrayOfUserActionHistoryInfo | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
TotalUsers | int | TotalUsers is the number of rows in the query. If a limit is defined this figure may be higher than the number of records returned by the query. |
Users | ArrayOfUserShort | An array of UserShort. |
Element UserCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
EmailAddress | string | |
FirstName | string | |
LastName | string | |
UserId | int | |
Element UserCompact
Contains elements as defined in the following table.
Element userData [element CreateUser]
Element userData [element UpdateUser]
Element UserData
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRights | ArrayOfDerivativeDefinitionRights | |
UserGroup | UserGroupItem | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRights | ArrayOfAssetContainerRight | |
UserGroup | UserGroupItem | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetRights | ArrayOfAssetRight | |
UserGroup | UserGroupItem | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeRights | ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h | |
UserGroup | UserGroupItem | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroups | ArrayOfClaimGroup | |
IsDefault | boolean | |
IsGuestGroup | boolean | |
LdapSecurityGroups | ArrayOfLdapSecurityGroup | |
NeedsAllRights | boolean | |
NeedsAllUserRights | boolean | |
Translations | ArrayOfUserGroupTranslation | |
UserGroup | string | |
UserGroupId | int | |
ts | base64Binary | |
Element UserGroupItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LanguageId | int | |
Name | string | |
UserGroupId | int | |
UserGroupTranslationId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Address | string | |
AlternativeAddress | string | |
CanBeInternalContact | boolean | |
CanChangeOwnProfile | boolean | |
City | string | |
Comment | string | |
Company | string | |
CountryId | int | |
CountryTranslations | ArrayOfCountryTranslation | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Department | string | |
EmailAddress | string | |
ExpirationDate | DateTimeOffset | |
FieldValues | ArrayOfKnownFieldValue | |
FirstName | string | |
Guid4PasswordReset | string | |
InternalContactUserId | int | |
IsGuest | boolean | |
IsSupportContact | boolean | |
IsUpdaterServiceUser | boolean | |
LanguageId | int | |
LastActiveFacetConfigurationId | int | |
LastLoginDate | DateTimeOffset | |
LastName | string | |
LinkedGlobalUserId | int | |
LockDate | DateTimeOffset | |
LoginOnlyWithClaimsIdentity | boolean | |
LoginOnlyWithSecurityToken | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Phone | string | |
RegistrationStateId | RegistrationState | |
RenewalStateId | RenewalState | |
RenewalUntilDate | DateTimeOffset | |
RootSiteUrl | string | |
UseLdapAuthentication | boolean | |
UserId | int | |
Zip | string | |
ts | base64Binary | |
Element UserShort
Element ValueUserShort [type FieldValue]
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
_Build | int | |
_Major | int | |
_Minor | int | |
_Revision | int | |
Element Version
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
VideoBitRate | int | |
VideoCodec | string | |
VideoDisplayAspectRatio | string | |
VideoDuration | duration | |
VideoFormat | string | |
VideoFrameCount | int | |
VideoFrameRate | float | |
VideoHeight | int | |
VideoLanguage | string | |
VideoPixelAspectRatio | float | |
VideoResolution | int | |
VideoRotation | int | |
VideoStreamSize | long | |
VideoWidth | int | |
Element VideoStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Name | string | |
Value | string | |
children | ArrayOfXmpItem | |
expanded | boolean | |
leaf | boolean | |
Element XmpItem [type ArrayOfXmpItem]
Element XmpItem
Name | Description |
---|---|
ApplicationLanguage |
This is an enumeration, which is normally submitted in a form like "ApplicationLanguage.English" or "ApplicationLanguage.Afrikaans" etc. Due to the SOAP specification enumeration values are sent and received with its name in the String format, e.g. "English" or "Afrikaans" etc. Depending on the generated webservice proxy code the numeric values of the enums might be needed. In this latter unlikely case see here for the numeric values: http://webservice8.picturepark.com/PublicService.svc?xsd=xsd4 |
AssetContainerRight | |
AssetContainerType | |
AssetObjectType | |
AssetRight | |
AssetType | |
BitrateMode | |
BusinessProcessType | |
char | |
ComparisonOperationType | |
ControlType | |
DataType | |
DerivativeDefinitionRight | |
DerivativeRight | |
DerivativeType | |
duration | |
FacetInnerSelectionBehavior | |
FieldLookupEntity | |
FieldOptionsLookupEntity | |
FieldRight | |
FieldType | |
FieldValueSource | |
guid | |
LoginStatus | |
PersonalItemRight | |
PictureparkErrorType |
This is an enumeration, which is normally submitted in a form like "PictureparkErrorType.UnknownError" or "PictureparkErrorType.InvalidSession" etc. Due to the SOAP specification enumeration values are sent and received with its name in the String format, e.g. "UnknownError" or "InvalidSession" etc. Depending on the generated webservice proxy code the numeric values of the enums might be needed. In this latter unlikely case see here for the numeric values: http://webservice8.picturepark.com/PublicService.svc?xsd=xsd2 |
RegistrationState | |
RenderingClient | |
RenderingState | |
RenewalState | |
RightTemplateRight | |
RightTemplateType | |
SiteRight | |
SkinColor |
This is an enumeration, which is normally submitted in a form like "SkinColor.Gray" or "SkinColor.Blue". Due to the SOAP specification enumeration values are sent and received with its name in the String format, i.e. "Gray" or "Blue". There are three options available (with explicit numbers assigned since Picturepark version 8.6): Gray=0, Blue=1, White=2 |
SortDirection | |
StreamBody | |
SuggestionSource | |
TemporaryFileHandling | |
TraceJobType | |
UserAction | |
UserGroupRight | |
UserRight | |
WidgetRight |
This is an enumeration, which is normally submitted in a form like "ApplicationLanguage.English" or "ApplicationLanguage.Afrikaans" etc.
Due to the SOAP specification enumeration values are sent and received with its name in the String format, e.g. "English" or "Afrikaans" etc.
Depending on the generated webservice proxy code the numeric values of the enums might be needed. In this latter unlikely case see here for the numeric values:
http://webservice8.picturepark.com/PublicService.svc?xsd=xsd4
Restricting string
Value | Description |
---|---|
German | |
English | |
French | |
InvariantLanguage_InvariantCountry | |
Afrikaans | |
Afrikaans_SouthAfrica | |
Amharic_Ethiopia | |
Arabic | |
Arabic_UAE | |
Arabic_Bahrain | |
Arabic_Algeria | |
Arabic_Egypt | |
Arabic_Iraq | |
Arabic_Jordan | |
Arabic_Kuwait | |
Arabic_Lebanon | |
Arabic_Libya | |
Arabic_Morocco | |
Mapudungun_Chile | |
Arabic_Oman | |
Arabic_Qatar | |
Arabic_Saudi_Arabia | |
Arabic_Syria | |
Arabic_Tunisia | |
Arabic_Yemen | |
Assamese_India | |
Azeri | |
Azeri_Cyrillic_Azerbaijan | |
Azeri_Latin_Azerbaijan | |
Bashkir_Russia | |
Belarusian | |
Belarusian_Belarus | |
Bulgarian | |
Bulgarian_Bulgaria | |
Bengali_Bangladesh | |
Bengali_India | |
Tibetan_PeoplesRepublicOfChina | |
Breton_France | |
Bosnian_Cyrillic_BosniaAndHerzegovina | |
Bosnian_Latin_BosniaAndHerzegovina | |
Catalan | |
Catalan_Catalan | |
Corsican_France | |
Czech | |
Czech_CzechRepublic | |
Welsh_UnitedKingdom | |
Danish | |
Danish_Denmark | |
German_Austria | |
German_Switzerland | |
German_Germany | |
German_Liechtenstein | |
German_Luxembourg | |
LowerSorbian_Germany | |
Divehi | |
Divehi_Maldives | |
Greek | |
Greek_Greece | |
English_Caribbean | |
English_Australia | |
English_Belize | |
English_Canada | |
English_UnitedKingdom | |
English_Ireland | |
English_India | |
English_Jamaica | |
English_Malaysia | |
English_NewZealand | |
English_RepublicOfThePhilippines | |
English_Singapore | |
English_TrinidadAndTobago | |
English_UnitedStates | |
English_SouthAfrica | |
English_Zimbabwe | |
Spanish | |
Spanish_Argentina | |
Spanish_Bolivia | |
Spanish_Chile | |
Spanish_Colombia | |
Spanish_CostaRica | |
Spanish_DominicanRepublic | |
Spanish_Ecuador | |
Spanish_Spain | |
Spanish_Guatemala | |
Spanish_Honduras | |
Spanish_Mexico | |
Spanish_Nicaragua | |
Spanish_Panama | |
Spanish_Peru | |
Spanish_PuertoRico | |
Spanish_Paraguay | |
Spanish_ElSalvador | |
Spanish_UnitedStates | |
Spanish_Uruguay | |
Spanish_Venezuela | |
Estonian | |
Estonian_Estonia | |
Basque | |
Basque_Basque | |
Persian | |
Persian_Iran | |
Finnish | |
Finnish_Finland | |
Filipino_Philippines | |
Faroese | |
Faroese_FaroeIslands | |
French_Belgium | |
French_Canada | |
French_Switzerland | |
French_France | |
French_Luxembourg | |
French_PrincipalityOfMonaco | |
Frisian_Netherlands | |
Irish_Ireland | |
ScottishGaelic_UnitedKingdom | |
Galician | |
Galician_Galician | |
Alsatian_France | |
Gujarati | |
Gujarati_India | |
Hausa_Latin_Nigeria | |
Hebrew | |
Hebrew_Israel | |
Hindi | |
Hindi_India | |
Croatian | |
Croatian_Latin_BosniaAndHerzegovina | |
Croatian_Croatia | |
UpperSorbian_Germany | |
Hungarian | |
Hungarian_Hungary | |
Armenian | |
Armenian_Armenia | |
Indonesian | |
Indonesian_Indonesia | |
Igbo_Nigeria | |
Yi_PeoplesRepublicOfChina | |
Icelandic | |
Icelandic_Iceland | |
Italian | |
Italian_Switzerland | |
Italian_Italy | |
Inuktitut_Syllabics_Canada | |
Inuktitut_Latin_Canada | |
Japanese | |
Japanese_Japan | |
Georgian | |
Georgian_Georgia | |
Kazakh | |
Kazakh_Kazakhstan | |
Greenlandic_Greenland | |
Khmer_Cambodia | |
Kannada | |
Kannada_India | |
Korean | |
Konkani | |
Konkani_India | |
Korean_Korea | |
Kyrgyz | |
Kyrgyz_Kyrgyzstan | |
Luxembourgish_Luxembourg | |
Lao_LaoPDR | |
Lithuanian | |
Lithuanian_Lithuania | |
Latvian | |
Latvian_Latvia | |
Maori_NewZealand | |
Macedonian | |
Macedonian_FormerYugoslavRepublicofMacedonia | |
Malayalam_India | |
Mongolian | |
Mongolian_Cyrillic_Mongolia | |
Mongolian_TraditionalMongolian_PeoplesRepublicOfChina | |
Mohawk_Canada | |
Marathi | |
Marathi_India | |
Malay | |
Malay_BruneiDarussalam | |
Malay_Malaysia | |
Maltese_Malta | |
Norwegian_Bokml_Norway | |
Nepali_Nepal | |
Dutch | |
Dutch_Belgium | |
Dutch_Netherlands | |
Norwegian_Nynorsk_Norway | |
Norwegian | |
Sesothosa_Leboa_SouthAfrica | |
Occitan_France | |
Oriya_India | |
Punjabi | |
Punjabi_India | |
Polish | |
Polish_Poland | |
Dari_Afghanistan | |
Pashto_Afghanistan | |
Portuguese | |
Portuguese_Brazil | |
Portuguese_Portugal | |
Kiche_Guatemala | |
Quechua_Bolivia | |
Quechua_Ecuador | |
Quechua_Peru | |
Romansh_Switzerland | |
Romanian | |
Romanian_Romania | |
Russian | |
Russian_Russia | |
Kinyarwanda_Rwanda | |
Sanskrit | |
Yakut_Russia | |
Sanskrit_India | |
Sami_Northern_Finland | |
Sami_Northern_Norway | |
Sami_Northern_Sweden | |
Sinhala_SriLanka | |
Slovak | |
Slovak_Slovakia | |
Slovenian | |
Slovenian_Slovenia | |
Sami_Southern_Norway | |
Sami_Southern_Sweden | |
Sami_Lule_Norway | |
Sami_Lule_Sweden | |
Sami_Inari_Finland | |
Sami_Skolt_Finland | |
Albanian | |
Albanian_Albania | |
Serbian | |
Serbian_Cyrillic_BosniaAndHerzegovina | |
Serbian_Cyrillic_SerbiaAndMontenegro_Former | |
Serbian_Cyrillic_Montenegro | |
Serbian_Cyrillic_Serbia | |
Serbian_Latin_BosniaAndHerzegovina | |
Serbian_Latin_SerbiaAndMontenegro_Former | |
Serbian_Latin_Montenegro | |
Serbian_Latin_Serbia | |
Swedish | |
Swedish_Finland | |
Swedish_Sweden | |
Kiswahili | |
Kiswahili_Kenya | |
Syriac | |
Syriac_Syria | |
Tamil | |
Tamil_India | |
Telugu | |
Telugu_India | |
Tajik_Cyrillic_Tajikistan | |
Thai | |
Thai_Thailand | |
Turkmen_Turkmenistan | |
Setswana_SouthAfrica | |
Turkish | |
Turkish_Turkey | |
Tatar | |
Tatar_Russia | |
Tamazight_Latin_Algeria | |
Uyghur_PeoplesRepublicOfChina | |
Ukrainian | |
Ukrainian_Ukraine | |
Urdu | |
Urdu_IslamicRepublicOfPakistan | |
Uzbek | |
Uzbek_Cyrillic_Uzbekistan | |
Uzbek_Latin_Uzbekistan | |
Vietnamese | |
Vietnamese_Vietnam | |
Wolof_Senegal | |
isiXhosa_SouthAfrica | |
Yoruba_Nigeria | |
Chinese_Simplified | |
Chinese_Traditional | |
Chinese_PeoplesRepublicOfChina | |
Chinese_HongKongSAR | |
Chinese_MacaoSAR | |
Chinese_Singapore | |
Chinese_Taiwan | |
isiZulu_SouthAfrica |
Element ApplicationLanguage
Element desiredAssetContainerLanguage [element GetAssetContainers]
Element language [element CreateSession]
Element Language [type PictureparkFault]
Element Language [type User]
Restricting string
Value | Description |
---|---|
List | |
ViewContent | |
Rename | |
Delete | |
AssignAssets | |
CreateSubContainer | |
Move | |
ReorderContainer | |
EditAssetContainerRights | |
ViewAssetContainerRights |
Restricting string
Value | Description |
---|---|
Category | |
AssetClass |
Restricting string
Value | Description |
---|---|
LinkedAsset | |
LinkedUrl | |
Rectangle | |
Text | |
Arrow |
Element AssetObjectType
Restricting string
Value | Description |
---|---|
List | |
ViewMetadata | |
EditMetadata | |
Delete | |
ManageDerivatives | |
ViewRights | |
EditRights | |
EditContainerAssignments | |
ViewVersions | |
EditVersions | |
ViewStatistics | |
ViewJournal | |
ViewEmbeddedMetadata |
Element AssetRight
Restricting string
Value | Description |
---|---|
Unknown | |
Bitmap | |
VectorGraphic | |
RawImage | |
InterchangeDocument | |
WordProcessingDocument | |
TextDocument | |
DesktopPublishingDocument | |
Presentation | |
Spreadsheet | |
Archive | |
Audio | |
Video | |
Font | |
Multimedia | |
Application | |
SourceCode | |
Database | |
Cad | |
Model3d |
Element AssetType
Element AssetTypeId [type AssetItem]
Element AssetTypeId [type AssetMetadata]
Element AssetTypeId [type PortAssetItem]
Restricting string
Value | Description |
---|---|
Variable | |
Constant |
Element BitrateMode
Restricting string
Value | Description |
---|---|
AssetMailing | |
AssetReview | |
AssetLink | |
AssetPublishing |
Element BusinessProcessType
Restricting string
Value | Description |
---|---|
DateTimeAfterOperation | |
DateTimeBeforeOperation | |
DateTimeBetweenOperation | |
DateTimeEqualOperation | |
NumericBetweenOperation | |
NumericEqualOperation | |
NumericLargerThanOperation | |
NumericNotEqualOperation | |
NumericSmallerThanOperation | |
StringContainsOperation | |
StringEmptyOperation | |
StringEqualOperation | |
StringNotContainsOperation | |
StringNotEmptyOperation | |
StringNotEqualOperation | |
StringStartsWithOperation | |
AssetContainerIncludeOperation | |
AssetContainerExcludeOperation | |
StringListContainsOperation | |
StringListEqualOperation | |
NumericListEqualOperation | |
DateTimeNowAfterOrEqualOperation | |
DateTimeNowBeforeOrEqualOperation | |
DateTimeNowOlderOperation | |
DateTimeNowLastOperation | |
DateTimeNowNextOperation | |
DateTimeNowAfterOperation | |
AssetContainerIncludeFieldOperation | |
AssetContainerExcludeFieldOperation | |
StringListContainsExactOperation |
Element ComparisonOperationType
Restricting string
Value | Description |
---|---|
ComboBox | |
DateField | |
DateTimeField | |
Checkbox | |
MultiCheckbox | |
RadioButton | |
TextField | |
TextArea | |
Label | |
NumberField | |
Password | |
InternalContactEmailField | |
ComboBox4Users | |
TagBox |
Element ControlType [type Field]
Element ControlType
Restricting string
Value | Description |
---|---|
Integer32 | |
Integer64 | |
String | |
Date | |
DateTime | |
Boolean | |
Double | |
AlphaHandling | |
BlurType | |
FlipType | |
NullableInteger32 | |
Float | |
UserShort | |
NullableDouble | |
Color | |
AssetContainerAssignment |
Element DataType [type Field]
Element DataType [type MetadataProperty]
Element DataType
Restricting string
Value | Description |
---|---|
CanBeOrdered |
Restricting string
Value | Description |
---|---|
Download |
Element DerivativeRight
Restricting string
Value | Description |
---|---|
Original | |
Static | |
Dynamic | |
ThumbnailSmall | |
ThumbnailMedium | |
ThumbnailLarge | |
Custom |
Element DerivativeType
Restricting duration
Value must match the following pattern: \-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?
The value must be greater than or equal to -P10675199DT2H48M5.4775808S.
The value must be less than or equal to P10675199DT2H48M5.4775807S.
Element AudioDuration [type AudioStream]
Element duration
Element VideoDuration [type VideoStream]
Restricting string
Value | Description |
---|---|
Or | |
And | |
ExclusiveOr |
Restricting string
Value | Description |
---|---|
FieldValues | |
Assets | |
Derivatives | |
Users | |
Orders | |
ClientOnly | |
Assets2AssetContainers | |
VideoStreams | |
AudioStreams |
Element FieldLookupEntity [type Field]
Element FieldLookupEntity
Restricting string
Value | Description |
---|---|
Languages4UserInterfaces | |
Countries | |
Users | |
AssetRightTemplates | |
DerivativeRightTemplates | |
Sites |
Element FieldOptionsLookupEntity
Restricting string
Value | Description |
---|---|
ViewFieldValues | |
EditFieldValues | |
EditFieldOptions |
Element FieldRight
Restricting string
Value | Description |
---|---|
AssetField | |
UserField | |
AssetContainerField |
Element FieldType [type Field]
Element FieldType
Restricting string
Value | Description |
---|---|
FieldValues | |
Assets | |
Derivatives | |
VideoStreams | |
AudioStreams | |
AssetClass | |
XmpMetadata |
Element FieldValueSource
Element Source [type FieldValue]
Restricting string
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Element guid
Element UploadFirstChunkResult [element UploadFirstChunkResponse]
Restricting string
Value | Description |
---|---|
NotLoggedIn | |
LoggedInAsGuest | |
LoggedIn |
Element LoginStatus [type User]
Element LoginStatus
Restricting string
Value | Description |
---|---|
View | |
Edit |
Element PersonalItemRight
This is an enumeration, which is normally submitted in a form like "PictureparkErrorType.UnknownError" or "PictureparkErrorType.InvalidSession" etc.
Due to the SOAP specification enumeration values are sent and received with its name in the String format, e.g. "UnknownError" or "InvalidSession" etc.
Depending on the generated webservice proxy code the numeric values of the enums might be needed.
In this latter unlikely case see here for the numeric values: http://webservice8.picturepark.com/PublicService.svc?xsd=xsd2
Restricting string
Value | Description |
---|---|
UnknownError | Unknown error |
InvalidSession | Session not valid |
InsufficientRights | This user does not have the necessary rights for this action |
InsertFailure | Insert failed |
UpdateFailure | Update failed |
DeletionFailure | Delete failed |
FalseParameters | Wrong parameters |
FileNotFoundInsufficientRights | Either file not found or the user does not have the necessary access rights |
NotInDB | Not found in database |
UploadFailure | File upload failed |
TypeMismatch | Type mismatch |
FileNotFound | File not found |
IncompleteData | Data are incomplete or invalid |
InvalidEmail | Invalid email address |
EmptyString | Invalid value: empty string |
EmailAlreadyInUse | This email address has already been allocated |
PasswordNotFound | Authentication user with this password not found |
UnknownEmail | There is no active user with this email address |
UnknownSecurityToken | Security token not found |
UserIdIsZero | User id was 0 for security token user |
RenewalUnnecessary | Renewal failed: No renewal needed |
UnknownRenewalEmail | Renewal failed: User with this email address not found |
NoExpirationDate | Renewal failed: No expiration date set |
TimespanExpired | Renewal failed: Timespan for renewal has expired |
RenewalTooEarly | Renewal failed: Too early, renewal not yet possible |
IncompleteRenewalData | Renewal failed: Data are not complete |
InvalidContact | Renewal failed: Invalid email address of contact |
IdenticalPassword | Renewal failed: Old and new password are identical |
InvalidOldPassword | Renewal failed: There is no user account with this (old) password |
WeakRenewalPassword | Renewal failed: The new password is not strong enough |
UserNotFound | User with this email and password not found |
SecurityTokenUser | Login failed: User is a security token user |
DeletedUser | Login failed: User has been deleted (user state = 10) |
ExpiredUser | Login failed: User has expired (user state = 20) |
LockedUser | Login failed: User is locked (user state = 21) |
DisapprovedUser | Login failed: User has been disapproved (user state = 22) |
UnconfirmedUser | Login failed: Registration has not yet been confirmed by the user (user state = 30) |
UserUnapproved | Login failed: User is waitung for approval (user state = 40) |
InvalidState | Login failed: User state is invalid |
NoSubstituteUser | User not deleted: Substitute responsible user does not exist |
PasswordSent | Sending of passwords not allowed in this Picturepark |
InvalidPassword | This password is not valid |
WeakPassword_1 | This password is not strong enough |
InvalidDate | This expiration date is not a valid date |
DatePassed | This expiration date lies in the past |
CannotSetState | This user state cannot be set directly |
IdNotFound | User with this id not found |
UserPasswordNotFound | User with this password not found |
IdIsZero | Invalid user id 0 |
ProtectedAccount | This user account is protected |
ConfirmableUserNotFound | Confirmation of registration failed: user not found |
AlreadyConfirmed | Confirmation of registration failed: user has been confirmed already |
AlreadyApproved | Confirmation of registration failed: user has been approved already |
StateNot30 | Confirmation of registration failed: user state is not 30 |
ContactEmailInvalid | Registration failed: email address of internal contact is not a valid email address |
ActiveUserEmailUnknown | Registration failed: there is no active user with this email address |
NotInternalContact | Registration failed: this user is not an internal contact |
UserEmailUnknown | User with this email address not found |
LDAPPasswordChanged | LDAP login failed. Probably LDAP password has been changed |
GuestLogin | Login as guest failed |
SecurityTokenExpired | Security token has expired |
LDAPServerNotRunning | LDAP server not running |
RenewalExpiredUser | Renewal expired |
LinkedUserAccountNotFound | Linked user account with this email {0} and password not found |
SecurityTokenIpMismatch | Security token IP mismatch |
DeletingGuestUser | Guest user cannot be deleted |
DeletingCurrentUser | Current User cannot be deleted |
InvalidSenderEmail | Email address of sender is invalid |
InvalidRecipientsEmail | Email addresses of all recipients are invalid |
EmailNotSent | No email could be sent |
PartialSending | Some emails could be sent, some not |
OrderFilesLogin | In this Picturepark only logged in users can order files |
UnfoundOrder | Order not found |
UnfoundSubOrder | Sub order not found |
InvalidOrderState | This is not a valid order state |
InvalidSubOrderState | This is not a valid sub order state |
InvalidOrderManager | The order manager is not a valid Picturepark user |
CopyrightExists | This copyright already exists |
CopyrightDuplicateName | A copyright with this name already exists |
CopyrightNoID | A copyright with this id does not exist |
CopyrightDeletionFailure | This copyright is assigned to assets and therefore cannot be deleted |
KeywordNotFound | A keyword with this id does not exist |
IllegalAssetContainerMove | An asset container cannot be moved into itself |
ParentNotFound | Parent asset container not found |
EmptyDownloadArray | Array of download files is empty. Probably due to missing access rights and/or because the files do not exist |
DownloadNotCreated | The system could not create the download file |
BaseLanguageDeletionFailure | The base language PDF cannot be deleted |
PlaceholderNotFound | Placeholder not found |
InvalidURI | Invalid URI |
ExtensionMissingForPlaceholder | Extension missing for placeholder |
FileNotFoundInUploadDirectory | File not found in upload directory |
FileIsDuplicate | File is duplicate |
AssetNotFound | Asset not found |
DownloadTokenNotValid | The specified download token is not valid |
NotFilledOutCorrectly | One or more fields are invalid please verify your inputs. |
IndexRebuildThresholdExceeded | The specified download token is not valid |
RootLevelPropagation | The specified download token is not valid |
SessionExpired | The current customer hasn't been initialized with a language yet. Please initialize the according base class with a language first |
ContentTypeException | |
ExpiredVersion | The current version ({0}) has expired. The application cannot be executed anymore. Please download and install the new version from {1}. Closing this message box will automatically open that link in your browser |
NotYetActivatedVersion | The current version ({0}) is a pre-release and has not been activated yet. This version will be functional as soon as the Picturepark servers get the according upgrade |
UnknownPictureparkUrl | No Picturepark found at the specified URL (404). Please ensure you used the correct format for the URL: yourcompany.picturepark.com |
WrongPictureparkUrl | Please ensure you entered the URL with http(s) prefix: http(s)://yourcompany.picturepark.com |
ClearCacheTimeout | The cache could not have been cleared because some thumbnails are still in use by a background process. Please try again |
InvalidProxyAuthentication | Proxy authentication required (407). Please check your proxy settings |
InvalidLanguage | The selected language is not valid for this Picturepark instance |
UpdateByOtherUser | |
SessionExpiredEventFired | The SessionExpired event has been fired |
DuplicateAsset | Duplicate asset. Already processed an asset with the file name |
InvalidCropXValue | Invalid CropX value: |
InvalidCropYValue | Invalid CropY value: |
InvalidReplicationAssetContainer | Cannot use this asset container for replication because it conflicts with another enabled replication asset container. Please check the Replication Manager |
SiteNotFound | Publisher site could not be found |
InvalidMetadataMapping | Metadata mapping is invalid |
InvalidFieldValue | Field value is invalid |
InvalidAssetType | The asset type of the specified file is not valid for this action |
DuplicateAssetContainer | An asset container with the same absolute path already exists. Please adjust asset container naming |
DerivativeNotFound | Derivative not found. Please repair the asset and retry |
ClientNotFound | Client not found. Please provide a valid client guid |
DuplicateSkinName | Duplicate skin name found. Please provide a unique skin name |
DuplicateSiteName | Duplicate site name found. Please provide a unique site name |
FieldNotFound | No field found whose name matches the given string |
NoRightTemplateFound | No right template found for this file type |
Languages4IsReferencedInLanguage4Contents | Cannot remove this language\n because it is referenced in Languages4Contents.\n\n Please check the Languages4Contents first |
LanguageIsReferenced | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
AccessDenied | Access Denied |
ForeingKeyMissing | Cannot remove this imageEncodingOption\n because it is referenced in Derivatives.\n\n Please check Derivatives first |
LanguageIsReferencedContentLanguages4MetadataMapping | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInMetadataMappings | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInFieldValues | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInOrders | Cannot remove this delivery method\n because it is referenced in orders |
ReferencedInWorkflows | Cannot remove this field\n because it is referenced in workflows |
ReferencedInAssetVersion | Cannot remove this field\n because it is referenced in workflows |
FieldExists | Cannot remove this field\n because it is referenced in workflows |
ImageEncodingOptionIsReferenced | Cannot remove this imageEncodingOption\n because it is referenced in Derivatives.\n\n Please check Derivatives first |
NoLicenseKey | No license key installed. Please install a valid license key over the ManagementConsole |
InvalidLicenseKey | The current license key is not valid |
ExpiredLicenseKey | The current license is expired |
InsufficientLicense | The current license is insufficend to performe this action |
DuplicateLicenseKey | The current license is insufficend to performe this action |
InsufficentDiskSpaceOnTarget | Insufficient disk space on target server |
AbsoluteSqlServer2ServerExchangeDirectoryPathIsUndefined | AbsoluteSqlServer2ServerExchangeDirectoryPath is undefined |
AbsoluteInstanceImagePoolPathIsUndefined | AbsoluteInstanceImagePoolPath is undefined |
InstanceImageFileAlreadyExists | Instance image file already exists |
InstanceImageFileNotFound | Instance image file not found |
WrongFormatOfCustomerAbbreviation | Wrong format of customer abbreviation |
WrongFormatOfDatabaseName | Wrong format of database name |
ProhibitedDatabaseName | Prohibited database name |
CustomerIdAlreadyExists | Customer id already exists |
DatabaseAlreadyExists | The target database (Initial catalog) already exists on the server |
PublicFileDirectoryAlreadyExists | Public target file directory already exists |
ProtectedFileDirectoryAlreadyExists | Protected target file directory already exists |
InvalidFilenameForInstanceImageFile | Invalid filename for instance image (iso) file |
InstanceImageFileWithThisNameAlreadyExistsOnTargetServer | An instance image file with this name exists already on the target server |
InvalidVersionForInstanceImageFile | Invalid version of instance image (iso) file |
InconsistentImportData | Inconsistent import data |
DuplicateSearchServerNodeUrl | Duplicate search server node URL |
SearchServerNodeStillInUse | Node is still mapped to a customer |
MultiplePrimarySearchNode | Primary search node already exists |
NoPrimarySearchNode | Primary search node not exists |
MasterNodeDependencies | Primary search node has dependencies |
NoMasterNodeFound | No primary master search node found |
NoReplicationDocumentFound | No replication document found |
NoStaticIndexDefinitionFound | No static index definition found |
DefaultDatabaseNotSet | No 'DefaultDatabase' set for DocumentStore |
InstanceImageFileCannotBeOpened | Instance image file cannot be opened |
InstanceImageFileIsIncomplete | Invalid instance image file. Data is incomplete |
NoDatabaseFoundForSourcePicturepark | There is no database defined for the source Picturepark. |
Element PictureparkErrorType
Element Type [type PictureparkFault]
Restricting string
Value | Description |
---|---|
Waiting4EmailAuthentication | |
Waiting4ConfirmationByAdmin | |
Waiting4ConfirmationByContact | |
RejectedByAdmin | |
RejectedByContact |
Element RegistrationState
Restricting string
Value | Description |
---|---|
Import | |
Update | |
Repair | |
Editor |
Element RenderingClient
Restricting string
Value | Description |
---|---|
Pending | |
Completed | |
Failed |
Element RenderingState [type Derivative]
Element RenderingState
Restricting string
Value | Description |
---|---|
Waiting4RenewalByAdmin | |
Waiting4RenewalByContact | |
RejectedByAdmin | |
RejectedByContact |
Element renewalState [element GetUsers]
Element RenewalState [type UserData]
Element RenewalState
Element RenewalStateId [type UserShort]
Restricting string
Value | Description |
---|---|
View | |
Edit | |
Apply |
Element RightTemplateRight
Restricting string
Value | Description |
---|---|
AssetContainer | |
Asset | |
DerivativeDefinition |
Element RightTemplateType
Restricting string
Value | Description |
---|---|
List | |
Manage |
Element SiteRight
This is an enumeration, which is normally submitted in a form like "SkinColor.Gray" or "SkinColor.Blue".
Due to the SOAP specification enumeration values are sent and received with its name in the String format, i.e. "Gray" or "Blue".
There are three options available (with explicit numbers assigned since Picturepark version 8.6): Gray=0, Blue=1, White=2
Restricting string
Value | Description |
---|---|
Gray | |
Blue | |
White |
Element skin [element CreateSession]
Element Skin [type User]
Element SkinColor
Restricting string
Value | Description |
---|---|
Asc | |
Desc |
Element sortDirection [element GetUsers]
Element SortDirection [type SortInfo]
Element SortDirection
Restricting string
Value | Description |
---|---|
Default | |
Tokenized | |
None |
Element SuggestionSource
Element SuggestionSourceId [type FacetConfigurationViewItem]
Restricting string
Value | Description |
---|---|
KeepTemporaryFile | |
DeleteTemporaryFile | |
DeleteTemporaryFileAndContainingFolder |
Restricting string
Value | Description |
---|---|
AssetImport | |
AssetRepair | |
SubscriptionDispatch | |
AggregateTraffic | |
AggregateDiskspace | |
Workflow | |
PAS | |
ContentImport |
Element TraceJobType
Restricting string
Value | Description |
---|---|
SuccessfulLogin | |
FailedLogin | |
AssetDetailView | |
DerivativeView | |
DerivativeDownload | |
DerivativeOrder | |
DerivativeMailing | |
AssetCreation | |
AssetMetadataModification | |
DerivativeModification | |
AssetDeletion | |
SimpleSearch | |
UserCreation | |
UserModification | |
UserDeletion | |
AssetReplication | |
DerivativeCreation | |
ContainerModification | |
AssetRightsModification | |
DerivativeRightsModification | |
ContainerRightsModification | |
AssetVersionsModification | |
ContainerAssignmentCreation | |
ContainerCreation | |
ContainerDeletion | |
ContainerMovement | |
RightTemplateCreation | |
RightTemplateModification | |
RightTemplatePropagation | |
RightTemplateDeletion | |
ContainerAssignmentDeletion | |
UserGroupCreation | |
UserGroupModification | |
UserGroupRightsModification | |
UserGroupDeletion | |
DerivativeOriginalUpdate | |
DerivativeCustomUpdate | |
ExtendedSearch | |
ReviewCreation | |
ReviewModification | |
ReviewDeletion | |
CommentCreation | |
CommentModification | |
CommentDeletion | |
CommentRating | |
MailingAssignmentCreation | |
MailingAssignmentDeletion | |
ManagedCuePoint | |
MailingModification | |
TermsAccepted |
Element UserAction
Restricting string
Value | Description |
---|---|
ViewUserGroup | |
EditUserGroup | |
DeleteUserGroup | |
ViewUserGroupRights | |
EditUserGroupRights | |
AssignUsers | |
EditUsers | |
ImpersonateUserGroup | |
ImpersonateUser |
Restricting string
Value | Description |
---|---|
CreateUserGroups | |
EditRightsWithoutTemplate | |
CreateOrders | |
ViewAndEditAllOrders | |
EditOrderTypes | |
ViewAndEditOrderNotifications | |
CreateBusinessProcess | |
ViewAndEditAllBusinessProcesses | |
CreateMetadataExports | |
CreateAssets | |
DoBatchImport | |
ViewGlobalStatistics | |
ManageEmailSubscriptions | |
ManageAllSubscriptions | |
ViewAndEditMyAssets | |
ViewTraces | |
EditLanguageConfigurations | |
EditFieldDefinitions | |
RunWorkflows | |
EditSites | |
EditDerivativeDefinitions | |
EditCustomer | |
EditLdapConfigurations | |
EditCustomerHosts | |
EditFields | |
CreateRightTemplates | |
EditLanguages | |
EditTabs | |
EditLoginAndRegistration | |
EditIcons | |
CreatePublicSearches | |
ReorderContainingAssets | |
MetadataBatchUpdate | |
UseAssetConversion | |
EditAssetConversionPresets | |
EditWithoutAssetConversionPresets | |
ViewAndEditLicenseInformation | |
ViewAndEditStartPageFiles | |
ExecuteMaintenanceTasks | |
CreateReviews | |
ViewAndEditAllReviews | |
ManageDashboard | |
ViewDashboard | |
ManageAssetClasses | |
ManageExclusivityGroups | |
ManageExternalSystemSubscriptions | |
ManageWorkflowSubscriptions | |
UsePersonalSettings | |
UseSocialSharing | |
ViewRenderingStates | |
EditIdentityProviders |
Element UserRight
Restricting string
Value | Description |
---|---|
View | |
Manage | |
Reply | |
Rate |
Element WidgetRight
The uri of the import file path. Not needed if MTOM is used.
Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");
Type anyURI
Complex Type AssetUpdateOptions
The uri of the import file path. Not needed if MTOM is used.
Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");
Type anyURI
Complex Type DerivativeUpdateOptions
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | Array of asset ids. |
assetContainerIds | ArrayOfint | Array of asset container ids. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetVersions | ArrayOfAssetVersion |
A list of AssetVersions. There are currently two types of assetversions: languages and slides. |
Restricting anyType
Always empty.
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source ..
By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data.
AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"};
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Complex Type AssetFilter
Complex Type ExtendedAssetFilter
Optional. Get only users in groups to which the current user has a certain UserGroupRight.
Type UserGroupRight
Value | Description |
---|---|
ViewUserGroup | |
EditUserGroup | |
DeleteUserGroup | |
ViewUserGroupRights | |
EditUserGroupRights | |
AssignUsers | |
EditUsers | |
ImpersonateUserGroup | |
ImpersonateUser |
Element GetUsers
Optional. Get only users with this UserRight.
Type UserRight
Value | Description |
---|---|
CreateUserGroups | |
EditRightsWithoutTemplate | |
CreateOrders | |
ViewAndEditAllOrders | |
EditOrderTypes | |
ViewAndEditOrderNotifications | |
CreateBusinessProcess | |
ViewAndEditAllBusinessProcesses | |
CreateMetadataExports | |
CreateAssets | |
DoBatchImport | |
ViewGlobalStatistics | |
ManageEmailSubscriptions | |
ManageAllSubscriptions | |
ViewAndEditMyAssets | |
ViewTraces | |
EditLanguageConfigurations | |
EditFieldDefinitions | |
RunWorkflows | |
EditSites | |
EditDerivativeDefinitions | |
EditCustomer | |
EditLdapConfigurations | |
EditCustomerHosts | |
EditFields | |
CreateRightTemplates | |
EditLanguages | |
EditTabs | |
EditLoginAndRegistration | |
EditIcons | |
CreatePublicSearches | |
ReorderContainingAssets | |
MetadataBatchUpdate | |
UseAssetConversion | |
EditAssetConversionPresets | |
EditWithoutAssetConversionPresets | |
ViewAndEditLicenseInformation | |
ViewAndEditStartPageFiles | |
ExecuteMaintenanceTasks | |
CreateReviews | |
ViewAndEditAllReviews | |
ManageDashboard | |
ViewDashboard | |
ManageAssetClasses | |
ManageExclusivityGroups | |
ManageExternalSystemSubscriptions | |
ManageWorkflowSubscriptions | |
UsePersonalSettings | |
UseSocialSharing | |
ViewRenderingStates | |
EditIdentityProviders |
Element GetUsers
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DateTimeAfterOperation
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DateTimeBetweenOperation
A list of all asset ids in the query.
This list is only returned if the param ReturnAllQueryAssetIds in the AssetFilter is true.
These asset ids are not necessarily identical with the assets items in the Assets property, e.g. due to the Limit parameter.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type AssetItemCollection
Defines if the field gets analyzed by RavenDB
Type boolean
Complex Type Field
Type AndOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperations | ArrayOfComparisonOperation | |
LogicalOperations | ArrayOfLogicalOperation | |
Type anyType
Always empty.
Type anyURI
Type ApplicationLanguage
Value | Description |
---|---|
German | |
English | |
French | |
InvariantLanguage_InvariantCountry | |
Afrikaans | |
Afrikaans_SouthAfrica | |
Amharic_Ethiopia | |
Arabic | |
Arabic_UAE | |
Arabic_Bahrain | |
Arabic_Algeria | |
Arabic_Egypt | |
Arabic_Iraq | |
Arabic_Jordan | |
Arabic_Kuwait | |
Arabic_Lebanon | |
Arabic_Libya | |
Arabic_Morocco | |
Mapudungun_Chile | |
Arabic_Oman | |
Arabic_Qatar | |
Arabic_Saudi_Arabia | |
Arabic_Syria | |
Arabic_Tunisia | |
Arabic_Yemen | |
Assamese_India | |
Azeri | |
Azeri_Cyrillic_Azerbaijan | |
Azeri_Latin_Azerbaijan | |
Bashkir_Russia | |
Belarusian | |
Belarusian_Belarus | |
Bulgarian | |
Bulgarian_Bulgaria | |
Bengali_Bangladesh | |
Bengali_India | |
Tibetan_PeoplesRepublicOfChina | |
Breton_France | |
Bosnian_Cyrillic_BosniaAndHerzegovina | |
Bosnian_Latin_BosniaAndHerzegovina | |
Catalan | |
Catalan_Catalan | |
Corsican_France | |
Czech | |
Czech_CzechRepublic | |
Welsh_UnitedKingdom | |
Danish | |
Danish_Denmark | |
German_Austria | |
German_Switzerland | |
German_Germany | |
German_Liechtenstein | |
German_Luxembourg | |
LowerSorbian_Germany | |
Divehi | |
Divehi_Maldives | |
Greek | |
Greek_Greece | |
English_Caribbean | |
English_Australia | |
English_Belize | |
English_Canada | |
English_UnitedKingdom | |
English_Ireland | |
English_India | |
English_Jamaica | |
English_Malaysia | |
English_NewZealand | |
English_RepublicOfThePhilippines | |
English_Singapore | |
English_TrinidadAndTobago | |
English_UnitedStates | |
English_SouthAfrica | |
English_Zimbabwe | |
Spanish | |
Spanish_Argentina | |
Spanish_Bolivia | |
Spanish_Chile | |
Spanish_Colombia | |
Spanish_CostaRica | |
Spanish_DominicanRepublic | |
Spanish_Ecuador | |
Spanish_Spain | |
Spanish_Guatemala | |
Spanish_Honduras | |
Spanish_Mexico | |
Spanish_Nicaragua | |
Spanish_Panama | |
Spanish_Peru | |
Spanish_PuertoRico | |
Spanish_Paraguay | |
Spanish_ElSalvador | |
Spanish_UnitedStates | |
Spanish_Uruguay | |
Spanish_Venezuela | |
Estonian | |
Estonian_Estonia | |
Basque | |
Basque_Basque | |
Persian | |
Persian_Iran | |
Finnish | |
Finnish_Finland | |
Filipino_Philippines | |
Faroese | |
Faroese_FaroeIslands | |
French_Belgium | |
French_Canada | |
French_Switzerland | |
French_France | |
French_Luxembourg | |
French_PrincipalityOfMonaco | |
Frisian_Netherlands | |
Irish_Ireland | |
ScottishGaelic_UnitedKingdom | |
Galician | |
Galician_Galician | |
Alsatian_France | |
Gujarati | |
Gujarati_India | |
Hausa_Latin_Nigeria | |
Hebrew | |
Hebrew_Israel | |
Hindi | |
Hindi_India | |
Croatian | |
Croatian_Latin_BosniaAndHerzegovina | |
Croatian_Croatia | |
UpperSorbian_Germany | |
Hungarian | |
Hungarian_Hungary | |
Armenian | |
Armenian_Armenia | |
Indonesian | |
Indonesian_Indonesia | |
Igbo_Nigeria | |
Yi_PeoplesRepublicOfChina | |
Icelandic | |
Icelandic_Iceland | |
Italian | |
Italian_Switzerland | |
Italian_Italy | |
Inuktitut_Syllabics_Canada | |
Inuktitut_Latin_Canada | |
Japanese | |
Japanese_Japan | |
Georgian | |
Georgian_Georgia | |
Kazakh | |
Kazakh_Kazakhstan | |
Greenlandic_Greenland | |
Khmer_Cambodia | |
Kannada | |
Kannada_India | |
Korean | |
Konkani | |
Konkani_India | |
Korean_Korea | |
Kyrgyz | |
Kyrgyz_Kyrgyzstan | |
Luxembourgish_Luxembourg | |
Lao_LaoPDR | |
Lithuanian | |
Lithuanian_Lithuania | |
Latvian | |
Latvian_Latvia | |
Maori_NewZealand | |
Macedonian | |
Macedonian_FormerYugoslavRepublicofMacedonia | |
Malayalam_India | |
Mongolian | |
Mongolian_Cyrillic_Mongolia | |
Mongolian_TraditionalMongolian_PeoplesRepublicOfChina | |
Mohawk_Canada | |
Marathi | |
Marathi_India | |
Malay | |
Malay_BruneiDarussalam | |
Malay_Malaysia | |
Maltese_Malta | |
Norwegian_Bokml_Norway | |
Nepali_Nepal | |
Dutch | |
Dutch_Belgium | |
Dutch_Netherlands | |
Norwegian_Nynorsk_Norway | |
Norwegian | |
Sesothosa_Leboa_SouthAfrica | |
Occitan_France | |
Oriya_India | |
Punjabi | |
Punjabi_India | |
Polish | |
Polish_Poland | |
Dari_Afghanistan | |
Pashto_Afghanistan | |
Portuguese | |
Portuguese_Brazil | |
Portuguese_Portugal | |
Kiche_Guatemala | |
Quechua_Bolivia | |
Quechua_Ecuador | |
Quechua_Peru | |
Romansh_Switzerland | |
Romanian | |
Romanian_Romania | |
Russian | |
Russian_Russia | |
Kinyarwanda_Rwanda | |
Sanskrit | |
Yakut_Russia | |
Sanskrit_India | |
Sami_Northern_Finland | |
Sami_Northern_Norway | |
Sami_Northern_Sweden | |
Sinhala_SriLanka | |
Slovak | |
Slovak_Slovakia | |
Slovenian | |
Slovenian_Slovenia | |
Sami_Southern_Norway | |
Sami_Southern_Sweden | |
Sami_Lule_Norway | |
Sami_Lule_Sweden | |
Sami_Inari_Finland | |
Sami_Skolt_Finland | |
Albanian | |
Albanian_Albania | |
Serbian | |
Serbian_Cyrillic_BosniaAndHerzegovina | |
Serbian_Cyrillic_SerbiaAndMontenegro_Former | |
Serbian_Cyrillic_Montenegro | |
Serbian_Cyrillic_Serbia | |
Serbian_Latin_BosniaAndHerzegovina | |
Serbian_Latin_SerbiaAndMontenegro_Former | |
Serbian_Latin_Montenegro | |
Serbian_Latin_Serbia | |
Swedish | |
Swedish_Finland | |
Swedish_Sweden | |
Kiswahili | |
Kiswahili_Kenya | |
Syriac | |
Syriac_Syria | |
Tamil | |
Tamil_India | |
Telugu | |
Telugu_India | |
Tajik_Cyrillic_Tajikistan | |
Thai | |
Thai_Thailand | |
Turkmen_Turkmenistan | |
Setswana_SouthAfrica | |
Turkish | |
Turkish_Turkey | |
Tatar | |
Tatar_Russia | |
Tamazight_Latin_Algeria | |
Uyghur_PeoplesRepublicOfChina | |
Ukrainian | |
Ukrainian_Ukraine | |
Urdu | |
Urdu_IslamicRepublicOfPakistan | |
Uzbek | |
Uzbek_Cyrillic_Uzbekistan | |
Uzbek_Latin_Uzbekistan | |
Vietnamese | |
Vietnamese_Vietnam | |
Wolof_Senegal | |
isiXhosa_SouthAfrica | |
Yoruba_Nigeria | |
Chinese_Simplified | |
Chinese_Traditional | |
Chinese_PeoplesRepublicOfChina | |
Chinese_HongKongSAR | |
Chinese_MacaoSAR | |
Chinese_Singapore | |
Chinese_Taiwan | |
isiZulu_SouthAfrica |
The id of the asset right template. Is ignored, if IsAssetRightTemplateOverridden = true.
Type int
Complex Type AssetItem
The id of the assigned right template.
Type int
Complex Type AssetMetadata
The id of the asset right template.
Type int
Complex Type PortAssetItem
The translation of the asset right template in current user language.
Type string
Complex Type PortAssetItem
The id of the derivative right template. Is ignored, if IsDerivativeRightTemplateOverridden = true.
Type int
Complex Type AssetItem
The id of the right template used to define the access rights for the derivative formats.
Type int
Complex Type AssetMetadata
The id of the applied right template.Is ignored, if IsRightTemplateOverridden = true
Type int
Complex Type AssetContainerItem
Type ArrayOfAssetContainerAssignmentExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerAssignmentExtended | AssetContainerAssignmentExtended | |
Type ArrayOfAssetContainerComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerComparisonOperation | AssetContainerComparisonOperation | |
Type ArrayOfAssetContainerIndex
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerIndex | AssetContainerIndex | |
Type ArrayOfAssetContainerItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerItem | AssetContainerItem | An AssetContainerItem represents the attributes of one asset container including relations to other asset containers. |
Type ArrayOfAssetContainerLogicalOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerLogicalOperation | AssetContainerLogicalOperation | |
Type ArrayOfAssetContainerRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRight | AssetContainerRight | |
Type ArrayOfAssetContainerTotalAssets
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTotalAssets | AssetContainerTotalAssets | |
Type ArrayOfAssetContainerTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTranslation | AssetContainerTranslation | Language specific data of one asset container. One item per asset container language. |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetFieldValues | AssetFieldValues | |
Type ArrayOfAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetItem | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
Type ArrayOfAssetObject
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetObject | AssetObject | |
Type ArrayOfAssetRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetRight | AssetRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetSelection | AssetSelection | |
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Type ArrayOfAudioStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioStream | AudioStream | |
Type ArrayOfBusinessProcessLink
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessLink | BusinessProcessLink | |
Type ArrayOfBusinessProcessShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessShort | BusinessProcessShort | |
Type ArrayOfClaimGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroup | ClaimGroup | |
Type ArrayOfComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperation | ComparisonOperation | |
Type ArrayOfCountry
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Country | Country | |
Type ArrayOfCountryTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CountryTranslation | CountryTranslation | |
Type ArrayOfDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Derivative | Derivative | A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
Type ArrayOfDerivativeDefinition
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinition | DerivativeDefinition | |
Type ArrayOfDerivativeDefinition2AssetType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinition2AssetType | DerivativeDefinition2AssetType | |
Type ArrayOfDerivativeDefinitionRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRight | DerivativeDefinitionRight | |
Type ArrayOfDerivativeDefinitionRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRights | DerivativeDefinitionRights | |
Type ArrayOfDerivativeDefinitionTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionTranslation | DerivativeDefinitionTranslation | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeRight | DerivativeRight | |
Type ArrayOfDocument
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Document | Document | |
Type ArrayOfDocumentPage
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DocumentPage | DocumentPage | |
Type ArrayOfExtendedDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ExtendedDerivative | ExtendedDerivative | An extended derivative provides more detailed information than the usual derivative. |
Type ArrayOfFacetConfigurationElement
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationElement | FacetConfigurationElement | |
Type ArrayOfFacetConfigurationGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationGroup | FacetConfigurationGroup | |
Type ArrayOfFacetConfigurationRange
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationRange | FacetConfigurationRange | |
Type ArrayOfFacetConfigurationTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationTranslation | FacetConfigurationTranslation | |
Type ArrayOfFacetResult
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetResult | FacetResult | |
Type ArrayOfFacetSearchParameter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetSearchParameter | FacetSearchParameter | |
Type ArrayOfFacetValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetValue | FacetValue | |
Type ArrayOfField
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Field | Field | Defines the attributes of a Field (Asset-, User- or AssetContainerField) |
Type ArrayOfFieldOption
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOption | FieldOption | |
Type ArrayOfFieldOptionTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOptionTranslation | FieldOptionTranslation | |
Type ArrayOfFieldRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldRight | FieldRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldTranslation | FieldTranslation | |
Type ArrayOfFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Type ArrayOffloat
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
float | float | |
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h | anyType (restriction) | |
Type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK | anyType (restriction) | |
Type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe | anyType (restriction) | |
Type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfFieldRightuUS27HWe | anyType (restriction) | |
Type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfPersonalItemRightuUS27HWe | anyType (restriction) | |
Type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfSiteRightuUS27HWe | anyType (restriction) | |
Type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfUserGroupRightuUS27HWe | anyType (restriction) | |
Type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfWidgetRightuUS27HWe | anyType (restriction) | |
Type ArrayOfKeyValueOfintPortViewField6jg_STziK
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintPortViewField6jg_STziK | anyType (restriction) | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KnownFieldValue | KnownFieldValue | |
Type ArrayOfLanguage4AssetContainer
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4AssetContainer | Language4AssetContainer | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Content | Language4Content | |
Type ArrayOfLanguage4FullTextIndex
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4FullTextIndex | Language4FullTextIndex | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Metadata | Language4Metadata | |
Type ArrayOfLanguage4UserInterface
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4UserInterface | Language4UserInterface | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Version | Language4Version | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LanguageFallback | LanguageFallback | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LdapSecurityGroup | LdapSecurityGroup | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LogicalOperation | LogicalOperation | |
Type ArrayOfMediaInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
MediaInfo | MediaInfo | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
MetadataProperty | MetadataProperty | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PersonalItemRight | PersonalItemRight | |
Type ArrayOfPortAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PortAssetItem | PortAssetItem | An AssetItem represents the attributes of one asset including relations to other assets. The structure is built to be directly shwoed in web |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PortDerivative | PortDerivative | A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
Type ArrayOfRenderingActionArgumentValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionArgumentValue | RenderingActionArgumentValue | |
Type ArrayOfRenderingActionValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionValue | RenderingActionValue | |
Type ArrayOfRightTemplate
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate | RightTemplate | |
Type ArrayOfRightTemplate2AssetType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2AssetType | RightTemplate2AssetType | |
Type ArrayOfRightTemplate2Right
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2Right | RightTemplate2Right | |
Type ArrayOfRightTemplate2UserGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2UserGroup | RightTemplate2UserGroup | |
Type ArrayOfSiteRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SiteRight | SiteRight | |
Type ArrayOfSortInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SortInfo | SortInfo | |
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Type ArrayOfUserActionHistoryInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserActionHistoryInfo | UserActionHistoryInfo | |
Type ArrayOfUserDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserDerivativeRights | UserDerivativeRights | |
Type ArrayOfUserGroupAssetContainerRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetContainerRights | UserGroupAssetContainerRights | |
Type ArrayOfUserGroupAssetRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetRights | UserGroupAssetRights | |
Type ArrayOfUserGroupDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupDerivativeRights | UserGroupDerivativeRights | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupRight | UserGroupRight | |
Type ArrayOfUserGroupTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupTranslation | UserGroupTranslation | |
Type ArrayOfUserRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserRight | UserRight | |
Type ArrayOfUserShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserShort | UserShort | |
Type ArrayOfVideoStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
VideoStream | VideoStream | |
Type ArrayOfWidgetRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
WidgetRight | WidgetRight | |
Type ArrayOfXmpItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
XmpItem | XmpItem | |
Optional. The aspNetSessionId (if known), which enables the system to retrieve a lost session, e.g. in case of a browser reload.
Type string
Element CreateSession
Type AssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the asset right template. Is ignored, if IsAssetRightTemplateOverridden = true. |
AppliedDerivativeRightTemplateId | int | The id of the derivative right template. Is ignored, if IsDerivativeRightTemplateOverridden = true. |
AssetId | int | The asset id. |
AssetRights | ArrayOfAssetRight | An array with all AssetRights for the current user. |
AssetTypeId | AssetType | In Picturepark, assets are categorized into AssetTypes according to their file extensions. |
AssetVersions | ArrayOfAssetVersion |
An array with all AssetVersions for this asset. In Picturepark, the version logic is implemented as an assignment of one or more assets to a parent asset. Thus, an asset can either have a parent or be a parent. AssetVersion contains the assets, for which it is the parent, while MasterVersions contain the parents. Currently, version types are either language versions or slides. |
AvailableDerivativeDefinitions | ArrayOfint | An array with all available derivative definitions for this asset, ignoring the Usergroups rights. Needed to order derivatives which the user has no right to download. |
Derivatives | ArrayOfDerivative |
An array of Derivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
FieldSetIds | ArrayOfint |
A list of assigned field set ids. FieldSetIds define which fields are assigned to an asset. Needed for AssetClasses. |
FieldValues | ArrayOfKnownFieldValue |
Array of KnownFieldValues. This array contains one entry for each field value. For which fields the values are returned depends on the parameters AdditionalSelectFields in ExtendedAssetFilter. |
IsAssetRightTemplateOverridden | boolean | If true, the applied asset right template is ignored and the rights particularly assigned to this asset are applied. |
IsDerivativeRightTemplateOverridden | boolean | If true, the applied derivative right template is ignored and the rights particularly assigned to the derivatives are applied. |
MasterVersions | ArrayOfAssetVersion | See above under AssetVersions. |
XmpOutOfSync | boolean | Technical flag concerning the rendering state. |
XmpSyncFailed | boolean | Technical flag concerning the rendering state. |
Complex Type AssetVersion
Type AssetContainerAndOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperations | ArrayOfAssetContainerComparisonOperation | |
LogicalOperations | ArrayOfAssetContainerLogicalOperation | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
FieldId | int | |
Type AssetContainerAssignmentExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
FieldId | int | |
AssetContainerType | AssetContainerType | |
ExclusivityGroupId | int | |
FieldSetIds | ArrayOfint | |
IconId | int | |
Indexes | ArrayOfAssetContainerIndex | |
Translations | ArrayOfAssetContainerTranslation | |
Complex Type ArrayOfAssetContainerAssignmentExtended
Type AssetContainerAssignmentExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
FieldId | int | |
AssetContainerType | AssetContainerType | |
ExclusivityGroupId | int | |
FieldSetIds | ArrayOfint | |
IconId | int | |
Indexes | ArrayOfAssetContainerIndex | |
Translations | ArrayOfAssetContainerTranslation | |
An array with all AssetContainerAssignmentExtendeds for this asset.
An asset can be assigned to many asset containers.
Type ArrayOfAssetContainerAssignmentExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerAssignmentExtended | AssetContainerAssignmentExtended | |
Complex Type AssetMetadata
Type AssetContainerComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Complex Type ArrayOfAssetContainerComparisonOperation
Type AssetContainerComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Type AssetContainerExcludeFieldOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Type AssetContainerExcludeOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
The id of the asset container.
Type int
Element GetAssetContainerRights
The asset container ID.
Type int
Element GetFieldSetIdByFieldName
The id of the asset container.
The deletion of an asset container includes the deletion of all sub containers!
Type int
Element RemoveAssetContainer
The id of the asset container.
Type int
Element SaveAssetContainerRights
The id of the asset container.
Type int
Element UpdateAssetContainer
The asset container ID.
Type int
Element UpdateFieldSetDefaultValue
Type int
Complex Type AssetContainerAssignment
Complex Type AssetContainerAssignmentExtended
Type int
Complex Type AssetContainerComparisonOperation
Complex Type AssetContainerExcludeOperation
Complex Type AssetContainerIncludeOperation
The id of the asset container.
Type int
Complex Type AssetContainerItem
Array of asset container ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element AddAssets2AssetContainers
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element GetTotalAssets
List of asset container ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element RemoveAssetsFromAssetContainers
List of the AssetClass ids to be assigned to the asset. Not nillable, but the list may be empty.
An AssetClass defines the available attributes of an asset.
It is implemented as a new type of asset container alongside categories.
Category assignments are now an asset field value for an asset field of type ValueAssetContainerAssignment.
See under param FieldValues for an example.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type AssetImportOptions
Type AssetContainerIncludeFieldOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Type AssetContainerIncludeOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
IncludeSubAssetContainers | boolean | |
Type AssetContainerIndex
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsolutePath | string | |
AbsolutePathById | string | |
AssetContainerIndexId | int | |
LanguageId | int | |
ts | base64Binary | |
Complex Type ArrayOfAssetContainerIndex
Type AssetContainerIndex
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsolutePath | string | |
AbsolutePathById | string | |
AssetContainerIndexId | int | |
LanguageId | int | |
ts | base64Binary | |
Type AssetContainerItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedRightTemplateId | int | The id of the applied right template.Is ignored, if IsRightTemplateOverridden = true |
AssetContainerId | int | The id of the asset container. |
AssetContainerName | string | The asset container name depends on the parameter desiredAssetContainerLanguage in GetAssetContainers. |
AssetContainerType | AssetContainerType | The asset container type, either Category or AssetClass. |
Children | ArrayOfAssetContainerItem | An array with child AssetContainerItems. |
CreatedByUserId | int | The id of the user who created the container. |
CreationDate | DateTimeOffset | The creation date. |
ExclusivityGroupId | int |
The id of an exclusivity group. An exclusivity group is a list of mutually exclusive categories, e.g. countries or sex. In the case of countries an exclusivity group would prevent an asset to be assigned to more than one countries, in the case of sex it could be assigned to either male or female, but not to both. |
FieldSetIds | ArrayOfint |
A list of assigned field set ids. FieldSetIds define which fields are assigned to an asset container. Needed for AssetClasses. |
IconId | int | The id of the icon used for the display of the asset container. |
Indexes | ArrayOfAssetContainerIndex | An array with the indexes for each asset container language (contains the language specific absolute paths, e.g. "animals\pets\dogs\") |
IsRightTemplateOverridden | boolean | If true, the applied right template is ignored and the rights particularly assigned to this asset container are applied. |
ModificationDate | DateTimeOffset | The modification date. |
ModifiedByUserId | int | The id of the last user who edited the container. |
ParentAssetContainerId | int | The id of the parent asset containert, is null for containers on the highest level. |
Permissions | ArrayOfAssetContainerRight | An array with the AssetContainerRights for the current user. |
SortChildrenAlphabetically | boolean |
Flag: sort child nodes alphabetically. If true, child nodes are sorted alphabetically and sort order numbering is ignored. |
SortOrder | int | The relative sort order of siblings. |
SubAssetContainers | int | The number of child nodes (children only, not grand children etc). |
Translations | ArrayOfAssetContainerTranslation | An array with the AssetContainerTranslations (names and descriptions) for each asset container language. |
ts | base64Binary | |
Complex Type ArrayOfAssetContainerItem
Type AssetContainerItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedRightTemplateId | int | The id of the applied right template.Is ignored, if IsRightTemplateOverridden = true |
AssetContainerId | int | The id of the asset container. |
AssetContainerName | string | The asset container name depends on the parameter desiredAssetContainerLanguage in GetAssetContainers. |
AssetContainerType | AssetContainerType | The asset container type, either Category or AssetClass. |
Children | ArrayOfAssetContainerItem | An array with child AssetContainerItems. |
CreatedByUserId | int | The id of the user who created the container. |
CreationDate | DateTimeOffset | The creation date. |
ExclusivityGroupId | int |
The id of an exclusivity group. An exclusivity group is a list of mutually exclusive categories, e.g. countries or sex. In the case of countries an exclusivity group would prevent an asset to be assigned to more than one countries, in the case of sex it could be assigned to either male or female, but not to both. |
FieldSetIds | ArrayOfint |
A list of assigned field set ids. FieldSetIds define which fields are assigned to an asset container. Needed for AssetClasses. |
IconId | int | The id of the icon used for the display of the asset container. |
Indexes | ArrayOfAssetContainerIndex | An array with the indexes for each asset container language (contains the language specific absolute paths, e.g. "animals\pets\dogs\") |
IsRightTemplateOverridden | boolean | If true, the applied right template is ignored and the rights particularly assigned to this asset container are applied. |
ModificationDate | DateTimeOffset | The modification date. |
ModifiedByUserId | int | The id of the last user who edited the container. |
ParentAssetContainerId | int | The id of the parent asset containert, is null for containers on the highest level. |
Permissions | ArrayOfAssetContainerRight | An array with the AssetContainerRights for the current user. |
SortChildrenAlphabetically | boolean |
Flag: sort child nodes alphabetically. If true, child nodes are sorted alphabetically and sort order numbering is ignored. |
SortOrder | int | The relative sort order of siblings. |
SubAssetContainers | int | The number of child nodes (children only, not grand children etc). |
Translations | ArrayOfAssetContainerTranslation | An array with the AssetContainerTranslations (names and descriptions) for each asset container language. |
ts | base64Binary | |
Type AssetContainerLogicalOperation
Always empty.
Complex Type ArrayOfAssetContainerLogicalOperation
The asset container name depends on the parameter desiredAssetContainerLanguage in GetAssetContainers.
Type string
Complex Type AssetContainerItem
Type AssetContainerOrOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperations | ArrayOfAssetContainerComparisonOperation | |
LogicalOperations | ArrayOfAssetContainerLogicalOperation | |
Type AssetContainerRight
Value | Description |
---|---|
List | |
ViewContent | |
Rename | |
Delete | |
AssignAssets | |
CreateSubContainer | |
Move | |
ReorderContainer | |
EditAssetContainerRights | |
ViewAssetContainerRights |
Complex Type ArrayOfAssetContainerRight
Type AssetContainerRight
Value | Description |
---|---|
List | |
ViewContent | |
Rename | |
Delete | |
AssignAssets | |
CreateSubContainer | |
Move | |
ReorderContainer | |
EditAssetContainerRights | |
ViewAssetContainerRights |
Type ArrayOfAssetContainerRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRight | AssetContainerRight | |
Complex Type UserGroupAssetContainerRights
Optional. Define from which asset containers to get assets.
See the general API docu overview for further examples!
// EXAMPLE: Get assets from asset container id 123 plus all sub-containers:
.
List<AssetContainerComparisonOperation> assetContainerComparisonOperations =
. new List<AssetContainerComparisonOperation>()
. {new AssetContainerIncludeOperation() {AssetContainerId = 123, IncludeSubAssetContainers = true}};
.
AssetContainerOrOperation assetContainerSearchOperation = new AssetContainerOrOperation()
. {ComparisonOperations = assetContainerComparisonOperations};
.
ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
. AssetContainerSearchOperation = assetContainerSearchOperation,
. other parameters ..
}
Type AssetContainerLogicalOperation
Always empty.
Complex Type ExtendedAssetFilter
Type AssetContainerTotalAssets
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
TotalAssets | int | |
Complex Type ArrayOfAssetContainerTotalAssets
Type AssetContainerTotalAssets
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
TotalAssets | int | |
Type AssetContainerTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetContainerTranslationId | int | |
Description | string | The asset container description in the language defined by LanguageId. |
LanguageId | int | The language id (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..). |
Name | string | The asset container name in the language defined by LanguageId. |
ts | base64Binary | |
Complex Type ArrayOfAssetContainerTranslation
Type AssetContainerTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetContainerTranslationId | int | |
Description | string | The asset container description in the language defined by LanguageId. |
LanguageId | int | The language id (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..). |
Name | string | The asset container name in the language defined by LanguageId. |
ts | base64Binary | |
A list of AssetContainerTranslations with the language specific asset container names and descriptions.
Type ArrayOfAssetContainerTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTranslation | AssetContainerTranslation | Language specific data of one asset container. One item per asset container language. |
Element CreateAssetContainer
A list of AssetContainerTranslations with the language specific asset container names and descriptions.
Type ArrayOfAssetContainerTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTranslation | AssetContainerTranslation | Language specific data of one asset container. One item per asset container language. |
Element UpdateAssetContainer
Optional. Either Category or AssetClass.
AssetContainerType? assetContainerType = AssetContainerType.AssetClass;
Type AssetContainerType
Value | Description |
---|---|
Category | |
AssetClass |
Element GetAssetContainers
Type AssetContainerType
Value | Description |
---|---|
Category | |
AssetClass |
Complex Type AssetContainerAssignmentExtended
The asset container type, either Category or AssetClass.
Type AssetContainerType
Value | Description |
---|---|
Category | |
AssetClass |
Complex Type AssetContainerItem
The asset container type, either Category or AssetClass.
This property is needed for asset classes.
Type AssetContainerType
Value | Description |
---|---|
Category | |
AssetClass |
Complex Type Field
The list of AssetFieldValues to be updated.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetFieldValues | AssetFieldValues | |
Element UpdateAssetsMetadata
Type AssetFieldValues
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | The asset id. |
FieldSetIds | ArrayOfint | The fieldSetIds for this asset. |
FieldValues | ArrayOfFieldValue | Array of field values for this asset. |
UrlThumbnailSmall | string | The small thumbnail for preview in batch editor. |
Complex Type ArrayOfAssetFieldValues
Type AssetFieldValues
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | The asset id. |
FieldSetIds | ArrayOfint | The fieldSetIds for this asset. |
FieldValues | ArrayOfFieldValue | Array of field values for this asset. |
UrlThumbnailSmall | string | The small thumbnail for preview in batch editor. |
The list of AssetFieldValues to be removed.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetFieldValues | AssetFieldValues | |
Element UpdateAssetsMetadata
An asset filter.
Type ExtendedAssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
AssetContainerSearchOperation | AssetContainerLogicalOperation |
Optional. Define from which asset containers to get assets. See the general API docu overview for further examples! // EXAMPLE: Get assets from asset container id 123 plus all sub-containers: |
AssetTypeIds | ArrayOfint |
Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images. Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized. Default: all AssetTypeIds = new List<int> {2, 6, 20} |
Limit | int | Optional. The maximal number of assets returned. Default is unlimited. |
MediaTypeIds | ArrayOfint |
Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies. Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia". Default: all MediaTypeIds = new List<int> {1,4,3} |
ReturnMediaTypeCounts | boolean |
Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned. For performance reasons, this paramter should be set to false if not needed. Default: false |
SearchDesiredMetadataLanguageOnly | boolean | Optional. If true, a search is done only within language specific metadata. Default: false. |
SearchOnlyDeletedAssets | boolean | Optional. |
SearchOperation | LogicalOperation |
Optional. Define search parameters for a complex search. See the general API docu overview for further examples! See ComparisonOperation for available operators. // EXAMPLE: Get asset with AssetId 111: |
SimpleSearchString | string |
Optional. Use simple search, if you wish to search within all fields for a simple string.
|
SortInfos | ArrayOfSortInfo |
Sort parameters: the asset field and the direction (ascending or descending). This is the only required parameter! You may define several sort infos, e.g. AssetName asc, AssetId desc. List<SortInfo> sortInfos = new List<SortInfo>(); |
StartRow | int | Optional. The row in the query, from where on to return the assets. Default is 0. |
UnassignedAssetsOnly | boolean | Optional. If true, only assets which are in no category are returned. Default: false. |
VersionTypeIds | ArrayOfint |
Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions). This is not a filter for the assets, thus has no impact on the number of assets returned by the query. VersionTypeIds = new List<int> { 1, 3 } |
Element GetAssets2
The assetFilter allows the definition of some additional parameters.
Type AssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
Element GetAssetsByIds
An asset filter, may be empty.
Type AssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
Element GetAssetVersions
Type AssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
Type int
Complex Type AssetContainerAssignment
Complex Type AssetContainerAssignmentExtended
Array of asset ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element AddAssets2AssetContainers
The int array of asset ids to be returned.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element GetAssetsByIds
A list of asset ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element GetAssetsMetadata
An array of asset ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element RemoveAssets
List of asset ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element RemoveAssetsFromAssetContainers
List of asset ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element SaveAssetsRights
List of asset ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element SaveDerivativeRights
A complex datatype for import options.
If you wish to upload by streaming (recommended), you must provide the properties ImportGuid and FileName.
See under UploadFile how to proceed.
Type AssetImportOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerIds | ArrayOfint |
List of the AssetClass ids to be assigned to the asset. Not nillable, but the list may be empty. An AssetClass defines the available attributes of an asset. It is implemented as a new type of asset container alongside categories. Category assignments are now an asset field value for an asset field of type ValueAssetContainerAssignment. See under param FieldValues for an example. |
AssetRightTemplateId | int | The id of an AssetRightTemplate. |
AssetVersions | ArrayOfAssetVersion | Optional. List of asset versions. |
DerivativeRightTemplateId | int | The id of a DerivativeRightTemplate. |
FieldValues | ArrayOfFieldValue |
List of field values. Which field values are required - and must therefore be submitted - depends on the configuration of this Picturepark. Please note: categories are defined as a special field value of type ValueAssetContainerAssignment (see code example).
|
FileName | string | The file name with extension, needed only for an upload by MTOM. |
ImportGuid | guid |
Needed only for an upload by MTOM.
|
ImportRelativeFilePath | string | Needed only for batch import, which is not available for public webservices. |
ImportUrl | string |
The url of the file to be imported, not needed for upload by MTOM. For an upload by MTOM (recommended) the ImportGuid is needed instead.
|
IsAssetRightTemplateOverridden | boolean |
Optional. If true, the assigned AssetRightTemplateId is ignored and rights specifically assigned to this asset are applied. Default is false. If true, UserGroupAssetRights must be provided. |
IsDerivativeRightTemplateOverridden | boolean | Optional. If true, the assigned DerivativeRightTemplateId is ignored and rights specifically assigned to this derivative are applied. Default is false. |
OnlyCreateOriginalDerivative | boolean |
Optional. If true, derivatives are not created (except the original derivative). Default is false. Needed only in special cases where the user wishes to import his own derivatives. |
UserGroupAssetRights | ArrayOfUserGroupAssetRights |
The assignment of certain rights for certain groups to this asset. Needed only if IsAssetRightTemplateOverridden = true.
|
UserGroupDerivativeRights | ArrayOfUserGroupDerivativeRights | Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter. |
Element ImportSingleAsset
Type AssetImportOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerIds | ArrayOfint |
List of the AssetClass ids to be assigned to the asset. Not nillable, but the list may be empty. An AssetClass defines the available attributes of an asset. It is implemented as a new type of asset container alongside categories. Category assignments are now an asset field value for an asset field of type ValueAssetContainerAssignment. See under param FieldValues for an example. |
AssetRightTemplateId | int | The id of an AssetRightTemplate. |
AssetVersions | ArrayOfAssetVersion | Optional. List of asset versions. |
DerivativeRightTemplateId | int | The id of a DerivativeRightTemplate. |
FieldValues | ArrayOfFieldValue |
List of field values. Which field values are required - and must therefore be submitted - depends on the configuration of this Picturepark. Please note: categories are defined as a special field value of type ValueAssetContainerAssignment (see code example).
|
FileName | string | The file name with extension, needed only for an upload by MTOM. |
ImportGuid | guid |
Needed only for an upload by MTOM.
|
ImportRelativeFilePath | string | Needed only for batch import, which is not available for public webservices. |
ImportUrl | string |
The url of the file to be imported, not needed for upload by MTOM. For an upload by MTOM (recommended) the ImportGuid is needed instead.
|
IsAssetRightTemplateOverridden | boolean |
Optional. If true, the assigned AssetRightTemplateId is ignored and rights specifically assigned to this asset are applied. Default is false. If true, UserGroupAssetRights must be provided. |
IsDerivativeRightTemplateOverridden | boolean | Optional. If true, the assigned DerivativeRightTemplateId is ignored and rights specifically assigned to this derivative are applied. Default is false. |
OnlyCreateOriginalDerivative | boolean |
Optional. If true, derivatives are not created (except the original derivative). Default is false. Needed only in special cases where the user wishes to import his own derivatives. |
UserGroupAssetRights | ArrayOfUserGroupAssetRights |
The assignment of certain rights for certain groups to this asset. Needed only if IsAssetRightTemplateOverridden = true.
|
UserGroupDerivativeRights | ArrayOfUserGroupDerivativeRights | Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter. |
Type AssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the asset right template. Is ignored, if IsAssetRightTemplateOverridden = true. |
AppliedDerivativeRightTemplateId | int | The id of the derivative right template. Is ignored, if IsDerivativeRightTemplateOverridden = true. |
AssetId | int | The asset id. |
AssetRights | ArrayOfAssetRight | An array with all AssetRights for the current user. |
AssetTypeId | AssetType | In Picturepark, assets are categorized into AssetTypes according to their file extensions. |
AssetVersions | ArrayOfAssetVersion |
An array with all AssetVersions for this asset. In Picturepark, the version logic is implemented as an assignment of one or more assets to a parent asset. Thus, an asset can either have a parent or be a parent. AssetVersion contains the assets, for which it is the parent, while MasterVersions contain the parents. Currently, version types are either language versions or slides. |
AvailableDerivativeDefinitions | ArrayOfint | An array with all available derivative definitions for this asset, ignoring the Usergroups rights. Needed to order derivatives which the user has no right to download. |
Derivatives | ArrayOfDerivative |
An array of Derivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
FieldSetIds | ArrayOfint |
A list of assigned field set ids. FieldSetIds define which fields are assigned to an asset. Needed for AssetClasses. |
FieldValues | ArrayOfKnownFieldValue |
Array of KnownFieldValues. This array contains one entry for each field value. For which fields the values are returned depends on the parameters AdditionalSelectFields in ExtendedAssetFilter. |
IsAssetRightTemplateOverridden | boolean | If true, the applied asset right template is ignored and the rights particularly assigned to this asset are applied. |
IsDerivativeRightTemplateOverridden | boolean | If true, the applied derivative right template is ignored and the rights particularly assigned to the derivatives are applied. |
MasterVersions | ArrayOfAssetVersion | See above under AssetVersions. |
XmpOutOfSync | boolean | Technical flag concerning the rendering state. |
XmpSyncFailed | boolean | Technical flag concerning the rendering state. |
Complex Type ArrayOfAssetItem
Type AssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the asset right template. Is ignored, if IsAssetRightTemplateOverridden = true. |
AppliedDerivativeRightTemplateId | int | The id of the derivative right template. Is ignored, if IsDerivativeRightTemplateOverridden = true. |
AssetId | int | The asset id. |
AssetRights | ArrayOfAssetRight | An array with all AssetRights for the current user. |
AssetTypeId | AssetType | In Picturepark, assets are categorized into AssetTypes according to their file extensions. |
AssetVersions | ArrayOfAssetVersion |
An array with all AssetVersions for this asset. In Picturepark, the version logic is implemented as an assignment of one or more assets to a parent asset. Thus, an asset can either have a parent or be a parent. AssetVersion contains the assets, for which it is the parent, while MasterVersions contain the parents. Currently, version types are either language versions or slides. |
AvailableDerivativeDefinitions | ArrayOfint | An array with all available derivative definitions for this asset, ignoring the Usergroups rights. Needed to order derivatives which the user has no right to download. |
Derivatives | ArrayOfDerivative |
An array of Derivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
FieldSetIds | ArrayOfint |
A list of assigned field set ids. FieldSetIds define which fields are assigned to an asset. Needed for AssetClasses. |
FieldValues | ArrayOfKnownFieldValue |
Array of KnownFieldValues. This array contains one entry for each field value. For which fields the values are returned depends on the parameters AdditionalSelectFields in ExtendedAssetFilter. |
IsAssetRightTemplateOverridden | boolean | If true, the applied asset right template is ignored and the rights particularly assigned to this asset are applied. |
IsDerivativeRightTemplateOverridden | boolean | If true, the applied derivative right template is ignored and the rights particularly assigned to the derivatives are applied. |
MasterVersions | ArrayOfAssetVersion | See above under AssetVersions. |
XmpOutOfSync | boolean | Technical flag concerning the rendering state. |
XmpSyncFailed | boolean | Technical flag concerning the rendering state. |
Type AssetItemCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AllQueryAssetIds | ArrayOfint |
A list of all asset ids in the query. This list is only returned if the param ReturnAllQueryAssetIds in the AssetFilter is true. These asset ids are not necessarily identical with the assets items in the Assets property, e.g. due to the Limit parameter. |
Assets | ArrayOfAssetItem | An array of AssetItem. |
MediaTypeCounts | ArrayOfint |
The number of assets per media type in the order of MediaTypeId. E.g. 111,22,33. 111 assets belong to the first media type (e.g. "all"), 22 to the second and 33 to the third etc. Please note: as with TotalAssets, these figures refer to the whole query, not just to the assets returned. |
TotalAssets | int |
The number of assets in the query. Please note: this figure is not necessarily identical with the number of AssetItems. Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter. |
An array of BusinessProcessShort.
Type ArrayOfBusinessProcessShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessShort | BusinessProcessShort | |
Element UpdateAssetLinks
Type AssetMetadata
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the assigned right template. |
AppliedDerivativeRightTemplateId | int | The id of the right template used to define the access rights for the derivative formats. |
AssetContainerAssignments | ArrayOfAssetContainerAssignmentExtended |
An array with all AssetContainerAssignmentExtendeds for this asset. An asset can be assigned to many asset containers. |
AssetRights | ArrayOfAssetRight | array with all AssetRights for the current user. |
AssetTypeId | AssetType | Bitmap, VectorGraphic, TextDocument, Audio, Video .. |
AssetVersions | ArrayOfAssetVersion |
An array with all AssetVersions for this asset. This array contains all asset versions which have this asset as a parent. |
DerivativeLock | DerivativeLock | DerivativeLock. If not null this asset is locked. |
Derivatives | ArrayOfExtendedDerivative |
An array with all assigned ExtendedDerivatives to which access rights exist. Please note: the data for the original are returned independently of access rights in the property OriginalDerivative. |
Documents | ArrayOfDocument | An array with all assigned Documents. |
FieldValues | ArrayOfFieldValue | An array with all FieldValues for this asset. |
IsAssetRightTemplateOverridden | boolean | If true, there are more specific access rights defined for this asset and the settings of the AppliedAssetRightTemplateId are ignored. |
IsDerivativeRightTemplateOverridden | boolean | Same logic as with IsAssetRightTemplateOverridden. |
MasterVersions | ArrayOfAssetVersion |
An array with all master AssetVersions for this asset. This array contains all assets which are a parent version for this asset. |
MediaInfos | ArrayOfMediaInfo | A list of MediaInfos if the asset is an audio or a video. |
OriginalDerivative | ExtendedDerivative |
Original ExtendedDerivative. The data for the original are always returned, even if there are no access rights to the original. |
ParentAsset | ArrayOfAssetItem |
An array with all parent AssetItems. An asset can have more than one parent. |
ParentAssetId | int | The id of the parent asset. |
ReferencedAssets | ArrayOfAssetItem | An array with all AssetItems to which this asset refers (from Documents). |
ReferringAssets | ArrayOfAssetItem | An array with all AssetItems which refer to this asset (from AssetObjects). |
XmpItems | ArrayOfXmpItem | An array with XmpItems if the asset is an image and metadata mapping is enabled. |
Type AssetObject
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
AssetObjectId | int | |
AssetObjectType | AssetObjectType | |
CommentId | int | |
DerivativeDefinitionId | int | |
DocumentPageId | int | |
HeightInCm | double | |
JsonSerializedSvgAttributes | string | |
LinkedAssetId | int | |
LinkedUrl | string | |
PositionLeftInCm | double | |
PositionTopInCm | double | |
RelativeFilePath | string | |
SortOrder | int | |
WidthInCm | double | |
ts | base64Binary | |
Complex Type ArrayOfAssetObject
Type AssetObject
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
AssetObjectId | int | |
AssetObjectType | AssetObjectType | |
CommentId | int | |
DerivativeDefinitionId | int | |
DocumentPageId | int | |
HeightInCm | double | |
JsonSerializedSvgAttributes | string | |
LinkedAssetId | int | |
LinkedUrl | string | |
PositionLeftInCm | double | |
PositionTopInCm | double | |
RelativeFilePath | string | |
SortOrder | int | |
WidthInCm | double | |
ts | base64Binary | |
Type ArrayOfAssetObject
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetObject | AssetObject | |
Complex Type DocumentPage
Type AssetObjectType
Value | Description |
---|---|
LinkedAsset | |
LinkedUrl | |
Rectangle | |
Text | |
Arrow |
Complex Type AssetObject
Type AssetObjectType
Value | Description |
---|---|
LinkedAsset | |
LinkedUrl | |
Rectangle | |
Text | |
Arrow |
Type AssetRight
Value | Description |
---|---|
List | |
ViewMetadata | |
EditMetadata | |
Delete | |
ManageDerivatives | |
ViewRights | |
EditRights | |
EditContainerAssignments | |
ViewVersions | |
EditVersions | |
ViewStatistics | |
ViewJournal | |
ViewEmbeddedMetadata |
Complex Type ArrayOfAssetRight
Type AssetRight
Value | Description |
---|---|
List | |
ViewMetadata | |
EditMetadata | |
Delete | |
ManageDerivatives | |
ViewRights | |
EditRights | |
EditContainerAssignments | |
ViewVersions | |
EditVersions | |
ViewStatistics | |
ViewJournal | |
ViewEmbeddedMetadata |
An array with all AssetRights for the current user.
Type ArrayOfAssetRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetRight | AssetRight | |
Complex Type AssetItem
array with all AssetRights for the current user.
Type ArrayOfAssetRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetRight | AssetRight | |
Complex Type AssetMetadata
Type ArrayOfAssetRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetRight | AssetRight | |
Complex Type UserGroupAssetRights
The id of an AssetRightTemplate.
Type int
Complex Type AssetImportOptions
An array of AssetItem.
Type ArrayOfAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetItem | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
Complex Type AssetItemCollection
An array of AssetItem.
Type ArrayOfPortAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PortAssetItem | PortAssetItem | An AssetItem represents the attributes of one asset including relations to other assets. The structure is built to be directly shwoed in web |
Complex Type PortAssetItemCollection
A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetSelection | AssetSelection | |
Element Download
A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetSelection | AssetSelection | |
Element DownloadExtended
A list of AssetSelections.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetSelection | AssetSelection | |
Element GetDerivatives
Type AssetSelection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
Complex Type ArrayOfAssetSelection
Type AssetSelection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
A list of asset selections.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetSelection | AssetSelection | |
Element CreateAssetLink
Type AssetType
Value | Description |
---|---|
Unknown | |
Bitmap | |
VectorGraphic | |
RawImage | |
InterchangeDocument | |
WordProcessingDocument | |
TextDocument | |
DesktopPublishingDocument | |
Presentation | |
Spreadsheet | |
Archive | |
Audio | |
Video | |
Font | |
Multimedia | |
Application | |
SourceCode | |
Database | |
Cad | |
Model3d |
Complex Type RightTemplate2AssetType
Type AssetType
Value | Description |
---|---|
Unknown | |
Bitmap | |
VectorGraphic | |
RawImage | |
InterchangeDocument | |
WordProcessingDocument | |
TextDocument | |
DesktopPublishingDocument | |
Presentation | |
Spreadsheet | |
Archive | |
Audio | |
Video | |
Font | |
Multimedia | |
Application | |
SourceCode | |
Database | |
Cad | |
Model3d |
In Picturepark, assets are categorized into AssetTypes according to their file extensions.
Type AssetType
Value | Description |
---|---|
Unknown | |
Bitmap | |
VectorGraphic | |
RawImage | |
InterchangeDocument | |
WordProcessingDocument | |
TextDocument | |
DesktopPublishingDocument | |
Presentation | |
Spreadsheet | |
Archive | |
Audio | |
Video | |
Font | |
Multimedia | |
Application | |
SourceCode | |
Database | |
Cad | |
Model3d |
Complex Type AssetItem
Bitmap, VectorGraphic, TextDocument, Audio, Video ..
Type AssetType
Value | Description |
---|---|
Unknown | |
Bitmap | |
VectorGraphic | |
RawImage | |
InterchangeDocument | |
WordProcessingDocument | |
TextDocument | |
DesktopPublishingDocument | |
Presentation | |
Spreadsheet | |
Archive | |
Audio | |
Video | |
Font | |
Multimedia | |
Application | |
SourceCode | |
Database | |
Cad | |
Model3d |
Complex Type AssetMetadata
Type AssetType
Value | Description |
---|---|
Unknown | |
Bitmap | |
VectorGraphic | |
RawImage | |
InterchangeDocument | |
WordProcessingDocument | |
TextDocument | |
DesktopPublishingDocument | |
Presentation | |
Spreadsheet | |
Archive | |
Audio | |
Video | |
Font | |
Multimedia | |
Application | |
SourceCode | |
Database | |
Cad | |
Model3d |
Complex Type PortAssetItem
Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images.
Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized.
Default: all
AssetTypeIds = new List<int> {2, 6, 20}
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type ExtendedAssetFilter
An array with the ids of asset types assigned to this field. Currently not used.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type Field
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type RightTemplate
Complex data type containing multiple update parameters.
Type AssetUpdateOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteImportFilePath | anyURI |
The uri of the import file path. Not needed if MTOM is used.
|
AssetId | int | The asset id. |
CreateHistoricVersion | boolean | Optional. If true, the old asset is not overwritten, but kept as a historic version. Default is false. |
DeleteDependentAssets | boolean | Optional. If true, dependent assets like versions are deleted. Default is false. |
FileName | string | The file name, which must have an extension. Needed only for an upload by MTOM. |
HistoricVersionDescription | string | Optional. Same logic as HistoricVersionName. |
HistoricVersionDescription4Master | string | Optional. Same logic as HistoricVersionName4Master. |
HistoricVersionName | string | Optional. The name of the newly created historic version (if param CreateHistoricVersion = true). |
HistoricVersionName4Master | string | Optional. The historic version name of the newly uploaded asset (if param CreateHistoricVersion = true). |
ImportGuid | guid |
The guid, needed for an upload by MTOM (as is recommended). Please note: the file name, which must have an extension, is also needed for an upload by MTOM.
|
KeepAssetId4NewFileOnHistorize | boolean | If true, the new file inherits the asset id of the old. |
OnlyCreateOriginalDerivative | boolean |
Optional. If true, derivatives are not created (except the original derivative). Default is false. Needed only in special cases where the user wishes to import his own derivatives. |
TemporaryFileHandling | TemporaryFileHandling |
Optional. How to handle the temporary files. Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.
|
Element UpdateOriginalDerivative
Type AssetUpdateOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteImportFilePath | anyURI |
The uri of the import file path. Not needed if MTOM is used.
|
AssetId | int | The asset id. |
CreateHistoricVersion | boolean | Optional. If true, the old asset is not overwritten, but kept as a historic version. Default is false. |
DeleteDependentAssets | boolean | Optional. If true, dependent assets like versions are deleted. Default is false. |
FileName | string | The file name, which must have an extension. Needed only for an upload by MTOM. |
HistoricVersionDescription | string | Optional. Same logic as HistoricVersionName. |
HistoricVersionDescription4Master | string | Optional. Same logic as HistoricVersionName4Master. |
HistoricVersionName | string | Optional. The name of the newly created historic version (if param CreateHistoricVersion = true). |
HistoricVersionName4Master | string | Optional. The historic version name of the newly uploaded asset (if param CreateHistoricVersion = true). |
ImportGuid | guid |
The guid, needed for an upload by MTOM (as is recommended). Please note: the file name, which must have an extension, is also needed for an upload by MTOM.
|
KeepAssetId4NewFileOnHistorize | boolean | If true, the new file inherits the asset id of the old. |
OnlyCreateOriginalDerivative | boolean |
Optional. If true, derivatives are not created (except the original derivative). Default is false. Needed only in special cases where the user wishes to import his own derivatives. |
TemporaryFileHandling | TemporaryFileHandling |
Optional. How to handle the temporary files. Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.
|
Type AssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Asset | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
AssetVersionId | int | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Description | string | |
LanguageId | int | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
ParentAssetId | int | The id of the parent asset. Null, if this version is a master. |
SortOrder | int | |
Version | string | The name of the version, e.g. "English" or "French". |
VersionOptionId | int | |
VersionTypeId | int |
Versiontypes are e.g. Languages, History, Associated, Presentation etc. They are individually configurable for each Picturepark. Language usually exists and has the id = 1. |
ts | base64Binary | |
Complex Type ArrayOfAssetVersion
Type AssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Asset | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
AssetVersionId | int | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Description | string | |
LanguageId | int | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
ParentAssetId | int | The id of the parent asset. Null, if this version is a master. |
SortOrder | int | |
Version | string | The name of the version, e.g. "English" or "French". |
VersionOptionId | int | |
VersionTypeId | int |
Versiontypes are e.g. Languages, History, Associated, Presentation etc. They are individually configurable for each Picturepark. Language usually exists and has the id = 1. |
ts | base64Binary | |
A list of AssetVersions.
There are currently two types of assetversions: languages and slides.
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Element AddAssetVersions
A list of AssetVersions.
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Element RemoveAssetVersions
Optional. List of asset versions.
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Complex Type AssetImportOptions
An array with all AssetVersions for this asset.
In Picturepark, the version logic is implemented as an assignment of one or more assets to a parent asset.
Thus, an asset can either have a parent or be a parent.
AssetVersion contains the assets, for which it is the parent, while MasterVersions contain the parents.
Currently, version types are either language versions or slides.
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Complex Type AssetItem
An array with all AssetVersions for this asset.
This array contains all asset versions which have this asset as a parent.
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Complex Type AssetMetadata
Type BitrateMode
Value | Description |
---|---|
Variable | |
Constant |
Complex Type AudioStream
Type duration
Value must match the following pattern: \-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?
The value must be greater than or equal to -P10675199DT2H48M5.4775808S.
The value must be less than or equal to P10675199DT2H48M5.4775807S.
Complex Type AudioStream
Type AudioStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioBitRate | int | |
AudioBitRateMode | BitrateMode | |
AudioChannelPositions | string | |
AudioChannels | int | |
AudioCodec | string | |
AudioDuration | duration | |
AudioFormat | string | |
AudioLanguage | string | |
AudioResolution | int | |
AudioSamplingRate | int | |
AudioStreamSize | long | |
Complex Type ArrayOfAudioStream
Type AudioStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioBitRate | int | |
AudioBitRateMode | BitrateMode | |
AudioChannelPositions | string | |
AudioChannels | int | |
AudioCodec | string | |
AudioDuration | duration | |
AudioFormat | string | |
AudioLanguage | string | |
AudioResolution | int | |
AudioSamplingRate | int | |
AudioStreamSize | long | |
Type ArrayOfAudioStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioStream | AudioStream | |
Complex Type MediaInfo
The email address of the user, who serves to authenticate the connection.
Type string
Element GetSecurityToken
The password of that user.
Type string
Element GetSecurityToken
An array with all available derivative definitions for this asset, ignoring the Usergroups rights. Needed to order derivatives which the user has no right to download.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type AssetItem
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type Download
Type guid
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Complex Type DerivativeDefinition
Type base64Binary
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Needed for control type TagBox and defines root of the tagbox.
Type int
Complex Type Field
The guid received from GetSubscriptionInfo
Type string
Element ConfirmSubscriptionInfoReceived
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DateTimeBeforeOperation
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DateTimeBetweenOperation
Type boolean
Defines the boost factor for Fulltext search
Type float
Complex Type Field
The buffer containing the chunk
Type base64Binary
Element UploadChunk
The buffer containing the first chunk.
Type base64Binary
Element UploadFirstChunk
Optional. Not needed by integrators.
Type int
Element GetMetadata
Optional. Not needed for integrators.
Type int
Complex Type AssetFilter
Complex Type ExtendedAssetFilter
A mailing id. Valid only in combination with a valid MailingToken.
Needed for access rights, does not cause the download to return all assets in a mailing.
Type int
Complex Type DownloadOptions
A list of the businessprocess ids to be deleted.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element DeleteAssetLinks
A list of businessprocess ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element GetAssetLinksById
Type BusinessProcessLink
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
BusinessProcessUrl | anyURI | |
DerivativeDefinitionId | int | |
Complex Type ArrayOfBusinessProcessLink
Type BusinessProcessLink
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
BusinessProcessUrl | anyURI | |
DerivativeDefinitionId | int | |
Type BusinessProcessShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessId | int | |
BusinessProcessType | BusinessProcessType | |
Description | string | |
ExpirationDate | DateTimeOffset | |
FacetConfigurationId | int | |
LinkToken | string | |
MailingUrl | anyURI | |
MailingUrlForDownload | anyURI | |
MailingUrlsForDownload | ArrayOfBusinessProcessLink | |
MailingUrlsForView | ArrayOfBusinessProcessLink | |
Name | string | |
SelectedAssets | ArrayOfAssetSelection | |
ts | base64Binary | |
Complex Type ArrayOfBusinessProcessShort
Type BusinessProcessShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessId | int | |
BusinessProcessType | BusinessProcessType | |
Description | string | |
ExpirationDate | DateTimeOffset | |
FacetConfigurationId | int | |
LinkToken | string | |
MailingUrl | anyURI | |
MailingUrlForDownload | anyURI | |
MailingUrlsForDownload | ArrayOfBusinessProcessLink | |
MailingUrlsForView | ArrayOfBusinessProcessLink | |
Name | string | |
SelectedAssets | ArrayOfAssetSelection | |
ts | base64Binary | |
Optional. Not needed by integrators.
Type string
Element GetMetadata
Optional. Not needed for integrators.
Type string
Complex Type AssetFilter
Complex Type ExtendedAssetFilter
Token for a business process, must be given in combination with a BusinessProcessId.
Type string
Complex Type DownloadOptions
Type BusinessProcessType
Value | Description |
---|---|
AssetMailing | |
AssetReview | |
AssetLink | |
AssetPublishing |
Complex Type BusinessProcessShort
Type BusinessProcessType
Value | Description |
---|---|
AssetMailing | |
AssetReview | |
AssetLink | |
AssetPublishing |
Type byte
Used in UI set to user language4content's caption
Type string
Complex Type FacetConfigurationGroup
Used in UI set to user language4content's caption
Type string
Complex Type FacetConfigurationRange
The captions of the facet groups that are not collapsed (open). These are necessary to tell the UI which ones to open so that the user has the same state after fetching data.
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Complex Type FacetSearchParameter
Type char
An array with child AssetContainerItems.
Type ArrayOfAssetContainerItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerItem | AssetContainerItem | An AssetContainerItem represents the attributes of one asset container including relations to other asset containers. |
Complex Type AssetContainerItem
Type ArrayOfXmpItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
XmpItem | XmpItem | |
Complex Type XmpItem
Type ClaimGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GroupSid | string | |
IdentityProviderId | int | |
UserGroupId | int | |
UserGroups2ClaimGroupId | int | |
Complex Type ArrayOfClaimGroup
Type ClaimGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GroupSid | string | |
IdentityProviderId | int | |
UserGroupId | int | |
UserGroups2ClaimGroupId | int | |
Type ArrayOfClaimGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroup | ClaimGroup | |
Complex Type UserGroupItem
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DerivativeLock
The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
Type string
Element CreateSession
The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
Type string
Element GetSecurityToken
The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
Type string
Element LoginWithSecurityToken
The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
Type string
Element LoginWithSecurityToken2
Type ComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Complex Type ArrayOfComparisonOperation
Type ComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Complex Type FacetValue
Type ComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Type ArrayOfComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperation | ComparisonOperation | |
Complex Type AndOperation
Type ArrayOfAssetContainerComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerComparisonOperation | AssetContainerComparisonOperation | |
Complex Type AssetContainerAndOperation
Type ArrayOfAssetContainerComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerComparisonOperation | AssetContainerComparisonOperation | |
Complex Type AssetContainerOrOperation
Type ArrayOfComparisonOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperation | ComparisonOperation | |
Complex Type OrOperation
Value | Description |
---|---|
DateTimeAfterOperation | |
DateTimeBeforeOperation | |
DateTimeBetweenOperation | |
DateTimeEqualOperation | |
NumericBetweenOperation | |
NumericEqualOperation | |
NumericLargerThanOperation | |
NumericNotEqualOperation | |
NumericSmallerThanOperation | |
StringContainsOperation | |
StringEmptyOperation | |
StringEqualOperation | |
StringNotContainsOperation | |
StringNotEmptyOperation | |
StringNotEqualOperation | |
StringStartsWithOperation | |
AssetContainerIncludeOperation | |
AssetContainerExcludeOperation | |
StringListContainsOperation | |
StringListEqualOperation | |
NumericListEqualOperation | |
DateTimeNowAfterOrEqualOperation | |
DateTimeNowBeforeOrEqualOperation | |
DateTimeNowOlderOperation | |
DateTimeNowLastOperation | |
DateTimeNowNextOperation | |
DateTimeNowAfterOperation | |
AssetContainerIncludeFieldOperation | |
AssetContainerExcludeFieldOperation | |
StringListContainsExactOperation |
Complex Type FacetValue
Value | Description |
---|---|
DateTimeAfterOperation | |
DateTimeBeforeOperation | |
DateTimeBetweenOperation | |
DateTimeEqualOperation | |
NumericBetweenOperation | |
NumericEqualOperation | |
NumericLargerThanOperation | |
NumericNotEqualOperation | |
NumericSmallerThanOperation | |
StringContainsOperation | |
StringEmptyOperation | |
StringEqualOperation | |
StringNotContainsOperation | |
StringNotEmptyOperation | |
StringNotEqualOperation | |
StringStartsWithOperation | |
AssetContainerIncludeOperation | |
AssetContainerExcludeOperation | |
StringListContainsOperation | |
StringListEqualOperation | |
NumericListEqualOperation | |
DateTimeNowAfterOrEqualOperation | |
DateTimeNowBeforeOrEqualOperation | |
DateTimeNowOlderOperation | |
DateTimeNowLastOperation | |
DateTimeNowNextOperation | |
DateTimeNowAfterOperation | |
AssetContainerIncludeFieldOperation | |
AssetContainerExcludeFieldOperation | |
StringListContainsExactOperation |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
subscriptionActionId | int | The id of the subscription action. |
batchGuid | string | The guid received from GetSubscriptionInfo |
Restricting anyType
Always empty.
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Complex Type StringListContainsExactOperation
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Complex Type StringListContainsOperation
ComboBox, DateField, Checkbox ..
Type ControlType
Value | Description |
---|---|
ComboBox | |
DateField | |
DateTimeField | |
Checkbox | |
MultiCheckbox | |
RadioButton | |
TextField | |
TextArea | |
Label | |
NumberField | |
Password | |
InternalContactEmailField | |
ComboBox4Users | |
TagBox |
Complex Type Field
Type ControlType
Value | Description |
---|---|
ComboBox | |
DateField | |
DateTimeField | |
Checkbox | |
MultiCheckbox | |
RadioButton | |
TextField | |
TextArea | |
Label | |
NumberField | |
Password | |
InternalContactEmailField | |
ComboBox4Users | |
TagBox |
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element AddAssets2AssetContainers
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element AddAssetVersions
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element ConfirmSubscriptionInfoReceived
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element CreateAssetContainer
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element CreateAssetLink
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element CreateRenderingJob
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element CreateTraceJob
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element CreateUser
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element DeleteAssetLinks
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element DeleteDerivative
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element Download
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element DownloadExtended
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssetContainerRights
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssetContainers
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssetFields
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssetLinksById
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssetRights
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssets
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssets2
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssetsByIds
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssetsMetadata
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetAssetVersions
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetConfiguration
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetConfigurationModificationDate
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetDerivativeRights
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetDerivatives
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetFacetConfigurationExtended
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetFacets
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetFieldSetIdByFieldName
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetLanguageConfiguration
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetMetadata
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetRights
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetSubscriptionInfo
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetTotalAssets
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetUserById
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element GetUsers
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element ImportSingleAsset
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element IsValid
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element Login
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element LoginWithSecurityToken
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element LoginWithSecurityToken2
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element MoveAssetContainer
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element RemoveAssetContainer
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element RemoveAssets
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element RemoveAssetsFromAssetContainers
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element RemoveAssetVersions
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element RemoveUsers
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element RenewSession
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element SaveAssetContainerRights
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element SaveAssetsRights
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element SaveDerivative
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element SaveDerivativeRights
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UpdateAssetContainer
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UpdateAssetLinks
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UpdateAssetMetadata
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UpdateAssetsMetadata
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UpdateFieldSetDefaultValue
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UpdateOriginalDerivative
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UpdateUser
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UploadChunk
The CoreInfo object which has been returned by CreateSession.
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element UploadFirstChunk
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Type ArrayOfCountry
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Country | Country | |
Complex Type PublicConfiguration
Type Country
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Code | string | |
CountryId | int | |
Name | string | |
Complex Type ArrayOfCountry
Type Country
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Code | string | |
CountryId | int | |
Name | string | |
Complex Type UserData
Type Country
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Code | string | |
CountryId | int | |
Name | string | |
The id of the country.
Type int
Complex Type CountryTranslation
The name of the country in german(1), english(2) or french(3).
E.g. "Deutschland", "Germany", "Allemagne".
Type string
Complex Type CountryTranslation
Type CountryTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CountryId | int | The id of the country. |
CountryName | string |
The name of the country in german(1), english(2) or french(3). E.g. "Deutschland", "Germany", "Allemagne". |
CountryTranslationId | int | |
LanguageId | int |
The id of the language which determines the country name (NOT the language spoken in this country). Country names are available in the languages: 1:german, 2:english, 3:french. |
Complex Type ArrayOfCountryTranslation
Type CountryTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CountryId | int | The id of the country. |
CountryName | string |
The name of the country in german(1), english(2) or french(3). E.g. "Deutschland", "Germany", "Allemagne". |
CountryTranslationId | int | |
LanguageId | int |
The id of the language which determines the country name (NOT the language spoken in this country). Country names are available in the languages: 1:german, 2:english, 3:french. |
Type ArrayOfCountryTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CountryTranslation | CountryTranslation | |
Complex Type UserShort
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
parentAssetContainerId | int | The id of the asset container where the new container is created. |
assetContainerTranslations | ArrayOfAssetContainerTranslation | A list of AssetContainerTranslations with the language specific asset container names and descriptions. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreateAssetContainerResult | int | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
name | string | The name. |
description | string | The description. |
assetSelections | ArrayOfAssetSelection | A list of asset selections. |
expirationDate | DateTimeOffset | The expiry date. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreateAssetLinkResult | BusinessProcessShort | |
Type BusinessProcessShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessId | int | |
BusinessProcessType | BusinessProcessType | |
Description | string | |
ExpirationDate | DateTimeOffset | |
FacetConfigurationId | int | |
LinkToken | string | |
MailingUrl | anyURI | |
MailingUrlForDownload | anyURI | |
MailingUrlsForDownload | ArrayOfBusinessProcessLink | |
MailingUrlsForView | ArrayOfBusinessProcessLink | |
Name | string | |
SelectedAssets | ArrayOfAssetSelection | |
ts | base64Binary | |
Element CreateAssetLinkResponse
The id of the user who created the container.
Type int
Complex Type AssetContainerItem
Optional. If true, the old asset is not overwritten, but kept as a historic version. Default is false.
Type boolean
Complex Type AssetUpdateOptions
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
renderingClient | RenderingClient | The RenderingClient. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreateRenderingJobResult | int | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
customerId | int | The id of the customer (picturepark), e.g. 123. |
language | ApplicationLanguage |
The ui language, e.g. "English" or "Norwegian". This value is written to the session log and never used again for any other purposes. Neither is it returned in coreInfo. After a user logs in, the language for this user is taken from the language defined for this user in the database. |
language4ContentId | int |
Optional. The id of the content language. The Language4Content is not a language, but a language configuration set, which defines the respective languages for metadata, asset containers and searching. If null, the default language4contentId for this Picturepark is used for CreateSession. As with the ui language, this value is written to the session log and never used again for any other purposes. Neither is it returned in coreInfo. After a user logs in, the content language for this user is taken from the content language defined for this user in the database. |
aspNetSessionId | string | Optional. The aspNetSessionId (if known), which enables the system to retrieve a lost session, e.g. in case of a browser reload. |
skin | SkinColor |
Optional. Available options: "SkinColor.Blue" and "SkinColor.Gray". SkinColor? skin = SkinColor.Blue; |
clientGuid | string | The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server. |
httpContextRequestInfo | HttpContextRequestInfo |
Optional. These informations, which are needed for logging purposes, must be gathered and submitted only by the web ui. In all other cases null should be submitted. |
traceJobId | int |
Optional. Only submit this parameter if the method call is part of a trace job. The traces within a trace job are pooled for special reporting capabilities. To get a traceJobId, you must call the webservice CreateTraceJob, which is only available in the extended public webservices. Needed for tracing purposes only. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreateSessionResult | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element CreateSessionResponse
If true, a zipfile which contains all files is created on the server for download. You get ONE link to this zip file.
Otherwise you get one Link for each derivative.
Type boolean
Element DownloadExtended
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
traceJobType | TraceJobType | The TraceJobType. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreateTraceJobResult | int | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
userData | UserData | UserData for the new user. |
password | string | The password. Must have the minimum strength as defined for this customer. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreateUserResult | int | |
If false and the download contains only one file, then the file is not zipped.
Type boolean
Complex Type DownloadOptions
The creation date.
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type AssetContainerItem
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type AssetVersion
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DerivativeLock
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type ExtendedDerivative
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type RightTemplate
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type RightTemplate2AssetType
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type RightTemplate2Right
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type RightTemplate2UserGroup
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type Skin
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserData
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserShort
The id of the customer (picturepark), e.g. 123.
Type int
Element CreateSession
The id of the customer (picturepark), e.g. 27.
Type int
Element GetSecurityToken
The id of the customer (Picturepark), which must be submitted when creating a session.
For Picturepark server solutions, this id is usually 1.
Type int
Complex Type CoreInfo
E.g. "Media database Walchwil". Currently not used, always null.
Type string
Complex Type CoreInfo
Integer32, String, Date, Boolean ..
Type DataType
Value | Description |
---|---|
Integer32 | |
Integer64 | |
String | |
Date | |
DateTime | |
Boolean | |
Double | |
AlphaHandling | |
BlurType | |
FlipType | |
NullableInteger32 | |
Float | |
UserShort | |
NullableDouble | |
Color | |
AssetContainerAssignment |
Complex Type Field
Type DataType
Value | Description |
---|---|
Integer32 | |
Integer64 | |
String | |
Date | |
DateTime | |
Boolean | |
Double | |
AlphaHandling | |
BlurType | |
FlipType | |
NullableInteger32 | |
Float | |
UserShort | |
NullableDouble | |
Color | |
AssetContainerAssignment |
Complex Type MetadataProperty
Type DataType
Value | Description |
---|---|
Integer32 | |
Integer64 | |
String | |
Date | |
DateTime | |
Boolean | |
Double | |
AlphaHandling | |
BlurType | |
FlipType | |
NullableInteger32 | |
Float | |
UserShort | |
NullableDouble | |
Color | |
AssetContainerAssignment |
Type FacetDateRange
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
From | string | |
To | string | |
Complex Type FacetConfigurationRange
Type dateTime
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
AfterDateTime | DateTimeOffset | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
BeforeDateTime | DateTimeOffset | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
AfterDateTime | DateTimeOffset | |
BeforeDateTime | DateTimeOffset | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualDateTime | DateTimeOffset | |
Type DateTimeNowAfterOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Type DateTimeNowAfterOrEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Type DateTimeNowBeforeOrEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Type DateTimeNowOlderOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Minutes | int | |
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Type decimal
The default field column width for the asset browser grid view.
Type int
Complex Type Field
The new default value.
Type ArrayOfFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Element UpdateFieldSetDefaultValue
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
businessProcessIds | ArrayOfint | A list of the businessprocess ids to be deleted. |
Restricting anyType
Always empty.
If true, asset versions depending on the deleted assets are also deleted.
Assets versions are currently either language versions or slides (belonging to a Powerpoint presentation).
Type boolean
Element RemoveAssets
Optional. If true, dependent assets like versions are deleted. Default is false.
Type boolean
Complex Type AssetUpdateOptions
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
derivativeDefinitionId | int | The derivative definition id. |
Restricting anyType
Always empty.
Type Derivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
DerivativeId | int | |
FileExtensionId | int | |
FileName | string | E.g. "Matterhorn1.jpg". |
FileSizeInBytes | long | |
ImageHeight | int | |
ImageWidth | int | |
PublicAbsoluteUrl | string | E.g. http://picturepark.vit.local/Public/1/ThumbnailSmall/1031.jpg. |
RenderingState | RenderingState | Technical flag concerning the rendering state. |
VideoDurationInSeconds | double | |
VideoHeight | int | |
VideoWidth | int | |
ts | base64Binary | |
Complex Type ArrayOfDerivative
Type Derivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
DerivativeId | int | |
FileExtensionId | int | |
FileName | string | E.g. "Matterhorn1.jpg". |
FileSizeInBytes | long | |
ImageHeight | int | |
ImageWidth | int | |
PublicAbsoluteUrl | string | E.g. http://picturepark.vit.local/Public/1/ThumbnailSmall/1031.jpg. |
RenderingState | RenderingState | Technical flag concerning the rendering state. |
VideoDurationInSeconds | double | |
VideoHeight | int | |
VideoWidth | int | |
ts | base64Binary | |
Type DerivativeDefinition
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioBitrate | int | |
AudioQuality | int | |
AudioSamplingFrequency | int | |
AudioUse4Preview | boolean | |
AvPresetId | guid | |
DerivativeDefinition2AssetTypes | ArrayOfDerivativeDefinition2AssetType | |
DerivativeDefinitionId | int | |
DerivativeType | DerivativeType | |
Group | int | |
IconId | int | |
ImageColorProfileId | int | |
ImageColorTransformationIntentId | int | |
ImageEncodingOptionId | int | |
ImageKeepClippingPath | boolean | |
ImageResolution | int | |
Name | string | |
OutputFileExtensionId | int | |
ProvideAsDownload | boolean | |
RelativeBasePath | string | |
RenderingActionValues | ArrayOfRenderingActionValue | |
SortOrder | int | |
TrackUsagePurpose | boolean | |
Translations | ArrayOfDerivativeDefinitionTranslation | |
Use4AssetConversion | boolean | |
UseGuid4FileName | boolean | |
UsePublicFileDirectory | boolean | |
UseVideo4Thumbnails | boolean | |
VideoAudioBitrate | int | |
VideoAudioCodecId | int | |
VideoBitrate | int | |
VideoCodecId | int | |
WriteXmp2File | boolean | |
ts | base64Binary | |
Complex Type ArrayOfDerivativeDefinition
Type DerivativeDefinition
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioBitrate | int | |
AudioQuality | int | |
AudioSamplingFrequency | int | |
AudioUse4Preview | boolean | |
AvPresetId | guid | |
DerivativeDefinition2AssetTypes | ArrayOfDerivativeDefinition2AssetType | |
DerivativeDefinitionId | int | |
DerivativeType | DerivativeType | |
Group | int | |
IconId | int | |
ImageColorProfileId | int | |
ImageColorTransformationIntentId | int | |
ImageEncodingOptionId | int | |
ImageKeepClippingPath | boolean | |
ImageResolution | int | |
Name | string | |
OutputFileExtensionId | int | |
ProvideAsDownload | boolean | |
RelativeBasePath | string | |
RenderingActionValues | ArrayOfRenderingActionValue | |
SortOrder | int | |
TrackUsagePurpose | boolean | |
Translations | ArrayOfDerivativeDefinitionTranslation | |
Use4AssetConversion | boolean | |
UseGuid4FileName | boolean | |
UsePublicFileDirectory | boolean | |
UseVideo4Thumbnails | boolean | |
VideoAudioBitrate | int | |
VideoAudioCodecId | int | |
VideoBitrate | int | |
VideoCodecId | int | |
WriteXmp2File | boolean | |
ts | base64Binary | |
Type DerivativeDefinition2AssetType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetTypeId | int | |
DerivativeDefinition2AssetTypeId | int | |
DerivativeDefinitionId | int | |
ts | base64Binary | |
Complex Type ArrayOfDerivativeDefinition2AssetType
Type DerivativeDefinition2AssetType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetTypeId | int | |
DerivativeDefinition2AssetTypeId | int | |
DerivativeDefinitionId | int | |
ts | base64Binary | |
Type ArrayOfDerivativeDefinition2AssetType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinition2AssetType | DerivativeDefinition2AssetType | |
Complex Type DerivativeDefinition
The derivative definition id.
Type int
Element DeleteDerivative
The deriviative definition id.
Type int
Complex Type DerivativeUpdateOptions
Type DerivativeDefinitionRight
Value | Description |
---|---|
CanBeOrdered |
Complex Type ArrayOfDerivativeDefinitionRight
Type DerivativeDefinitionRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionId | int | |
DerivativeRights | ArrayOfDerivativeRight | |
Complex Type ArrayOfDerivativeDefinitionRights
Type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe | anyType (restriction) | |
Complex Type Rights
Type ArrayOfDerivativeDefinitionRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRights | DerivativeDefinitionRights | |
Complex Type UserDerivativeRights
Type DerivativeDefinitionRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionId | int | |
DerivativeRights | ArrayOfDerivativeRight | |
Type ArrayOfDerivativeDefinition
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinition | DerivativeDefinition | |
Complex Type PublicConfiguration
Type DerivativeDefinitionTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionId | int | |
DerivativeDefinitionTranslationId | int | |
Description | string | |
LanguageId | int | |
Name | string | |
ShortName | string | |
ts | base64Binary | |
Complex Type ArrayOfDerivativeDefinitionTranslation
Type DerivativeDefinitionTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionId | int | |
DerivativeDefinitionTranslationId | int | |
Description | string | |
LanguageId | int | |
Name | string | |
ShortName | string | |
ts | base64Binary | |
DerivativeLock. If not null this asset is locked.
Type DerivativeLock
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteCheckoutFilePath | string | |
AssetId | int | |
CheckoutReason | string | |
ClientComputerName | string | |
ClientFileModificationDate | DateTimeOffset | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
DerivativeDefinitionId | int | |
DerivativeId | int | |
DerivativeLockId | int | |
DerivativeModificationDate | DateTimeOffset | |
DerivativeModifiedByUser | UserCompact | |
FieldValues | ArrayOfKnownFieldValue | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
OriginalDerivativeModificationDate | DateTimeOffset | |
UrlThumbnailSmall | string | |
UserId | int | |
ts | base64Binary | |
Complex Type AssetMetadata
Type DerivativeLock
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteCheckoutFilePath | string | |
AssetId | int | |
CheckoutReason | string | |
ClientComputerName | string | |
ClientFileModificationDate | DateTimeOffset | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
DerivativeDefinitionId | int | |
DerivativeId | int | |
DerivativeLockId | int | |
DerivativeModificationDate | DateTimeOffset | |
DerivativeModifiedByUser | UserCompact | |
FieldValues | ArrayOfKnownFieldValue | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
OriginalDerivativeModificationDate | DateTimeOffset | |
UrlThumbnailSmall | string | |
UserId | int | |
ts | base64Binary | |
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DerivativeLock
Type UserCompact
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
EmailAddress | string | |
FirstName | string | |
LastName | string | |
UserId | int | |
Complex Type DerivativeLock
Type DerivativeRight
Value | Description |
---|---|
Download |
Complex Type ArrayOfDerivativeRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeRight | DerivativeRight | |
Complex Type DerivativeDefinitionRights
Type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h | anyType (restriction) | |
Complex Type UserGroupDerivativeRights
The id of a DerivativeRightTemplate.
Type int
Complex Type AssetImportOptions
An array of Derivatives for this asset.
A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.
Type ArrayOfDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Derivative | Derivative | A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
Complex Type AssetItem
An array with all assigned ExtendedDerivatives to which access rights exist.
Please note: the data for the original are returned independently of access rights in the property OriginalDerivative.
Type ArrayOfExtendedDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ExtendedDerivative | ExtendedDerivative | An extended derivative provides more detailed information than the usual derivative. |
Complex Type AssetMetadata
Type DerivativeType
Value | Description |
---|---|
Original | |
Static | |
Dynamic | |
ThumbnailSmall | |
ThumbnailMedium | |
ThumbnailLarge | |
Custom |
Complex Type DerivativeDefinition
Type DerivativeType
Value | Description |
---|---|
Original | |
Static | |
Dynamic | |
ThumbnailSmall | |
ThumbnailMedium | |
ThumbnailLarge | |
Custom |
Complex data type containing multiple update parameters.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteImportFilePath | anyURI |
The uri of the import file path. Not needed if MTOM is used.
|
AssetId | int | The asset id. |
DerivativeDefinitionId | int | The deriviative definition id. |
FileName | string | The file name, which must have an extension. Needed only for an upload by MTOM. |
ImportGuid | guid |
The guid, needed for an upload by MTOM (as is recommended). Please note: the file name, which must have an extension, is also needed for an upload by MTOM.
|
TemporaryFileHandling | TemporaryFileHandling |
Optional. How to handle the temporary files. Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.
|
Element SaveDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsoluteImportFilePath | anyURI |
The uri of the import file path. Not needed if MTOM is used.
|
AssetId | int | The asset id. |
DerivativeDefinitionId | int | The deriviative definition id. |
FileName | string | The file name, which must have an extension. Needed only for an upload by MTOM. |
ImportGuid | guid |
The guid, needed for an upload by MTOM (as is recommended). Please note: the file name, which must have an extension, is also needed for an upload by MTOM.
|
TemporaryFileHandling | TemporaryFileHandling |
Optional. How to handle the temporary files. Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.
|
The asset container description in the language defined by LanguageId.
Type string
Complex Type AssetContainerTranslation
The asset's further description (in most cases it'll be the field AssetDescription).
Type string
Complex Type PortAssetItem
Optional. The language (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..).
ApplicationLanguage? desiredAssetContainerLanguage = ApplicationLanguage.English;
Type ApplicationLanguage
Value | Description |
---|---|
German | |
English | |
French | |
InvariantLanguage_InvariantCountry | |
Afrikaans | |
Afrikaans_SouthAfrica | |
Amharic_Ethiopia | |
Arabic | |
Arabic_UAE | |
Arabic_Bahrain | |
Arabic_Algeria | |
Arabic_Egypt | |
Arabic_Iraq | |
Arabic_Jordan | |
Arabic_Kuwait | |
Arabic_Lebanon | |
Arabic_Libya | |
Arabic_Morocco | |
Mapudungun_Chile | |
Arabic_Oman | |
Arabic_Qatar | |
Arabic_Saudi_Arabia | |
Arabic_Syria | |
Arabic_Tunisia | |
Arabic_Yemen | |
Assamese_India | |
Azeri | |
Azeri_Cyrillic_Azerbaijan | |
Azeri_Latin_Azerbaijan | |
Bashkir_Russia | |
Belarusian | |
Belarusian_Belarus | |
Bulgarian | |
Bulgarian_Bulgaria | |
Bengali_Bangladesh | |
Bengali_India | |
Tibetan_PeoplesRepublicOfChina | |
Breton_France | |
Bosnian_Cyrillic_BosniaAndHerzegovina | |
Bosnian_Latin_BosniaAndHerzegovina | |
Catalan | |
Catalan_Catalan | |
Corsican_France | |
Czech | |
Czech_CzechRepublic | |
Welsh_UnitedKingdom | |
Danish | |
Danish_Denmark | |
German_Austria | |
German_Switzerland | |
German_Germany | |
German_Liechtenstein | |
German_Luxembourg | |
LowerSorbian_Germany | |
Divehi | |
Divehi_Maldives | |
Greek | |
Greek_Greece | |
English_Caribbean | |
English_Australia | |
English_Belize | |
English_Canada | |
English_UnitedKingdom | |
English_Ireland | |
English_India | |
English_Jamaica | |
English_Malaysia | |
English_NewZealand | |
English_RepublicOfThePhilippines | |
English_Singapore | |
English_TrinidadAndTobago | |
English_UnitedStates | |
English_SouthAfrica | |
English_Zimbabwe | |
Spanish | |
Spanish_Argentina | |
Spanish_Bolivia | |
Spanish_Chile | |
Spanish_Colombia | |
Spanish_CostaRica | |
Spanish_DominicanRepublic | |
Spanish_Ecuador | |
Spanish_Spain | |
Spanish_Guatemala | |
Spanish_Honduras | |
Spanish_Mexico | |
Spanish_Nicaragua | |
Spanish_Panama | |
Spanish_Peru | |
Spanish_PuertoRico | |
Spanish_Paraguay | |
Spanish_ElSalvador | |
Spanish_UnitedStates | |
Spanish_Uruguay | |
Spanish_Venezuela | |
Estonian | |
Estonian_Estonia | |
Basque | |
Basque_Basque | |
Persian | |
Persian_Iran | |
Finnish | |
Finnish_Finland | |
Filipino_Philippines | |
Faroese | |
Faroese_FaroeIslands | |
French_Belgium | |
French_Canada | |
French_Switzerland | |
French_France | |
French_Luxembourg | |
French_PrincipalityOfMonaco | |
Frisian_Netherlands | |
Irish_Ireland | |
ScottishGaelic_UnitedKingdom | |
Galician | |
Galician_Galician | |
Alsatian_France | |
Gujarati | |
Gujarati_India | |
Hausa_Latin_Nigeria | |
Hebrew | |
Hebrew_Israel | |
Hindi | |
Hindi_India | |
Croatian | |
Croatian_Latin_BosniaAndHerzegovina | |
Croatian_Croatia | |
UpperSorbian_Germany | |
Hungarian | |
Hungarian_Hungary | |
Armenian | |
Armenian_Armenia | |
Indonesian | |
Indonesian_Indonesia | |
Igbo_Nigeria | |
Yi_PeoplesRepublicOfChina | |
Icelandic | |
Icelandic_Iceland | |
Italian | |
Italian_Switzerland | |
Italian_Italy | |
Inuktitut_Syllabics_Canada | |
Inuktitut_Latin_Canada | |
Japanese | |
Japanese_Japan | |
Georgian | |
Georgian_Georgia | |
Kazakh | |
Kazakh_Kazakhstan | |
Greenlandic_Greenland | |
Khmer_Cambodia | |
Kannada | |
Kannada_India | |
Korean | |
Konkani | |
Konkani_India | |
Korean_Korea | |
Kyrgyz | |
Kyrgyz_Kyrgyzstan | |
Luxembourgish_Luxembourg | |
Lao_LaoPDR | |
Lithuanian | |
Lithuanian_Lithuania | |
Latvian | |
Latvian_Latvia | |
Maori_NewZealand | |
Macedonian | |
Macedonian_FormerYugoslavRepublicofMacedonia | |
Malayalam_India | |
Mongolian | |
Mongolian_Cyrillic_Mongolia | |
Mongolian_TraditionalMongolian_PeoplesRepublicOfChina | |
Mohawk_Canada | |
Marathi | |
Marathi_India | |
Malay | |
Malay_BruneiDarussalam | |
Malay_Malaysia | |
Maltese_Malta | |
Norwegian_Bokml_Norway | |
Nepali_Nepal | |
Dutch | |
Dutch_Belgium | |
Dutch_Netherlands | |
Norwegian_Nynorsk_Norway | |
Norwegian | |
Sesothosa_Leboa_SouthAfrica | |
Occitan_France | |
Oriya_India | |
Punjabi | |
Punjabi_India | |
Polish | |
Polish_Poland | |
Dari_Afghanistan | |
Pashto_Afghanistan | |
Portuguese | |
Portuguese_Brazil | |
Portuguese_Portugal | |
Kiche_Guatemala | |
Quechua_Bolivia | |
Quechua_Ecuador | |
Quechua_Peru | |
Romansh_Switzerland | |
Romanian | |
Romanian_Romania | |
Russian | |
Russian_Russia | |
Kinyarwanda_Rwanda | |
Sanskrit | |
Yakut_Russia | |
Sanskrit_India | |
Sami_Northern_Finland | |
Sami_Northern_Norway | |
Sami_Northern_Sweden | |
Sinhala_SriLanka | |
Slovak | |
Slovak_Slovakia | |
Slovenian | |
Slovenian_Slovenia | |
Sami_Southern_Norway | |
Sami_Southern_Sweden | |
Sami_Lule_Norway | |
Sami_Lule_Sweden | |
Sami_Inari_Finland | |
Sami_Skolt_Finland | |
Albanian | |
Albanian_Albania | |
Serbian | |
Serbian_Cyrillic_BosniaAndHerzegovina | |
Serbian_Cyrillic_SerbiaAndMontenegro_Former | |
Serbian_Cyrillic_Montenegro | |
Serbian_Cyrillic_Serbia | |
Serbian_Latin_BosniaAndHerzegovina | |
Serbian_Latin_SerbiaAndMontenegro_Former | |
Serbian_Latin_Montenegro | |
Serbian_Latin_Serbia | |
Swedish | |
Swedish_Finland | |
Swedish_Sweden | |
Kiswahili | |
Kiswahili_Kenya | |
Syriac | |
Syriac_Syria | |
Tamil | |
Tamil_India | |
Telugu | |
Telugu_India | |
Tajik_Cyrillic_Tajikistan | |
Thai | |
Thai_Thailand | |
Turkmen_Turkmenistan | |
Setswana_SouthAfrica | |
Turkish | |
Turkish_Turkey | |
Tatar | |
Tatar_Russia | |
Tamazight_Latin_Algeria | |
Uyghur_PeoplesRepublicOfChina | |
Ukrainian | |
Ukrainian_Ukraine | |
Urdu | |
Urdu_IslamicRepublicOfPakistan | |
Uzbek | |
Uzbek_Cyrillic_Uzbekistan | |
Uzbek_Latin_Uzbekistan | |
Vietnamese | |
Vietnamese_Vietnam | |
Wolof_Senegal | |
isiXhosa_SouthAfrica | |
Yoruba_Nigeria | |
Chinese_Simplified | |
Chinese_Traditional | |
Chinese_PeoplesRepublicOfChina | |
Chinese_HongKongSAR | |
Chinese_MacaoSAR | |
Chinese_Singapore | |
Chinese_Taiwan | |
isiZulu_SouthAfrica |
Element GetAssetContainers
Optional. The language of the meta data to be returned.
Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian.
DesiredMetadataLanguage = ApplicationLanguage.English
Type ApplicationLanguage
Value | Description |
---|---|
German | |
English | |
French | |
InvariantLanguage_InvariantCountry | |
Afrikaans | |
Afrikaans_SouthAfrica | |
Amharic_Ethiopia | |
Arabic | |
Arabic_UAE | |
Arabic_Bahrain | |
Arabic_Algeria | |
Arabic_Egypt | |
Arabic_Iraq | |
Arabic_Jordan | |
Arabic_Kuwait | |
Arabic_Lebanon | |
Arabic_Libya | |
Arabic_Morocco | |
Mapudungun_Chile | |
Arabic_Oman | |
Arabic_Qatar | |
Arabic_Saudi_Arabia | |
Arabic_Syria | |
Arabic_Tunisia | |
Arabic_Yemen | |
Assamese_India | |
Azeri | |
Azeri_Cyrillic_Azerbaijan | |
Azeri_Latin_Azerbaijan | |
Bashkir_Russia | |
Belarusian | |
Belarusian_Belarus | |
Bulgarian | |
Bulgarian_Bulgaria | |
Bengali_Bangladesh | |
Bengali_India | |
Tibetan_PeoplesRepublicOfChina | |
Breton_France | |
Bosnian_Cyrillic_BosniaAndHerzegovina | |
Bosnian_Latin_BosniaAndHerzegovina | |
Catalan | |
Catalan_Catalan | |
Corsican_France | |
Czech | |
Czech_CzechRepublic | |
Welsh_UnitedKingdom | |
Danish | |
Danish_Denmark | |
German_Austria | |
German_Switzerland | |
German_Germany | |
German_Liechtenstein | |
German_Luxembourg | |
LowerSorbian_Germany | |
Divehi | |
Divehi_Maldives | |
Greek | |
Greek_Greece | |
English_Caribbean | |
English_Australia | |
English_Belize | |
English_Canada | |
English_UnitedKingdom | |
English_Ireland | |
English_India | |
English_Jamaica | |
English_Malaysia | |
English_NewZealand | |
English_RepublicOfThePhilippines | |
English_Singapore | |
English_TrinidadAndTobago | |
English_UnitedStates | |
English_SouthAfrica | |
English_Zimbabwe | |
Spanish | |
Spanish_Argentina | |
Spanish_Bolivia | |
Spanish_Chile | |
Spanish_Colombia | |
Spanish_CostaRica | |
Spanish_DominicanRepublic | |
Spanish_Ecuador | |
Spanish_Spain | |
Spanish_Guatemala | |
Spanish_Honduras | |
Spanish_Mexico | |
Spanish_Nicaragua | |
Spanish_Panama | |
Spanish_Peru | |
Spanish_PuertoRico | |
Spanish_Paraguay | |
Spanish_ElSalvador | |
Spanish_UnitedStates | |
Spanish_Uruguay | |
Spanish_Venezuela | |
Estonian | |
Estonian_Estonia | |
Basque | |
Basque_Basque | |
Persian | |
Persian_Iran | |
Finnish | |
Finnish_Finland | |
Filipino_Philippines | |
Faroese | |
Faroese_FaroeIslands | |
French_Belgium | |
French_Canada | |
French_Switzerland | |
French_France | |
French_Luxembourg | |
French_PrincipalityOfMonaco | |
Frisian_Netherlands | |
Irish_Ireland | |
ScottishGaelic_UnitedKingdom | |
Galician | |
Galician_Galician | |
Alsatian_France | |
Gujarati | |
Gujarati_India | |
Hausa_Latin_Nigeria | |
Hebrew | |
Hebrew_Israel | |
Hindi | |
Hindi_India | |
Croatian | |
Croatian_Latin_BosniaAndHerzegovina | |
Croatian_Croatia | |
UpperSorbian_Germany | |
Hungarian | |
Hungarian_Hungary | |
Armenian | |
Armenian_Armenia | |
Indonesian | |
Indonesian_Indonesia | |
Igbo_Nigeria | |
Yi_PeoplesRepublicOfChina | |
Icelandic | |
Icelandic_Iceland | |
Italian | |
Italian_Switzerland | |
Italian_Italy | |
Inuktitut_Syllabics_Canada | |
Inuktitut_Latin_Canada | |
Japanese | |
Japanese_Japan | |
Georgian | |
Georgian_Georgia | |
Kazakh | |
Kazakh_Kazakhstan | |
Greenlandic_Greenland | |
Khmer_Cambodia | |
Kannada | |
Kannada_India | |
Korean | |
Konkani | |
Konkani_India | |
Korean_Korea | |
Kyrgyz | |
Kyrgyz_Kyrgyzstan | |
Luxembourgish_Luxembourg | |
Lao_LaoPDR | |
Lithuanian | |
Lithuanian_Lithuania | |
Latvian | |
Latvian_Latvia | |
Maori_NewZealand | |
Macedonian | |
Macedonian_FormerYugoslavRepublicofMacedonia | |
Malayalam_India | |
Mongolian | |
Mongolian_Cyrillic_Mongolia | |
Mongolian_TraditionalMongolian_PeoplesRepublicOfChina | |
Mohawk_Canada | |
Marathi | |
Marathi_India | |
Malay | |
Malay_BruneiDarussalam | |
Malay_Malaysia | |
Maltese_Malta | |
Norwegian_Bokml_Norway | |
Nepali_Nepal | |
Dutch | |
Dutch_Belgium | |
Dutch_Netherlands | |
Norwegian_Nynorsk_Norway | |
Norwegian | |
Sesothosa_Leboa_SouthAfrica | |
Occitan_France | |
Oriya_India | |
Punjabi | |
Punjabi_India | |
Polish | |
Polish_Poland | |
Dari_Afghanistan | |
Pashto_Afghanistan | |
Portuguese | |
Portuguese_Brazil | |
Portuguese_Portugal | |
Kiche_Guatemala | |
Quechua_Bolivia | |
Quechua_Ecuador | |
Quechua_Peru | |
Romansh_Switzerland | |
Romanian | |
Romanian_Romania | |
Russian | |
Russian_Russia | |
Kinyarwanda_Rwanda | |
Sanskrit | |
Yakut_Russia | |
Sanskrit_India | |
Sami_Northern_Finland | |
Sami_Northern_Norway | |
Sami_Northern_Sweden | |
Sinhala_SriLanka | |
Slovak | |
Slovak_Slovakia | |
Slovenian | |
Slovenian_Slovenia | |
Sami_Southern_Norway | |
Sami_Southern_Sweden | |
Sami_Lule_Norway | |
Sami_Lule_Sweden | |
Sami_Inari_Finland | |
Sami_Skolt_Finland | |
Albanian | |
Albanian_Albania | |
Serbian | |
Serbian_Cyrillic_BosniaAndHerzegovina | |
Serbian_Cyrillic_SerbiaAndMontenegro_Former | |
Serbian_Cyrillic_Montenegro | |
Serbian_Cyrillic_Serbia | |
Serbian_Latin_BosniaAndHerzegovina | |
Serbian_Latin_SerbiaAndMontenegro_Former | |
Serbian_Latin_Montenegro | |
Serbian_Latin_Serbia | |
Swedish | |
Swedish_Finland | |
Swedish_Sweden | |
Kiswahili | |
Kiswahili_Kenya | |
Syriac | |
Syriac_Syria | |
Tamil | |
Tamil_India | |
Telugu | |
Telugu_India | |
Tajik_Cyrillic_Tajikistan | |
Thai | |
Thai_Thailand | |
Turkmen_Turkmenistan | |
Setswana_SouthAfrica | |
Turkish | |
Turkish_Turkey | |
Tatar | |
Tatar_Russia | |
Tamazight_Latin_Algeria | |
Uyghur_PeoplesRepublicOfChina | |
Ukrainian | |
Ukrainian_Ukraine | |
Urdu | |
Urdu_IslamicRepublicOfPakistan | |
Uzbek | |
Uzbek_Cyrillic_Uzbekistan | |
Uzbek_Latin_Uzbekistan | |
Vietnamese | |
Vietnamese_Vietnam | |
Wolof_Senegal | |
isiXhosa_SouthAfrica | |
Yoruba_Nigeria | |
Chinese_Simplified | |
Chinese_Traditional | |
Chinese_PeoplesRepublicOfChina | |
Chinese_HongKongSAR | |
Chinese_MacaoSAR | |
Chinese_Singapore | |
Chinese_Taiwan | |
isiZulu_SouthAfrica |
Complex Type AssetFilter
Complex Type ExtendedAssetFilter
The id of the new parent asset container.
Type int
Element MoveAssetContainer
Flag: return distinct values only.
Type boolean
Element GetSubscriptionInfo
Type Document
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DocumentId | int | |
DocumentPages | ArrayOfDocumentPage | |
LargePageImageMaxHeight | int | |
LargePageImageMaxWidth | int | |
SmallPageImageMaxHeight | int | |
SmallPageImageMaxWidth | int | |
ts | base64Binary | |
Complex Type ArrayOfDocument
Type Document
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DocumentId | int | |
DocumentPages | ArrayOfDocumentPage | |
LargePageImageMaxHeight | int | |
LargePageImageMaxWidth | int | |
SmallPageImageMaxHeight | int | |
SmallPageImageMaxWidth | int | |
ts | base64Binary | |
Type DocumentPage
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetObjects | ArrayOfAssetObject | |
DocumentId | int | |
DocumentPageId | int | |
HeightInCm | double | |
LargePageImageResolution | double | |
LargePageImageUrl | string | |
PageNumber | int | |
RotationInDegrees | int | |
SmallPageImageResolution | double | |
SmallPageImageUrl | string | |
WidthInCm | double | |
ts | base64Binary | |
Complex Type ArrayOfDocumentPage
Type DocumentPage
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetObjects | ArrayOfAssetObject | |
DocumentId | int | |
DocumentPageId | int | |
HeightInCm | double | |
LargePageImageResolution | double | |
LargePageImageUrl | string | |
PageNumber | int | |
RotationInDegrees | int | |
SmallPageImageResolution | double | |
SmallPageImageUrl | string | |
WidthInCm | double | |
ts | base64Binary | |
Type ArrayOfDocumentPage
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DocumentPage | DocumentPage | |
Complex Type Document
An array with all assigned Documents.
Type ArrayOfDocument
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Document | Document | |
Complex Type AssetMetadata
Type double
Type Download
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsolutePath | string | |
AvailableUntilDate | DateTimeOffset | |
DownloadFileName | string | |
DownloadToken | string | |
FileSize | long | |
URL | string | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetSelection | ArrayOfAssetSelection | A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds. |
downloadOptions | DownloadOptions | Defines the download options. |
An array of PortDerivatives for this asset.
A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PortDerivative | PortDerivative | A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
Complex Type PortAssetItem
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetSelection | ArrayOfAssetSelection | A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds. |
downloadOptions | DownloadOptions | Defines the download options. |
createSingleDownload4MultipleFiles | boolean |
If true, a zipfile which contains all files is created on the server for download. You get ONE link to this zip file. Otherwise you get one Link for each derivative. |
provideUniqueFileName | boolean |
If true, the system provides for a (pseudo) unique name for each derivative. Depending on the download configuration of a particular Picturepark, each derivative normally has a unique name. If this is the case, the provideUniqueFileName-parameter is ignored. But if for some reason identically named derivatives are downloaded as discrete files one by one, they would be overwritten by their namesakes. In this case, if provideUniqueFileName is true, the system will append the derivative definition short name, e.g. "Internet" in order to create a (pseudo) unique file name. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DownloadExtendedResult | ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK | |
Type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK | anyType (restriction) | |
Element DownloadExtendedResponse
Defines the download options.
Type DownloadOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessId | int |
A mailing id. Valid only in combination with a valid MailingToken. Needed for access rights, does not cause the download to return all assets in a mailing. |
BusinessProcessToken | string | Token for a business process, must be given in combination with a BusinessProcessId. |
CreateZip4SingleFile | boolean | If false and the download contains only one file, then the file is not zipped. |
KeepOriginalFileName | boolean | If false the original filename is taken and the configured download filename rules are ignored. |
MailingRecipientId | int | Needed only for logging purposes. |
UsagePurpose | string | Any text, needed only for logging purposes. |
UserAction | UserAction | Needed for logging purposes. Must be one of DerivativeDownload, DerivativeView or AssetReplication. |
Element Download
Defines the download options.
Type DownloadOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessId | int |
A mailing id. Valid only in combination with a valid MailingToken. Needed for access rights, does not cause the download to return all assets in a mailing. |
BusinessProcessToken | string | Token for a business process, must be given in combination with a BusinessProcessId. |
CreateZip4SingleFile | boolean | If false and the download contains only one file, then the file is not zipped. |
KeepOriginalFileName | boolean | If false the original filename is taken and the configured download filename rules are ignored. |
MailingRecipientId | int | Needed only for logging purposes. |
UsagePurpose | string | Any text, needed only for logging purposes. |
UserAction | UserAction | Needed for logging purposes. Must be one of DerivativeDownload, DerivativeView or AssetReplication. |
Element DownloadExtended
Type DownloadOptions
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessId | int |
A mailing id. Valid only in combination with a valid MailingToken. Needed for access rights, does not cause the download to return all assets in a mailing. |
BusinessProcessToken | string | Token for a business process, must be given in combination with a BusinessProcessId. |
CreateZip4SingleFile | boolean | If false and the download contains only one file, then the file is not zipped. |
KeepOriginalFileName | boolean | If false the original filename is taken and the configured download filename rules are ignored. |
MailingRecipientId | int | Needed only for logging purposes. |
UsagePurpose | string | Any text, needed only for logging purposes. |
UserAction | UserAction | Needed for logging purposes. Must be one of DerivativeDownload, DerivativeView or AssetReplication. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DownloadResult | Download | |
Type Download
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsolutePath | string | |
AvailableUntilDate | DateTimeOffset | |
DownloadFileName | string | |
DownloadToken | string | |
FileSize | long | |
URL | string | |
Element DownloadResponse
Type duration
Value must match the following pattern: \-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?
The value must be greater than or equal to -P10675199DT2H48M5.4775808S.
The value must be less than or equal to P10675199DT2H48M5.4775807S.
Type duration
Value must match the following pattern: \-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?
The value must be greater than or equal to -P10675199DT2H48M5.4775808S.
The value must be less than or equal to P10675199DT2H48M5.4775807S.
Complex Type MediaInfo
Type ArrayOfFacetConfigurationElement
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationElement | FacetConfigurationElement | |
Complex Type FacetConfigurationJson
The email address of the (PAS) user, who will later log in from the publisher with the security token
Type string
Element GetSecurityToken
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DateTimeEqualOperation
Type ArrayOffloat
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
float | float | |
Complex Type NumericListEqualOperation
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Complex Type StringListEqualOperation
A list of sub containers to be excluded (if IncludeSubAssetContainers is true )
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element SaveAssetContainerRights
The id of an exclusivity group.
An exclusivity group is a list of mutually exclusive categories, e.g. countries or sex.
In the case of countries an exclusivity group would prevent an asset to be assigned to more than one countries, in the case of sex it could be assigned to either male or female, but not to both.
Type int
Complex Type AssetContainerItem
The expiry date.
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Element CreateAssetLink
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type BusinessProcessShort
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserData
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserShort
The extendedAssetFilter allows the definition of many additional parameters.
Type ExtendedAssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
AssetContainerSearchOperation | AssetContainerLogicalOperation |
Optional. Define from which asset containers to get assets. See the general API docu overview for further examples! // EXAMPLE: Get assets from asset container id 123 plus all sub-containers: |
AssetTypeIds | ArrayOfint |
Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images. Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized. Default: all AssetTypeIds = new List<int> {2, 6, 20} |
Limit | int | Optional. The maximal number of assets returned. Default is unlimited. |
MediaTypeIds | ArrayOfint |
Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies. Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia". Default: all MediaTypeIds = new List<int> {1,4,3} |
ReturnMediaTypeCounts | boolean |
Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned. For performance reasons, this paramter should be set to false if not needed. Default: false |
SearchDesiredMetadataLanguageOnly | boolean | Optional. If true, a search is done only within language specific metadata. Default: false. |
SearchOnlyDeletedAssets | boolean | Optional. |
SearchOperation | LogicalOperation |
Optional. Define search parameters for a complex search. See the general API docu overview for further examples! See ComparisonOperation for available operators. // EXAMPLE: Get asset with AssetId 111: |
SimpleSearchString | string |
Optional. Use simple search, if you wish to search within all fields for a simple string.
|
SortInfos | ArrayOfSortInfo |
Sort parameters: the asset field and the direction (ascending or descending). This is the only required parameter! You may define several sort infos, e.g. AssetName asc, AssetId desc. List<SortInfo> sortInfos = new List<SortInfo>(); |
StartRow | int | Optional. The row in the query, from where on to return the assets. Default is 0. |
UnassignedAssetsOnly | boolean | Optional. If true, only assets which are in no category are returned. Default: false. |
VersionTypeIds | ArrayOfint |
Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions). This is not a filter for the assets, thus has no impact on the number of assets returned by the query. VersionTypeIds = new List<int> { 1, 3 } |
Element GetAssets
Type ExtendedAssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
AssetContainerSearchOperation | AssetContainerLogicalOperation |
Optional. Define from which asset containers to get assets. See the general API docu overview for further examples! // EXAMPLE: Get assets from asset container id 123 plus all sub-containers: |
AssetTypeIds | ArrayOfint |
Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images. Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized. Default: all AssetTypeIds = new List<int> {2, 6, 20} |
Limit | int | Optional. The maximal number of assets returned. Default is unlimited. |
MediaTypeIds | ArrayOfint |
Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies. Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia". Default: all MediaTypeIds = new List<int> {1,4,3} |
ReturnMediaTypeCounts | boolean |
Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned. For performance reasons, this paramter should be set to false if not needed. Default: false |
SearchDesiredMetadataLanguageOnly | boolean | Optional. If true, a search is done only within language specific metadata. Default: false. |
SearchOnlyDeletedAssets | boolean | Optional. |
SearchOperation | LogicalOperation |
Optional. Define search parameters for a complex search. See the general API docu overview for further examples! See ComparisonOperation for available operators. // EXAMPLE: Get asset with AssetId 111: |
SimpleSearchString | string |
Optional. Use simple search, if you wish to search within all fields for a simple string.
|
SortInfos | ArrayOfSortInfo |
Sort parameters: the asset field and the direction (ascending or descending). This is the only required parameter! You may define several sort infos, e.g. AssetName asc, AssetId desc. List<SortInfo> sortInfos = new List<SortInfo>(); |
StartRow | int | Optional. The row in the query, from where on to return the assets. Default is 0. |
UnassignedAssetsOnly | boolean | Optional. If true, only assets which are in no category are returned. Default: false. |
VersionTypeIds | ArrayOfint |
Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions). This is not a filter for the assets, thus has no impact on the number of assets returned by the query. VersionTypeIds = new List<int> { 1, 3 } |
Type ExtendedDerivative
Contains elements as defined in the following table.
Complex Type ArrayOfExtendedDerivative
Type ExtendedDerivative
Contains elements as defined in the following table.
Type FacetConfigurationElement
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
IsInitiallyOpen | boolean | |
Ranges | ArrayOfFacetConfigurationRange | |
SelectionBehavior | FacetInnerSelectionBehavior | |
SortOrder | int | |
Complex Type ArrayOfFacetConfigurationElement
Type FacetConfigurationElement
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
IsInitiallyOpen | boolean | |
Ranges | ArrayOfFacetConfigurationRange | |
SelectionBehavior | FacetInnerSelectionBehavior | |
SortOrder | int | |
Type FacetConfigurationExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BaseAssetContainerId | int | |
FacetConfigurationId | int | |
FacetConfigurationJson | FacetConfigurationJson | |
HideBackendLink | boolean | |
IsDefault | boolean | |
ListViewFieldGroupId | int | |
LogoutUrl | string | |
Name | string | |
NewFlagDays | int | |
OverlayFieldId | int | |
OverviewFieldGroupId | int | |
OverviewUiElementId | int | |
OverviewUrl | string | |
ShareListViewFieldGroupId | int | |
ShareOverviewFieldGroupId | int | |
Skin | Skin | |
SkinId | int | |
SuggestionSourceId | SuggestionSource | |
TermsAndConditions | string | |
Title | string | |
FieldIds | ArrayOfint | |
InitialAssetFilter | ExtendedAssetFilter | The assetFilter is a set of parameters, that define which assets are returned from GetAssets |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | Used in UI set to user language4content's caption |
FieldIds | ArrayOfint | |
IsInitiallyOpen | boolean | |
SortOrder | int | |
Translations | ArrayOfFacetConfigurationTranslation | Used for configuration (read / save) |
Complex Type ArrayOfFacetConfigurationGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | Used in UI set to user language4content's caption |
FieldIds | ArrayOfint | |
IsInitiallyOpen | boolean | |
SortOrder | int | |
Translations | ArrayOfFacetConfigurationTranslation | Used for configuration (read / save) |
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Elements | ArrayOfFacetConfigurationElement | |
Groups | ArrayOfFacetConfigurationGroup | |
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Elements | ArrayOfFacetConfigurationElement | |
Groups | ArrayOfFacetConfigurationGroup | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | Used in UI set to user language4content's caption |
DateRange | FacetDateRange | |
FromNumeric | float | |
Name | string | |
SortOrder | int | |
ToNumeric | float | |
Translations | ArrayOfFacetConfigurationTranslation | Used for configuration (read / save) |
Complex Type ArrayOfFacetConfigurationRange
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | Used in UI set to user language4content's caption |
DateRange | FacetDateRange | |
FromNumeric | float | |
Name | string | |
SortOrder | int | |
ToNumeric | float | |
Translations | ArrayOfFacetConfigurationTranslation | Used for configuration (read / save) |
Type FacetConfigurationTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
LanguageId | int | |
Complex Type ArrayOfFacetConfigurationTranslation
Type FacetConfigurationTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
LanguageId | int | |
Type FacetConfigurationViewItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BaseAssetContainerId | int | |
FacetConfigurationId | int | |
FacetConfigurationJson | FacetConfigurationJson | |
HideBackendLink | boolean | |
IsDefault | boolean | |
ListViewFieldGroupId | int | |
LogoutUrl | string | |
Name | string | |
NewFlagDays | int | |
OverlayFieldId | int | |
OverviewFieldGroupId | int | |
OverviewUiElementId | int | |
OverviewUrl | string | |
ShareListViewFieldGroupId | int | |
ShareOverviewFieldGroupId | int | |
Skin | Skin | |
SkinId | int | |
SuggestionSourceId | SuggestionSource | |
TermsAndConditions | string | |
Title | string | |
Type FacetDateRange
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
From | string | |
To | string | |
Type FacetResult
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
FieldId | int | Serves as identifier for the UI |
Group | ArrayOfFacetResult | |
IsInitiallyOpen | boolean | |
IsOpen | boolean | |
RemainingHits | int | |
RemainingTerms | ArrayOfstring | |
RemainingTermsCount | int | |
SelectionBehavior | FacetInnerSelectionBehavior | |
SortOrder | int | |
Values | ArrayOfFacetValue | |
Complex Type ArrayOfFacetResult
Type FacetResult
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
FieldId | int | Serves as identifier for the UI |
Group | ArrayOfFacetResult | |
IsInitiallyOpen | boolean | |
IsOpen | boolean | |
RemainingHits | int | |
RemainingTerms | ArrayOfstring | |
RemainingTermsCount | int | |
SelectionBehavior | FacetInnerSelectionBehavior | |
SortOrder | int | |
Values | ArrayOfFacetValue | |
Type FacetResults
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ProvidedSearchFilter | ExtendedAssetFilter | Holds the asset filter that has been provided for searching |
Results | ArrayOfFacetResult | A result per field (facet) |
Type FacetSearchParameter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CaptionsOfUncollapsedFacetGroups | ArrayOfstring | The captions of the facet groups that are not collapsed (open). These are necessary to tell the UI which ones to open so that the user has the same state after fetching data. |
FacetConfigurationId | int | |
FieldIdsOfFacets | ArrayOfint | This is used when facets have already (a) filter(s) applied and therefore it's not possible to use the FieldIds from the facet configuration |
FieldIdsOfUncollapsedFacets | ArrayOfint | The FieldIds of the facets that are not collapsed (open). These are necessary to tell the UI which ones to open so that the user has the same state after fetching data. |
SearchFilter | ExtendedAssetFilter | The assetFilter is a set of parameters, that define which assets are returned from GetAssets |
Complex Type ArrayOfFacetSearchParameter
Type FacetSearchParameter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CaptionsOfUncollapsedFacetGroups | ArrayOfstring | The captions of the facet groups that are not collapsed (open). These are necessary to tell the UI which ones to open so that the user has the same state after fetching data. |
FacetConfigurationId | int | |
FieldIdsOfFacets | ArrayOfint | This is used when facets have already (a) filter(s) applied and therefore it's not possible to use the FieldIds from the facet configuration |
FieldIdsOfUncollapsedFacets | ArrayOfint | The FieldIds of the facets that are not collapsed (open). These are necessary to tell the UI which ones to open so that the user has the same state after fetching data. |
SearchFilter | ExtendedAssetFilter | The assetFilter is a set of parameters, that define which assets are returned from GetAssets |
Type FacetValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
Average | double | |
ComparisonOperation | ComparisonOperation | |
ComparisonOperationType | ComparisonOperationType | |
Count | int | |
FieldId | int | |
FieldName | string | |
Hits | int | |
IsSelected | boolean | |
Max | double | |
Min | double | |
Range | string | |
RangeConfiguration | FacetConfigurationRange | |
SortOrder | int | |
Sum | double | |
Complex Type ArrayOfFacetValue
Type FacetValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
Average | double | |
ComparisonOperation | ComparisonOperation | |
ComparisonOperationType | ComparisonOperationType | |
Count | int | |
FieldId | int | |
FieldName | string | |
Hits | int | |
IsSelected | boolean | |
Max | double | |
Min | double | |
Range | string | |
RangeConfiguration | FacetConfigurationRange | |
SortOrder | int | |
Sum | double | |
Type Field
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Analyzed | boolean | Defines if the field gets analyzed by RavenDB |
AssetContainerType | AssetContainerType |
The asset container type, either Category or AssetClass. This property is needed for asset classes. |
AssetTypeIds | ArrayOfint | An array with the ids of asset types assigned to this field. Currently not used. |
BaseAssetContainerId | int | Needed for control type TagBox and defines root of the tagbox. |
Boost | float | Defines the boost factor for Fulltext search |
ControlType | ControlType | ComboBox, DateField, Checkbox .. |
DataType | DataType | Integer32, String, Date, Boolean .. |
DefaultGridColumnWidth | int | The default field column width for the asset browser grid view. |
FieldControlInfos | FieldControlInfos | Control Infos. |
FieldId | int | The id of the field. |
FieldLookupEntity | FieldLookupEntity | The name of the table to which the field belongs: FieldValues, Assets, Derivatives .. |
FieldLookupEntityId | int | The id of the FieldLookupEntity (see there). |
FieldOptionsLookupEntity | FieldOptionsLookupEntity |
The name of the table to which the field option belongs: Countries, Users .. Is null, if the options are not stored in one of these tables. |
FieldOptionsLookupEntityId | int | The id of the FieldOptionsLookupEntityId (see there). |
FieldType | FieldType | AssetField, UserField or AssetContainerField. |
IncludeInAssetIndexFullTexts | boolean | If true, this field is searched in case of a full text search. |
IncludeInCustomDBIndex | boolean | If true, this field is searched in case of a full text index. |
IsLanguageSpecific | boolean | Language specific fields like AssetName and AssetDescription may have different values depending on the language. |
IsReadOnly | boolean | A read only field can be updated only by the system, not by a user. |
IsRequired | boolean | If true, this field cannot be empty or null. |
IsSystemField | boolean | A system field like Sha1Hash or Fulltext is needed for programming purposes and not visible for a user. |
MetadataMapping | ArrayOfMetadataProperty |
List of xmp mappings, shows which Picturepark fields are mapped to which metadata fields in the image file. This allows for the mappings to be displayed in the UI, e.g. in the upload mask. |
Name | string | The field name, e.g. AssetName, AssetDescription, FileSizeInBytes, CDF8 .. |
Options | ArrayOfFieldOption |
An array with all available options for this field. Needed for ComboBox- and MultiCheckbox fields). |
ReplaceDelimiters | boolean | If true, field value will be splitted and formated by its special characters. The results will be added to the full text search index. |
Translation | FieldTranslation |
The field data in the language of the current user. Translation.Caption contains the field name in this language. |
Translations | ArrayOfFieldTranslation | Currently not used. |
ValidationRegEx | string | A regular expression used to check the input data, e.g. to enforce the input of an email address in a correct format. |
ts | base64Binary | Time stamp. |
Complex Type ArrayOfField
Type Field
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Analyzed | boolean | Defines if the field gets analyzed by RavenDB |
AssetContainerType | AssetContainerType |
The asset container type, either Category or AssetClass. This property is needed for asset classes. |
AssetTypeIds | ArrayOfint | An array with the ids of asset types assigned to this field. Currently not used. |
BaseAssetContainerId | int | Needed for control type TagBox and defines root of the tagbox. |
Boost | float | Defines the boost factor for Fulltext search |
ControlType | ControlType | ComboBox, DateField, Checkbox .. |
DataType | DataType | Integer32, String, Date, Boolean .. |
DefaultGridColumnWidth | int | The default field column width for the asset browser grid view. |
FieldControlInfos | FieldControlInfos | Control Infos. |
FieldId | int | The id of the field. |
FieldLookupEntity | FieldLookupEntity | The name of the table to which the field belongs: FieldValues, Assets, Derivatives .. |
FieldLookupEntityId | int | The id of the FieldLookupEntity (see there). |
FieldOptionsLookupEntity | FieldOptionsLookupEntity |
The name of the table to which the field option belongs: Countries, Users .. Is null, if the options are not stored in one of these tables. |
FieldOptionsLookupEntityId | int | The id of the FieldOptionsLookupEntityId (see there). |
FieldType | FieldType | AssetField, UserField or AssetContainerField. |
IncludeInAssetIndexFullTexts | boolean | If true, this field is searched in case of a full text search. |
IncludeInCustomDBIndex | boolean | If true, this field is searched in case of a full text index. |
IsLanguageSpecific | boolean | Language specific fields like AssetName and AssetDescription may have different values depending on the language. |
IsReadOnly | boolean | A read only field can be updated only by the system, not by a user. |
IsRequired | boolean | If true, this field cannot be empty or null. |
IsSystemField | boolean | A system field like Sha1Hash or Fulltext is needed for programming purposes and not visible for a user. |
MetadataMapping | ArrayOfMetadataProperty |
List of xmp mappings, shows which Picturepark fields are mapped to which metadata fields in the image file. This allows for the mappings to be displayed in the UI, e.g. in the upload mask. |
Name | string | The field name, e.g. AssetName, AssetDescription, FileSizeInBytes, CDF8 .. |
Options | ArrayOfFieldOption |
An array with all available options for this field. Needed for ComboBox- and MultiCheckbox fields). |
ReplaceDelimiters | boolean | If true, field value will be splitted and formated by its special characters. The results will be added to the full text search index. |
Translation | FieldTranslation |
The field data in the language of the current user. Translation.Caption contains the field name in this language. |
Translations | ArrayOfFieldTranslation | Currently not used. |
ValidationRegEx | string | A regular expression used to check the input data, e.g. to enforce the input of an email address in a correct format. |
ts | base64Binary | Time stamp. |
The id of the field control info.
Type int
Complex Type FieldControlInfos
Control Infos.
Type FieldControlInfos
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldControlInfoId | int | The id of the field control info. |
FieldId | int | The id of the field. |
MaxTextLength | int | Max count of chars. |
TagBoxShowFullPath | boolean | Should the TagBox show the full path or only the Tag (AssetContainerName). |
TotalTextAreaRows | int | The numbers of rows of a textarea. |
ts | base64Binary | Time stamp. |
Complex Type Field
Type FieldControlInfos
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldControlInfoId | int | The id of the field control info. |
FieldId | int | The id of the field. |
MaxTextLength | int | Max count of chars. |
TagBoxShowFullPath | boolean | Should the TagBox show the full path or only the Tag (AssetContainerName). |
TotalTextAreaRows | int | The numbers of rows of a textarea. |
ts | base64Binary | Time stamp. |
Type int
Complex Type AssetContainerAssignment
Complex Type AssetContainerAssignmentExtended
Serves as identifier for the UI
Type int
Complex Type FacetResult
Type int
Complex Type KnownFieldValue
Complex Type KnownFieldValueAssetContainerAssignment
Complex Type KnownFieldValueBoolean
Complex Type KnownFieldValueDateTime
Complex Type KnownFieldValueDouble
Complex Type KnownFieldValueInteger32
Complex Type KnownFieldValueInteger64
Complex Type KnownFieldValueString
Complex Type KnownFieldValueUserShort
A list of field ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element GetAssetsMetadata
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type FacetConfigurationExtended
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type FacetConfigurationGroup
This is used when facets have already (a) filter(s) applied and therefore it's not possible to use the FieldIds from the facet configuration
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type FacetSearchParameter
The FieldIds of the facets that are not collapsed (open). These are necessary to tell the UI which ones to open so that the user has the same state after fetching data.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type FacetSearchParameter
The name of the table to which the field belongs: FieldValues, Assets, Derivatives ..
Type FieldLookupEntity
Value | Description |
---|---|
FieldValues | |
Assets | |
Derivatives | |
Users | |
Orders | |
ClientOnly | |
Assets2AssetContainers | |
VideoStreams | |
AudioStreams |
Complex Type Field
Type FieldLookupEntity
Value | Description |
---|---|
FieldValues | |
Assets | |
Derivatives | |
Users | |
Orders | |
ClientOnly | |
Assets2AssetContainers | |
VideoStreams | |
AudioStreams |
The id of the FieldLookupEntity (see there).
Type int
Complex Type Field
The field name (case sensitive!).
Type string
Element GetFieldSetIdByFieldName
Type string
Complex Type AssetContainerExcludeFieldOperation
Complex Type AssetContainerIncludeFieldOperation
Complex Type ComparisonOperation
Complex Type DateTimeAfterOperation
Complex Type DateTimeBeforeOperation
Complex Type DateTimeBetweenOperation
Complex Type DateTimeEqualOperation
Complex Type DateTimeNowAfterOperation
Complex Type DateTimeNowAfterOrEqualOperation
Complex Type DateTimeNowBeforeOrEqualOperation
Complex Type DateTimeNowLastOperation
Complex Type DateTimeNowNextOperation
Complex Type DateTimeNowOlderOperation
Complex Type NumericBetweenOperation
Complex Type NumericEqualOperation
Complex Type NumericLargerThanOperation
Complex Type NumericListEqualOperation
Complex Type NumericNotEqualOperation
Complex Type NumericSmallerThanOperation
Complex Type StringContainsOperation
Complex Type StringEmptyOperation
Complex Type StringEqualOperation
Complex Type StringListContainsExactOperation
Complex Type StringListContainsOperation
Complex Type StringListEqualOperation
Complex Type StringNotContainsOperation
Complex Type StringNotEmptyOperation
Complex Type StringNotEqualOperation
Complex Type StringStartsWithOperation
Type FieldOption
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
SortOrder | int | |
Translations | ArrayOfFieldOptionTranslation | |
ValueString | string | |
ts | base64Binary | |
Complex Type ArrayOfFieldOption
Type FieldOption
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
SortOrder | int | |
Translations | ArrayOfFieldOptionTranslation | |
ValueString | string | |
ts | base64Binary | |
Type int
Complex Type KnownFieldValue
Complex Type KnownFieldValueAssetContainerAssignment
Complex Type KnownFieldValueBoolean
Complex Type KnownFieldValueDateTime
Complex Type KnownFieldValueDouble
Complex Type KnownFieldValueInteger32
Complex Type KnownFieldValueInteger64
Complex Type KnownFieldValueString
Complex Type KnownFieldValueUserShort
The name of the table to which the field option belongs: Countries, Users ..
Is null, if the options are not stored in one of these tables.
Value | Description |
---|---|
Languages4UserInterfaces | |
Countries | |
Users | |
AssetRightTemplates | |
DerivativeRightTemplates | |
Sites |
Complex Type Field
Value | Description |
---|---|
Languages4UserInterfaces | |
Countries | |
Users | |
AssetRightTemplates | |
DerivativeRightTemplates | |
Sites |
The id of the FieldOptionsLookupEntityId (see there).
Type int
Complex Type Field
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOptionId | int | |
FieldOptionTranslationId | int | |
LanguageId | int | |
ValueString | string | |
ts | base64Binary | |
Complex Type ArrayOfFieldOptionTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOptionId | int | |
FieldOptionTranslationId | int | |
LanguageId | int | |
ValueString | string | |
ts | base64Binary | |
Type FieldRight
Value | Description |
---|---|
ViewFieldValues | |
EditFieldValues | |
EditFieldOptions |
Complex Type ArrayOfFieldRight
Type FieldRight
Value | Description |
---|---|
ViewFieldValues | |
EditFieldValues | |
EditFieldOptions |
Type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfFieldRightuUS27HWe | anyType (restriction) | |
Complex Type Rights
The field set ID to apply the new default value to. It can be obtained by calling GetFieldSetIdByFieldName
Type int
Element UpdateFieldSetDefaultValue
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type AssetContainerAssignmentExtended
A list of assigned field set ids.
FieldSetIds define which fields are assigned to an asset container. Needed for AssetClasses.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type AssetContainerItem
The fieldSetIds for this asset.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type AssetFieldValues
A list of assigned field set ids.
FieldSetIds define which fields are assigned to an asset. Needed for AssetClasses.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type AssetItem
Type FieldTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalText | string | |
Caption | string | |
FieldId | int | |
FieldTranslationId | int | |
LanguageId | int | |
ToolTip | string | |
ts | base64Binary | |
Complex Type ArrayOfFieldTranslation
Type FieldTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalText | string | |
Caption | string | |
FieldId | int | |
FieldTranslationId | int | |
LanguageId | int | |
ToolTip | string | |
ts | base64Binary | |
AssetField, UserField or AssetContainerField.
Type FieldType
Value | Description |
---|---|
AssetField | |
UserField | |
AssetContainerField |
Complex Type Field
Type FieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
FieldId | int | |
FieldOptionId | int | |
FieldValueId | int | |
LanguageId | int | |
Source | FieldValueSource | |
UserId | int | |
ValueAssetContainerAssignment | AssetContainerAssignmentExtended | |
ValueAssetContainerId | int | |
ValueBoolean | boolean | |
ValueDate | DateTimeOffset | |
ValueDateTime | DateTimeOffset | |
ValueDouble | double | |
ValueInteger32 | int | |
ValueInteger64 | long | |
ValueString | string | |
ValueUserShort | UserShort | |
ts | base64Binary | |
Complex Type ArrayOfFieldValue
Type FieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
FieldId | int | |
FieldOptionId | int | |
FieldValueId | int | |
LanguageId | int | |
Source | FieldValueSource | |
UserId | int | |
ValueAssetContainerAssignment | AssetContainerAssignmentExtended | |
ValueAssetContainerId | int | |
ValueBoolean | boolean | |
ValueDate | DateTimeOffset | |
ValueDateTime | DateTimeOffset | |
ValueDouble | double | |
ValueInteger32 | int | |
ValueInteger64 | long | |
ValueString | string | |
ValueUserShort | UserShort | |
ts | base64Binary | |
A list of FieldValues.
Type ArrayOfFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Element UpdateAssetMetadata
Array of field values for this asset.
Type ArrayOfFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Complex Type AssetFieldValues
List of field values.
Which field values are required - and must therefore be submitted - depends on the configuration of this Picturepark.
Please note: categories are defined as a special field value of type ValueAssetContainerAssignment (see code example).
List<FieldValue> fieldValues = new List<FieldValue>
{
. new FieldValue {FieldId = 2, ValueString = "Nebel", LanguageId = 1 },
. new FieldValue {FieldId = 2, ValueString = "Fog", LanguageId = 2 },
. new FieldValue {FieldId = 2, ValueString = "Brume", LanguageId = 3 },
. new FieldValue {FieldId = 6, FieldOptionId = 289},
. new FieldValue {FieldId = 3, ValueString = "Carl Meyers" },
. new FieldValue {FieldId = 35, ValueUserShort = new UserShort {UserId = CoreInfo.User.UserId}},
};
.
// Example for the assignment of three categories (111,222,333) to the field 99, which is of type AssetContainerAssignmentExtended:
.
AssetContainerAssignmentExtended category1 = new AssetContainerAssignmentExtended() { AssetContainerId = 111, AssetContainerType = AssetContainerType.Category};
AssetContainerAssignmentExtended category2 = new AssetContainerAssignmentExtended() { AssetContainerId = 222, AssetContainerType = AssetContainerType.Category};
AssetContainerAssignmentExtended category3 = new AssetContainerAssignmentExtended() { AssetContainerId = 333, AssetContainerType = AssetContainerType.Category};
.
List<FieldValue> fieldValues = new List<FieldValue>
{
. ..
. new FieldValue {FieldId = 99, ValueAssetContainerAssignment = category1},
. new FieldValue {FieldId = 99, ValueAssetContainerAssignment = category2},
. new FieldValue {FieldId = 99, ValueAssetContainerAssignment = category3},
. ..
};
Type ArrayOfFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Complex Type AssetImportOptions
Array of KnownFieldValues.
This array contains one entry for each field value.
For which fields the values are returned depends on the parameters AdditionalSelectFields in ExtendedAssetFilter.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KnownFieldValue | KnownFieldValue | |
Complex Type AssetItem
An array with all FieldValues for this asset.
Type ArrayOfFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Complex Type AssetMetadata
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KnownFieldValue | KnownFieldValue | |
Complex Type DerivativeLock
Type ArrayOfFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Complex Type UserData
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KnownFieldValue | KnownFieldValue | |
Complex Type UserShort
A list of field values to be deleted.
Type ArrayOfFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldValue | FieldValue | |
Element UpdateAssetMetadata
Type FieldValueSource
Value | Description |
---|---|
FieldValues | |
Assets | |
Derivatives | |
VideoStreams | |
AudioStreams | |
AssetClass | |
XmpMetadata |
The file name with extension, needed only for an upload by MTOM.
Type string
Complex Type AssetImportOptions
The file name, which must have an extension. Needed only for an upload by MTOM.
Type string
Complex Type AssetUpdateOptions
E.g. "Matterhorn1.jpg".
Type string
Complex Type Derivative
Complex Type ExtendedDerivative
The file name, which must have an extension. Needed only for an upload by MTOM.
Type string
Complex Type DerivativeUpdateOptions
Type float
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The id of the asset container. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetContainerRightsResult | ArrayOfUserGroupAssetContainerRights | |
Type ArrayOfUserGroupAssetContainerRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetContainerRights | UserGroupAssetContainerRights | |
Element GetAssetContainerRightsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
parentAssetContainerId | int | The id of the AssetContainer (category or asset class) for which the children are to be returned. |
assetContainerType | AssetContainerType |
Optional. Either Category or AssetClass. AssetContainerType? assetContainerType = AssetContainerType.AssetClass; |
openAssetContainerId | int |
Optional. This parameter is needed in order to display the opened part of a category branch. You define a parent id (a) and an openedAssetContainerId (aaaa) below the parent and you will get the nodes on the line of descendants (a, aa, aaa, aaaa) plus all siblings of these nodes: a (Parent) aa bb cc dd ee (Child aa plus siblings bb, cc ..) aaa bbb (Child aaa of aa plus siblings bbb ..) aaaa bbbb cccc (Child aaaa of aaa plus siblings bbbb, cccc..) |
totalLayers | int | Number of layers (children, grand-children ..) to be returned. 1 = only the parentAssetContainerId is returned, 0 = all. |
searchString | string |
Optional. If not empty, only asset containers with matching names and/or descriptions are returned. Please note: there is always the complete line of parent nodes returned down to the matching nodes. |
desiredAssetContainerLanguage | ApplicationLanguage |
Optional. The language (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..). ApplicationLanguage? desiredAssetContainerLanguage = ApplicationLanguage.English; |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetContainersResult | ArrayOfAssetContainerItem | |
Type ArrayOfAssetContainerItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerItem | AssetContainerItem | An AssetContainerItem represents the attributes of one asset container including relations to other asset containers. |
Element GetAssetContainersResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetFieldsResult | ArrayOfField | |
Type ArrayOfField
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Field | Field | Defines the attributes of a Field (Asset-, User- or AssetContainerField) |
Element GetAssetFieldsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
businessProcessIds | ArrayOfint | A list of businessprocess ids. |
startRow | int | Start row. |
limit | int | Number of maximally returned itens. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetLinksByIdResult | ArrayOfBusinessProcessShort | |
Type ArrayOfBusinessProcessShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessShort | BusinessProcessShort | |
Element GetAssetLinksByIdResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetRightsResult | ArrayOfUserGroupAssetRights | |
Type ArrayOfUserGroupAssetRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetRights | UserGroupAssetRights | |
Element GetAssetRightsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
extendedAssetFilter | ExtendedAssetFilter | The extendedAssetFilter allows the definition of many additional parameters. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetFilter | ExtendedAssetFilter | An asset filter. |
portName | string | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssets2Result | PortAssetItemCollection | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Assets | ArrayOfPortAssetItem | An array of AssetItem. |
TotalAssets | int |
The number of assets in the query. Please note: this figure is not necessarily identical with the number of AssetItems. Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter. |
Element GetAssets2Response
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | The int array of asset ids to be returned. |
assetFilter | AssetFilter | The assetFilter allows the definition of some additional parameters. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetsByIdsResult | AssetItemCollection | |
Type AssetItemCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AllQueryAssetIds | ArrayOfint |
A list of all asset ids in the query. This list is only returned if the param ReturnAllQueryAssetIds in the AssetFilter is true. These asset ids are not necessarily identical with the assets items in the Assets property, e.g. due to the Limit parameter. |
Assets | ArrayOfAssetItem | An array of AssetItem. |
MediaTypeCounts | ArrayOfint |
The number of assets per media type in the order of MediaTypeId. E.g. 111,22,33. 111 assets belong to the first media type (e.g. "all"), 22 to the second and 33 to the third etc. Please note: as with TotalAssets, these figures refer to the whole query, not just to the assets returned. |
TotalAssets | int |
The number of assets in the query. Please note: this figure is not necessarily identical with the number of AssetItems. Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter. |
Element GetAssetsByIdsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | A list of asset ids. |
fieldIds | ArrayOfint | A list of field ids. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetsMetadataResult | ArrayOfAssetFieldValues | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetFieldValues | AssetFieldValues | |
Element GetAssetsMetadataResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetsResult | AssetItemCollection | |
Type AssetItemCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AllQueryAssetIds | ArrayOfint |
A list of all asset ids in the query. This list is only returned if the param ReturnAllQueryAssetIds in the AssetFilter is true. These asset ids are not necessarily identical with the assets items in the Assets property, e.g. due to the Limit parameter. |
Assets | ArrayOfAssetItem | An array of AssetItem. |
MediaTypeCounts | ArrayOfint |
The number of assets per media type in the order of MediaTypeId. E.g. 111,22,33. 111 assets belong to the first media type (e.g. "all"), 22 to the second and 33 to the third etc. Please note: as with TotalAssets, these figures refer to the whole query, not just to the assets returned. |
TotalAssets | int |
The number of assets in the query. Please note: this figure is not necessarily identical with the number of AssetItems. Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter. |
Element GetAssetsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
assetFilter | AssetFilter | An asset filter, may be empty. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetAssetVersionsResult | ArrayOfAssetVersion | |
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Element GetAssetVersionsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetConfigurationModificationDateResult | DateTimeOffset | |
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetConfigurationResult | PublicConfiguration | |
Type PublicConfiguration
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Countries | ArrayOfCountry | |
DerivativeDefinitions | ArrayOfDerivativeDefinition | |
PictureparkVersion | Version | |
Element GetConfigurationResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
customerId | int | The customer id. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetContentLanguagesResult | ArrayOfLanguage4Content | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Content | Language4Content | |
Element GetContentLanguagesResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetDerivativeRightsResult | ArrayOfUserDerivativeRights | |
Type ArrayOfUserDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserDerivativeRights | UserDerivativeRights | |
Element GetDerivativeRightsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetSelection | ArrayOfAssetSelection | A list of AssetSelections. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetDerivativesResult | ArrayOfExtendedDerivative | |
Type ArrayOfExtendedDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ExtendedDerivative | ExtendedDerivative | An extended derivative provides more detailed information than the usual derivative. |
Element GetDerivativesResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
name | string | The facet name. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetFacetConfigurationExtendedResult | FacetConfigurationExtended | |
Type FacetConfigurationExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BaseAssetContainerId | int | |
FacetConfigurationId | int | |
FacetConfigurationJson | FacetConfigurationJson | |
HideBackendLink | boolean | |
IsDefault | boolean | |
ListViewFieldGroupId | int | |
LogoutUrl | string | |
Name | string | |
NewFlagDays | int | |
OverlayFieldId | int | |
OverviewFieldGroupId | int | |
OverviewUiElementId | int | |
OverviewUrl | string | |
ShareListViewFieldGroupId | int | |
ShareOverviewFieldGroupId | int | |
Skin | Skin | |
SkinId | int | |
SuggestionSourceId | SuggestionSource | |
TermsAndConditions | string | |
Title | string | |
FieldIds | ArrayOfint | |
InitialAssetFilter | ExtendedAssetFilter | The assetFilter is a set of parameters, that define which assets are returned from GetAssets |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
searchParameters | ArrayOfFacetSearchParameter | A list of FacetSearchParameter. |
selectedFacetValues | ArrayOfFacetValue | A list of FacetValue, can be null. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetFacetsResult | FacetResults | |
Type FacetResults
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ProvidedSearchFilter | ExtendedAssetFilter | Holds the asset filter that has been provided for searching |
Results | ArrayOfFacetResult | A result per field (facet) |
Element GetFacetsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The asset container ID. |
fieldName | string | The field name (case sensitive!). |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetFieldSetIdByFieldNameResult | int | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetLanguageConfigurationResult | LanguageConfiguration | |
Contains elements as defined in the following table.
Element GetLanguageConfigurationResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id. |
updateStatistic | boolean | If true, the action is recorded in the statistics table. |
businessProcessId | int | Optional. Not needed by integrators. |
businessProcessToken | string | Optional. Not needed by integrators. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetMetadataResult | AssetMetadata | Represents the metadata of an asset. |
Type AssetMetadata
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the assigned right template. |
AppliedDerivativeRightTemplateId | int | The id of the right template used to define the access rights for the derivative formats. |
AssetContainerAssignments | ArrayOfAssetContainerAssignmentExtended |
An array with all AssetContainerAssignmentExtendeds for this asset. An asset can be assigned to many asset containers. |
AssetRights | ArrayOfAssetRight | array with all AssetRights for the current user. |
AssetTypeId | AssetType | Bitmap, VectorGraphic, TextDocument, Audio, Video .. |
AssetVersions | ArrayOfAssetVersion |
An array with all AssetVersions for this asset. This array contains all asset versions which have this asset as a parent. |
DerivativeLock | DerivativeLock | DerivativeLock. If not null this asset is locked. |
Derivatives | ArrayOfExtendedDerivative |
An array with all assigned ExtendedDerivatives to which access rights exist. Please note: the data for the original are returned independently of access rights in the property OriginalDerivative. |
Documents | ArrayOfDocument | An array with all assigned Documents. |
FieldValues | ArrayOfFieldValue | An array with all FieldValues for this asset. |
IsAssetRightTemplateOverridden | boolean | If true, there are more specific access rights defined for this asset and the settings of the AppliedAssetRightTemplateId are ignored. |
IsDerivativeRightTemplateOverridden | boolean | Same logic as with IsAssetRightTemplateOverridden. |
MasterVersions | ArrayOfAssetVersion |
An array with all master AssetVersions for this asset. This array contains all assets which are a parent version for this asset. |
MediaInfos | ArrayOfMediaInfo | A list of MediaInfos if the asset is an audio or a video. |
OriginalDerivative | ExtendedDerivative |
Original ExtendedDerivative. The data for the original are always returned, even if there are no access rights to the original. |
ParentAsset | ArrayOfAssetItem |
An array with all parent AssetItems. An asset can have more than one parent. |
ParentAssetId | int | The id of the parent asset. |
ReferencedAssets | ArrayOfAssetItem | An array with all AssetItems to which this asset refers (from Documents). |
ReferringAssets | ArrayOfAssetItem | An array with all AssetItems which refer to this asset (from AssetObjects). |
XmpItems | ArrayOfXmpItem | An array with XmpItems if the asset is an image and metadata mapping is enabled. |
Element GetMetadataResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetRightsResult | Rights | |
Type Rights
Contains elements as defined in the following table.
Element GetRightsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
customerId | int | The id of the customer (picturepark), e.g. 27. |
clientGuid | string | The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server. |
authenticationUser | string | The email address of the user, who serves to authenticate the connection. |
authenticationUserPassword | string | The password of that user. |
emailAddress | string | The email address of the (PAS) user, who will later log in from the publisher with the security token |
userData | UserData | UserData for the user, who will later log in with the security token. Needed only if the PAS user does not yet exist, because in this case a new user account will be created for the PAS user. |
traceJobId | int |
Only submit this parameter if the method call is part of a trace job. The traces within a trace job are pooled for special reporting capabilities." To get a traceJobId, you must call the webservice CreateTraceJob, which is only available in the extended public webservices. Needed for tracing purposes only. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetSecurityTokenResult | string | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
subscriptionActionId | int | The id of the subscription action. |
distinct | boolean | Flag: return distinct values only. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetSubscriptionInfoResult | UserActionHistoryInfoCollection | |
Type UserActionHistoryInfoCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BatchGuid | string | |
TotalUserActionHistoryInfos | int | |
UserActionHistoryInfos | ArrayOfUserActionHistoryInfo | |
Element GetSubscriptionInfoResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
assetContainerIds | ArrayOfint | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetTotalAssetsResult | ArrayOfAssetContainerTotalAssets | |
Type ArrayOfAssetContainerTotalAssets
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTotalAssets | AssetContainerTotalAssets | |
Element GetTotalAssetsResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
userId | int | The id of the user. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetUserByIdResult | UserData | |
Type UserData
Contains elements as defined in the following table.
Element GetUserByIdResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
start | int | Optional. The row in the query, from where on to return the users. Default is 0. |
limit | int | Optional. The maximal number of rows returned. Default is unlimited. |
searchString | string | Optional. A search string, e.g. "berg". Leave empty, if you wish to get all users. |
userGroupId | int | Optional. The id of a user group, if you wish to get only users from a certain group. |
registrationState | RegistrationState | Optional. The RegistrationState, if you wish to get only users with a certain regristration state. |
renewalState | RenewalState | Optional. The RenewalState, if you wish to get only users with a certain renewal state. |
sortField | string | Optional. A sortfield, e.g. "EmailAddress". |
sortDirection | SortDirection | Optional. The SortDirection (ascending or descending), default is ascending. |
additionalUserRightsCheck | UserRight | Optional. Get only users with this UserRight. |
additionalUserGroupRightsCheck | UserGroupRight | Optional. Get only users in groups to which the current user has a certain UserGroupRight. |
onlyLocked | boolean | Get only locked users. |
onlyExpired | boolean | Get only expired users. |
onlyExpiredRenewals | boolean | Get only users with expired renewals. |
onlyActive | boolean | Get only active users. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
GetUsersResult | UserCollection | |
Type UserCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
TotalUsers | int | TotalUsers is the number of rows in the query. If a limit is defined this figure may be higher than the number of records returned by the query. |
Users | ArrayOfUserShort | An array of UserShort. |
Element GetUsersResponse
Session specific User data.
Type User
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DisplayName | string | First name plus last name |
string | ||
Language | ApplicationLanguage | The gui language for this user, which is stored in the user profile, e.g. "English". |
Language4ContentId | int |
The id of a content language. Language4Content is not a language, but a set of languages for specific purposes. Different languages can be assigned for content, metadata, asset containers and fulltext indexing. |
LoginStatus | LoginStatus | LoggedIn, NotLoggedIn or LoggedInAsGuest. |
Password | string | The password must be submitted for Login, but is never returned. |
Skin | SkinColor | Available options:Gray=0, Blue=1, White=2. |
UserGroups | ArrayOfint | Array of the ids of the assigned user groups. |
UserId | int | |
Complex Type CoreInfo
Type ArrayOfFacetResult
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetResult | FacetResult | |
Complex Type FacetResult
Type ArrayOfFacetConfigurationGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationGroup | FacetConfigurationGroup | |
Complex Type FacetConfigurationJson
Type guid
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Type boolean
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Optional. Same logic as HistoricVersionName.
Type string
Complex Type AssetUpdateOptions
Optional. Same logic as HistoricVersionName4Master.
Type string
Complex Type AssetUpdateOptions
Optional. The name of the newly created historic version (if param CreateHistoricVersion = true).
Type string
Complex Type AssetUpdateOptions
Optional. The historic version name of the newly uploaded asset (if param CreateHistoricVersion = true).
Type string
Complex Type AssetUpdateOptions
Optional. These informations, which are needed for logging purposes, must be gathered and submitted only by the web ui.
In all other cases null should be submitted.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UrlEntryPoint | string | E.g. "https//customer.picturepark.com/Website/default.aspx". |
UrlReferrer | string | E.g. "http://start-picturepark.vit.local/development/" |
UserAgent | string | E.g. "Mozilla/5.0 (Windows NT 6.1; rv:2.0) Gecko/20100101 Firefox/4.0". |
UserHostAddress | string | The ip address of the user host. |
UserHostName | string | The DNS name of the user host. |
Element CreateSession
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UrlEntryPoint | string | E.g. "https//customer.picturepark.com/Website/default.aspx". |
UrlReferrer | string | E.g. "http://start-picturepark.vit.local/development/" |
UserAgent | string | E.g. "Mozilla/5.0 (Windows NT 6.1; rv:2.0) Gecko/20100101 Firefox/4.0". |
UserHostAddress | string | The ip address of the user host. |
UserHostName | string | The DNS name of the user host. |
The id of the icon used for the display of the asset container.
Type int
Complex Type AssetContainerItem
Type Impersonation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ImpersonatedEmailAddress | string | |
ImpersonationId | int | |
Complex Type UserData
Type Impersonation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ImpersonatedEmailAddress | string | |
ImpersonationId | int | |
Needed only for an upload by MTOM.
Guid? guid = null;
.
using (FileStream fileStream = new FileStream(@"E:\Kaktus.jpg", FileMode.Open))
. guid = PictureparkServiceMtom.UploadFile(fileStream);
.
ImportGuid = guid,
Type guid
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Complex Type AssetImportOptions
The guid, needed for an upload by MTOM (as is recommended).
Please note: the file name, which must have an extension, is also needed for an upload by MTOM.
string fileName = "Kaktus.jpg"; // must have an extension!
Guid? guid = null;
.
using (FileStream fileStream = new FileStream(@"E:\Kaktus.jpg", FileMode.Open))
. guid = PictureparkServiceMtom.UploadFile(fileStream);
.
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
. ..
. FileName = fileName,
. ImportGuid = guid,
. ..
};
Type guid
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Complex Type AssetUpdateOptions
The guid, needed for an upload by MTOM (as is recommended).
Please note: the file name, which must have an extension, is also needed for an upload by MTOM.
string fileName = "Kaktus.jpg"; // must have an extension!
Guid? guid = null;
.
using (FileStream fileStream = new FileStream(@"E:\Kaktus.jpg", FileMode.Open))
. guid = PictureparkServiceMtom.UploadFile(fileStream);
.
AssetUpdateOptions assetUpdateOptions = new AssetUpdateOptions()
{
. FileName = fileName,
. ImportGuid = guid,
};
Type guid
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Complex Type DerivativeUpdateOptions
Needed only for batch import, which is not available for public webservices.
Type string
Complex Type AssetImportOptions
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
renderingJobId | int |
The rendering job id. Each import must be assigned to a rendering job. Call CreateRenderingJob first to get a renderingJobId. This allows several imports to be pooled to one job. |
assetImportOptions | AssetImportOptions |
A complex datatype for import options. If you wish to upload by streaming (recommended), you must provide the properties ImportGuid and FileName. See under UploadFile how to proceed. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ImportSingleAssetResult | int | |
The url of the file to be imported, not needed for upload by MTOM.
For an upload by MTOM (recommended) the ImportGuid is needed instead.
ImportUrl = "http://picturepark.com/images/image1234.jpg"
Type string
Complex Type AssetImportOptions
If true, this field is searched in case of a full text search.
Type boolean
Complex Type Field
If true, this field is searched in case of a full text index.
Type boolean
Complex Type Field
Include upper boundarie's value in result. Lucene syntax only!
Type boolean
Complex Type NumericBetweenOperation
Include upper boundarie's value in result. Lucene syntax only!
Type boolean
Complex Type NumericSmallerThanOperation
Include lower boundarie's value in result. Lucene syntax only!
Type boolean
Complex Type NumericBetweenOperation
Include lower boundarie's value in result. Lucene syntax only!
Type boolean
Complex Type NumericLargerThanOperation
Type boolean
Complex Type AssetContainerComparisonOperation
Complex Type AssetContainerExcludeOperation
Complex Type AssetContainerIncludeOperation
Type ArrayOfAssetContainerIndex
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerIndex | AssetContainerIndex | |
Complex Type AssetContainerAssignmentExtended
An array with the indexes for each asset container language (contains the language specific absolute paths, e.g. "animals\pets\dogs\")
Type ArrayOfAssetContainerIndex
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerIndex | AssetContainerIndex | |
Complex Type AssetContainerItem
Type ExtendedAssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
AssetContainerSearchOperation | AssetContainerLogicalOperation |
Optional. Define from which asset containers to get assets. See the general API docu overview for further examples! // EXAMPLE: Get assets from asset container id 123 plus all sub-containers: |
AssetTypeIds | ArrayOfint |
Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images. Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized. Default: all AssetTypeIds = new List<int> {2, 6, 20} |
Limit | int | Optional. The maximal number of assets returned. Default is unlimited. |
MediaTypeIds | ArrayOfint |
Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies. Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia". Default: all MediaTypeIds = new List<int> {1,4,3} |
ReturnMediaTypeCounts | boolean |
Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned. For performance reasons, this paramter should be set to false if not needed. Default: false |
SearchDesiredMetadataLanguageOnly | boolean | Optional. If true, a search is done only within language specific metadata. Default: false. |
SearchOnlyDeletedAssets | boolean | Optional. |
SearchOperation | LogicalOperation |
Optional. Define search parameters for a complex search. See the general API docu overview for further examples! See ComparisonOperation for available operators. // EXAMPLE: Get asset with AssetId 111: |
SimpleSearchString | string |
Optional. Use simple search, if you wish to search within all fields for a simple string.
|
SortInfos | ArrayOfSortInfo |
Sort parameters: the asset field and the direction (ascending or descending). This is the only required parameter! You may define several sort infos, e.g. AssetName asc, AssetId desc. List<SortInfo> sortInfos = new List<SortInfo>(); |
StartRow | int | Optional. The row in the query, from where on to return the assets. Default is 0. |
UnassignedAssetsOnly | boolean | Optional. If true, only assets which are in no category are returned. Default: false. |
VersionTypeIds | ArrayOfint |
Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions). This is not a filter for the assets, thus has no impact on the number of assets returned by the query. VersionTypeIds = new List<int> { 1, 3 } |
Complex Type FacetConfigurationExtended
The id of the sibling container before which the source shall be inserted.
Set to 0 if you wish to insert the moved container at the last position.
Type int
Element MoveAssetContainer
Type int
If true, the right template is not used and the individual right assignments are applied instead.
If false, user groups in UserGroupAssetRights are ignored and can be set to null.
Type boolean
Element SaveAssetsRights
Optional. If true, the assigned AssetRightTemplateId is ignored and rights specifically assigned to this asset are applied. Default is false.
If true, UserGroupAssetRights must be provided.
Type boolean
Complex Type AssetImportOptions
If true, the applied asset right template is ignored and the rights particularly assigned to this asset are applied.
Type boolean
Complex Type AssetItem
If true, there are more specific access rights defined for this asset and the settings of the AppliedAssetRightTemplateId are ignored.
Type boolean
Complex Type AssetMetadata
Type boolean
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
If true, the right template is not used and the individual right assignments are applied instead.
If false, user groups in UserGroupDerivativeRights are ignored and can be set to null.
Type boolean
Element SaveDerivativeRights
Optional. If true, the assigned DerivativeRightTemplateId is ignored and rights specifically assigned to this derivative are applied. Default is false.
Type boolean
Complex Type AssetImportOptions
If true, the applied derivative right template is ignored and the rights particularly assigned to the derivatives are applied.
Type boolean
Complex Type AssetItem
Same logic as with IsAssetRightTemplateOverridden.
Type boolean
Complex Type AssetMetadata
Language specific fields like AssetName and AssetDescription may have different values depending on the language.
Type boolean
Complex Type Field
A read only field can be updated only by the system, not by a user.
Type boolean
Complex Type Field
If true, this field cannot be empty or null.
Type boolean
Complex Type Field
If true, the right template is not used.
Type boolean
Element SaveAssetContainerRights
If true, the applied right template is ignored and the rights particularly assigned to this asset container are applied.
Type boolean
Complex Type AssetContainerItem
A system field like Sha1Hash or Fulltext is needed for programming purposes and not visible for a user.
Type boolean
Complex Type Field
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
IsValidResult | boolean | |
If true, the new file inherits the asset id of the old.
Type boolean
Complex Type AssetUpdateOptions
If false the original filename is taken and the configured download filename rules are ignored.
Type boolean
Complex Type DownloadOptions
Type DerivativeDefinition
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioBitrate | int | |
AudioQuality | int | |
AudioSamplingFrequency | int | |
AudioUse4Preview | boolean | |
AvPresetId | guid | |
DerivativeDefinition2AssetTypes | ArrayOfDerivativeDefinition2AssetType | |
DerivativeDefinitionId | int | |
DerivativeType | DerivativeType | |
Group | int | |
IconId | int | |
ImageColorProfileId | int | |
ImageColorTransformationIntentId | int | |
ImageEncodingOptionId | int | |
ImageKeepClippingPath | boolean | |
ImageResolution | int | |
Name | string | |
OutputFileExtensionId | int | |
ProvideAsDownload | boolean | |
RelativeBasePath | string | |
RenderingActionValues | ArrayOfRenderingActionValue | |
SortOrder | int | |
TrackUsagePurpose | boolean | |
Translations | ArrayOfDerivativeDefinitionTranslation | |
Use4AssetConversion | boolean | |
UseGuid4FileName | boolean | |
UsePublicFileDirectory | boolean | |
UseVideo4Thumbnails | boolean | |
VideoAudioBitrate | int | |
VideoAudioCodecId | int | |
VideoBitrate | int | |
VideoCodecId | int | |
WriteXmp2File | boolean | |
ts | base64Binary | |
Type Download
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AbsolutePath | string | |
AvailableUntilDate | DateTimeOffset | |
DownloadFileName | string | |
DownloadToken | string | |
FileSize | long | |
URL | string | |
Type int
Type int
Type int
Type int
Type int
Type int
Type int
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | DerivativeDefinition | |
Value | ArrayOfDerivativeRight | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | Download | |
Value | ArrayOfAssetSelection | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | int | |
Value | ArrayOfDerivativeDefinitionRight | |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | int | |
Value | ArrayOfFieldRight | |
Complex Type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | int | |
Value | ArrayOfPersonalItemRight | |
Complex Type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | int | |
Value | ArrayOfSiteRight | |
Complex Type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | int | |
Value | ArrayOfUserGroupRight | |
Complex Type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | int | |
Value | ArrayOfWidgetRight | |
Complex Type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Key | int | |
Value | PortViewField | |
Complex Type ArrayOfKeyValueOfintPortViewField6jg_STziK
Type KnownFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Complex Type ArrayOfKnownFieldValue
Type KnownFieldValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Type KnownFieldValueAssetContainerAssignment
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | AssetContainerAssignmentExtended | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | boolean | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | DateTimeOffset | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | double | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | int | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | long | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
LanguageId | int | |
Value | string | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldId | int | |
FieldOptionId | int | |
StringValue | string | |
Value | UserShort | |
The ui language, e.g. "English" or "Norwegian".
This value is written to the session log and never used again for any other purposes. Neither is it returned in coreInfo.
After a user logs in, the language for this user is taken from the language defined for this user in the database.
Type ApplicationLanguage
Value | Description |
---|---|
German | |
English | |
French | |
InvariantLanguage_InvariantCountry | |
Afrikaans | |
Afrikaans_SouthAfrica | |
Amharic_Ethiopia | |
Arabic | |
Arabic_UAE | |
Arabic_Bahrain | |
Arabic_Algeria | |
Arabic_Egypt | |
Arabic_Iraq | |
Arabic_Jordan | |
Arabic_Kuwait | |
Arabic_Lebanon | |
Arabic_Libya | |
Arabic_Morocco | |
Mapudungun_Chile | |
Arabic_Oman | |
Arabic_Qatar | |
Arabic_Saudi_Arabia | |
Arabic_Syria | |
Arabic_Tunisia | |
Arabic_Yemen | |
Assamese_India | |
Azeri | |
Azeri_Cyrillic_Azerbaijan | |
Azeri_Latin_Azerbaijan | |
Bashkir_Russia | |
Belarusian | |
Belarusian_Belarus | |
Bulgarian | |
Bulgarian_Bulgaria | |
Bengali_Bangladesh | |
Bengali_India | |
Tibetan_PeoplesRepublicOfChina | |
Breton_France | |
Bosnian_Cyrillic_BosniaAndHerzegovina | |
Bosnian_Latin_BosniaAndHerzegovina | |
Catalan | |
Catalan_Catalan | |
Corsican_France | |
Czech | |
Czech_CzechRepublic | |
Welsh_UnitedKingdom | |
Danish | |
Danish_Denmark | |
German_Austria | |
German_Switzerland | |
German_Germany | |
German_Liechtenstein | |
German_Luxembourg | |
LowerSorbian_Germany | |
Divehi | |
Divehi_Maldives | |
Greek | |
Greek_Greece | |
English_Caribbean | |
English_Australia | |
English_Belize | |
English_Canada | |
English_UnitedKingdom | |
English_Ireland | |
English_India | |
English_Jamaica | |
English_Malaysia | |
English_NewZealand | |
English_RepublicOfThePhilippines | |
English_Singapore | |
English_TrinidadAndTobago | |
English_UnitedStates | |
English_SouthAfrica | |
English_Zimbabwe | |
Spanish | |
Spanish_Argentina | |
Spanish_Bolivia | |
Spanish_Chile | |
Spanish_Colombia | |
Spanish_CostaRica | |
Spanish_DominicanRepublic | |
Spanish_Ecuador | |
Spanish_Spain | |
Spanish_Guatemala | |
Spanish_Honduras | |
Spanish_Mexico | |
Spanish_Nicaragua | |
Spanish_Panama | |
Spanish_Peru | |
Spanish_PuertoRico | |
Spanish_Paraguay | |
Spanish_ElSalvador | |
Spanish_UnitedStates | |
Spanish_Uruguay | |
Spanish_Venezuela | |
Estonian | |
Estonian_Estonia | |
Basque | |
Basque_Basque | |
Persian | |
Persian_Iran | |
Finnish | |
Finnish_Finland | |
Filipino_Philippines | |
Faroese | |
Faroese_FaroeIslands | |
French_Belgium | |
French_Canada | |
French_Switzerland | |
French_France | |
French_Luxembourg | |
French_PrincipalityOfMonaco | |
Frisian_Netherlands | |
Irish_Ireland | |
ScottishGaelic_UnitedKingdom | |
Galician | |
Galician_Galician | |
Alsatian_France | |
Gujarati | |
Gujarati_India | |
Hausa_Latin_Nigeria | |
Hebrew | |
Hebrew_Israel | |
Hindi | |
Hindi_India | |
Croatian | |
Croatian_Latin_BosniaAndHerzegovina | |
Croatian_Croatia | |
UpperSorbian_Germany | |
Hungarian | |
Hungarian_Hungary | |
Armenian | |
Armenian_Armenia | |
Indonesian | |
Indonesian_Indonesia | |
Igbo_Nigeria | |
Yi_PeoplesRepublicOfChina | |
Icelandic | |
Icelandic_Iceland | |
Italian | |
Italian_Switzerland | |
Italian_Italy | |
Inuktitut_Syllabics_Canada | |
Inuktitut_Latin_Canada | |
Japanese | |
Japanese_Japan | |
Georgian | |
Georgian_Georgia | |
Kazakh | |
Kazakh_Kazakhstan | |
Greenlandic_Greenland | |
Khmer_Cambodia | |
Kannada | |
Kannada_India | |
Korean | |
Konkani | |
Konkani_India | |
Korean_Korea | |
Kyrgyz | |
Kyrgyz_Kyrgyzstan | |
Luxembourgish_Luxembourg | |
Lao_LaoPDR | |
Lithuanian | |
Lithuanian_Lithuania | |
Latvian | |
Latvian_Latvia | |
Maori_NewZealand | |
Macedonian | |
Macedonian_FormerYugoslavRepublicofMacedonia | |
Malayalam_India | |
Mongolian | |
Mongolian_Cyrillic_Mongolia | |
Mongolian_TraditionalMongolian_PeoplesRepublicOfChina | |
Mohawk_Canada | |
Marathi | |
Marathi_India | |
Malay | |
Malay_BruneiDarussalam | |
Malay_Malaysia | |
Maltese_Malta | |
Norwegian_Bokml_Norway | |
Nepali_Nepal | |
Dutch | |
Dutch_Belgium | |
Dutch_Netherlands | |
Norwegian_Nynorsk_Norway | |
Norwegian | |
Sesothosa_Leboa_SouthAfrica | |
Occitan_France | |
Oriya_India | |
Punjabi | |
Punjabi_India | |
Polish | |
Polish_Poland | |
Dari_Afghanistan | |
Pashto_Afghanistan | |
Portuguese | |
Portuguese_Brazil | |
Portuguese_Portugal | |
Kiche_Guatemala | |
Quechua_Bolivia | |
Quechua_Ecuador | |
Quechua_Peru | |
Romansh_Switzerland | |
Romanian | |
Romanian_Romania | |
Russian | |
Russian_Russia | |
Kinyarwanda_Rwanda | |
Sanskrit | |
Yakut_Russia | |
Sanskrit_India | |
Sami_Northern_Finland | |
Sami_Northern_Norway | |
Sami_Northern_Sweden | |
Sinhala_SriLanka | |
Slovak | |
Slovak_Slovakia | |
Slovenian | |
Slovenian_Slovenia | |
Sami_Southern_Norway | |
Sami_Southern_Sweden | |
Sami_Lule_Norway | |
Sami_Lule_Sweden | |
Sami_Inari_Finland | |
Sami_Skolt_Finland | |
Albanian | |
Albanian_Albania | |
Serbian | |
Serbian_Cyrillic_BosniaAndHerzegovina | |
Serbian_Cyrillic_SerbiaAndMontenegro_Former | |
Serbian_Cyrillic_Montenegro | |
Serbian_Cyrillic_Serbia | |
Serbian_Latin_BosniaAndHerzegovina | |
Serbian_Latin_SerbiaAndMontenegro_Former | |
Serbian_Latin_Montenegro | |
Serbian_Latin_Serbia | |
Swedish | |
Swedish_Finland | |
Swedish_Sweden | |
Kiswahili | |
Kiswahili_Kenya | |
Syriac | |
Syriac_Syria | |
Tamil | |
Tamil_India | |
Telugu | |
Telugu_India | |
Tajik_Cyrillic_Tajikistan | |
Thai | |
Thai_Thailand | |
Turkmen_Turkmenistan | |
Setswana_SouthAfrica | |
Turkish | |
Turkish_Turkey | |
Tatar | |
Tatar_Russia | |
Tamazight_Latin_Algeria | |
Uyghur_PeoplesRepublicOfChina | |
Ukrainian | |
Ukrainian_Ukraine | |
Urdu | |
Urdu_IslamicRepublicOfPakistan | |
Uzbek | |
Uzbek_Cyrillic_Uzbekistan | |
Uzbek_Latin_Uzbekistan | |
Vietnamese | |
Vietnamese_Vietnam | |
Wolof_Senegal | |
isiXhosa_SouthAfrica | |
Yoruba_Nigeria | |
Chinese_Simplified | |
Chinese_Traditional | |
Chinese_PeoplesRepublicOfChina | |
Chinese_HongKongSAR | |
Chinese_MacaoSAR | |
Chinese_Singapore | |
Chinese_Taiwan | |
isiZulu_SouthAfrica |
Element CreateSession
Type Language
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Abbreviation | string | |
AbbreviationISO6392 | string | |
Available4UserInterface | boolean | |
CatalogLanguageSqlName | string | |
EnglishName | string | |
IetfLanguageTag | string | |
IsNeutralCulture | boolean | |
LanguageId | int | |
LanguageTranslation | string | |
ts | base64Binary | |
Complex Type Language4AssetContainer
Type Language
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Abbreviation | string | |
AbbreviationISO6392 | string | |
Available4UserInterface | boolean | |
CatalogLanguageSqlName | string | |
EnglishName | string | |
IetfLanguageTag | string | |
IsNeutralCulture | boolean | |
LanguageId | int | |
LanguageTranslation | string | |
ts | base64Binary | |
Complex Type Language4Content
Type Language
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Abbreviation | string | |
AbbreviationISO6392 | string | |
Available4UserInterface | boolean | |
CatalogLanguageSqlName | string | |
EnglishName | string | |
IetfLanguageTag | string | |
IsNeutralCulture | boolean | |
LanguageId | int | |
LanguageTranslation | string | |
ts | base64Binary | |
Complex Type Language4FullTextIndex
Type Language
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Abbreviation | string | |
AbbreviationISO6392 | string | |
Available4UserInterface | boolean | |
CatalogLanguageSqlName | string | |
EnglishName | string | |
IetfLanguageTag | string | |
IsNeutralCulture | boolean | |
LanguageId | int | |
LanguageTranslation | string | |
ts | base64Binary | |
Complex Type Language4Metadata
Type Language
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Abbreviation | string | |
AbbreviationISO6392 | string | |
Available4UserInterface | boolean | |
CatalogLanguageSqlName | string | |
EnglishName | string | |
IetfLanguageTag | string | |
IsNeutralCulture | boolean | |
LanguageId | int | |
LanguageTranslation | string | |
ts | base64Binary | |
Complex Type Language4UserInterface
Type Language
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Abbreviation | string | |
AbbreviationISO6392 | string | |
Available4UserInterface | boolean | |
CatalogLanguageSqlName | string | |
EnglishName | string | |
IetfLanguageTag | string | |
IsNeutralCulture | boolean | |
LanguageId | int | |
LanguageTranslation | string | |
ts | base64Binary | |
Complex Type Language4Version
Type ApplicationLanguage
Value | Description |
---|---|
German | |
English | |
French | |
InvariantLanguage_InvariantCountry | |
Afrikaans | |
Afrikaans_SouthAfrica | |
Amharic_Ethiopia | |
Arabic | |
Arabic_UAE | |
Arabic_Bahrain | |
Arabic_Algeria | |
Arabic_Egypt | |
Arabic_Iraq | |
Arabic_Jordan | |
Arabic_Kuwait | |
Arabic_Lebanon | |
Arabic_Libya | |
Arabic_Morocco | |
Mapudungun_Chile | |
Arabic_Oman | |
Arabic_Qatar | |
Arabic_Saudi_Arabia | |
Arabic_Syria | |
Arabic_Tunisia | |
Arabic_Yemen | |
Assamese_India | |
Azeri | |
Azeri_Cyrillic_Azerbaijan | |
Azeri_Latin_Azerbaijan | |
Bashkir_Russia | |
Belarusian | |
Belarusian_Belarus | |
Bulgarian | |
Bulgarian_Bulgaria | |
Bengali_Bangladesh | |
Bengali_India | |
Tibetan_PeoplesRepublicOfChina | |
Breton_France | |
Bosnian_Cyrillic_BosniaAndHerzegovina | |
Bosnian_Latin_BosniaAndHerzegovina | |
Catalan | |
Catalan_Catalan | |
Corsican_France | |
Czech | |
Czech_CzechRepublic | |
Welsh_UnitedKingdom | |
Danish | |
Danish_Denmark | |
German_Austria | |
German_Switzerland | |
German_Germany | |
German_Liechtenstein | |
German_Luxembourg | |
LowerSorbian_Germany | |
Divehi | |
Divehi_Maldives | |
Greek | |
Greek_Greece | |
English_Caribbean | |
English_Australia | |
English_Belize | |
English_Canada | |
English_UnitedKingdom | |
English_Ireland | |
English_India | |
English_Jamaica | |
English_Malaysia | |
English_NewZealand | |
English_RepublicOfThePhilippines | |
English_Singapore | |
English_TrinidadAndTobago | |
English_UnitedStates | |
English_SouthAfrica | |
English_Zimbabwe | |
Spanish | |
Spanish_Argentina | |
Spanish_Bolivia | |
Spanish_Chile | |
Spanish_Colombia | |
Spanish_CostaRica | |
Spanish_DominicanRepublic | |
Spanish_Ecuador | |
Spanish_Spain | |
Spanish_Guatemala | |
Spanish_Honduras | |
Spanish_Mexico | |
Spanish_Nicaragua | |
Spanish_Panama | |
Spanish_Peru | |
Spanish_PuertoRico | |
Spanish_Paraguay | |
Spanish_ElSalvador | |
Spanish_UnitedStates | |
Spanish_Uruguay | |
Spanish_Venezuela | |
Estonian | |
Estonian_Estonia | |
Basque | |
Basque_Basque | |
Persian | |
Persian_Iran | |
Finnish | |
Finnish_Finland | |
Filipino_Philippines | |
Faroese | |
Faroese_FaroeIslands | |
French_Belgium | |
French_Canada | |
French_Switzerland | |
French_France | |
French_Luxembourg | |
French_PrincipalityOfMonaco | |
Frisian_Netherlands | |
Irish_Ireland | |
ScottishGaelic_UnitedKingdom | |
Galician | |
Galician_Galician | |
Alsatian_France | |
Gujarati | |
Gujarati_India | |
Hausa_Latin_Nigeria | |
Hebrew | |
Hebrew_Israel | |
Hindi | |
Hindi_India | |
Croatian | |
Croatian_Latin_BosniaAndHerzegovina | |
Croatian_Croatia | |
UpperSorbian_Germany | |
Hungarian | |
Hungarian_Hungary | |
Armenian | |
Armenian_Armenia | |
Indonesian | |
Indonesian_Indonesia | |
Igbo_Nigeria | |
Yi_PeoplesRepublicOfChina | |
Icelandic | |
Icelandic_Iceland | |
Italian | |
Italian_Switzerland | |
Italian_Italy | |
Inuktitut_Syllabics_Canada | |
Inuktitut_Latin_Canada | |
Japanese | |
Japanese_Japan | |
Georgian | |
Georgian_Georgia | |
Kazakh | |
Kazakh_Kazakhstan | |
Greenlandic_Greenland | |
Khmer_Cambodia | |
Kannada | |
Kannada_India | |
Korean | |
Konkani | |
Konkani_India | |
Korean_Korea | |
Kyrgyz | |
Kyrgyz_Kyrgyzstan | |
Luxembourgish_Luxembourg | |
Lao_LaoPDR | |
Lithuanian | |
Lithuanian_Lithuania | |
Latvian | |
Latvian_Latvia | |
Maori_NewZealand | |
Macedonian | |
Macedonian_FormerYugoslavRepublicofMacedonia | |
Malayalam_India | |
Mongolian | |
Mongolian_Cyrillic_Mongolia | |
Mongolian_TraditionalMongolian_PeoplesRepublicOfChina | |
Mohawk_Canada | |
Marathi | |
Marathi_India | |
Malay | |
Malay_BruneiDarussalam | |
Malay_Malaysia | |
Maltese_Malta | |
Norwegian_Bokml_Norway | |
Nepali_Nepal | |
Dutch | |
Dutch_Belgium | |
Dutch_Netherlands | |
Norwegian_Nynorsk_Norway | |
Norwegian | |
Sesothosa_Leboa_SouthAfrica | |
Occitan_France | |
Oriya_India | |
Punjabi | |
Punjabi_India | |
Polish | |
Polish_Poland | |
Dari_Afghanistan | |
Pashto_Afghanistan | |
Portuguese | |
Portuguese_Brazil | |
Portuguese_Portugal | |
Kiche_Guatemala | |
Quechua_Bolivia | |
Quechua_Ecuador | |
Quechua_Peru | |
Romansh_Switzerland | |
Romanian | |
Romanian_Romania | |
Russian | |
Russian_Russia | |
Kinyarwanda_Rwanda | |
Sanskrit | |
Yakut_Russia | |
Sanskrit_India | |
Sami_Northern_Finland | |
Sami_Northern_Norway | |
Sami_Northern_Sweden | |
Sinhala_SriLanka | |
Slovak | |
Slovak_Slovakia | |
Slovenian | |
Slovenian_Slovenia | |
Sami_Southern_Norway | |
Sami_Southern_Sweden | |
Sami_Lule_Norway | |
Sami_Lule_Sweden | |
Sami_Inari_Finland | |
Sami_Skolt_Finland | |
Albanian | |
Albanian_Albania | |
Serbian | |
Serbian_Cyrillic_BosniaAndHerzegovina | |
Serbian_Cyrillic_SerbiaAndMontenegro_Former | |
Serbian_Cyrillic_Montenegro | |
Serbian_Cyrillic_Serbia | |
Serbian_Latin_BosniaAndHerzegovina | |
Serbian_Latin_SerbiaAndMontenegro_Former | |
Serbian_Latin_Montenegro | |
Serbian_Latin_Serbia | |
Swedish | |
Swedish_Finland | |
Swedish_Sweden | |
Kiswahili | |
Kiswahili_Kenya | |
Syriac | |
Syriac_Syria | |
Tamil | |
Tamil_India | |
Telugu | |
Telugu_India | |
Tajik_Cyrillic_Tajikistan | |
Thai | |
Thai_Thailand | |
Turkmen_Turkmenistan | |
Setswana_SouthAfrica | |
Turkish | |
Turkish_Turkey | |
Tatar | |
Tatar_Russia | |
Tamazight_Latin_Algeria | |
Uyghur_PeoplesRepublicOfChina | |
Ukrainian | |
Ukrainian_Ukraine | |
Urdu | |
Urdu_IslamicRepublicOfPakistan | |
Uzbek | |
Uzbek_Cyrillic_Uzbekistan | |
Uzbek_Latin_Uzbekistan | |
Vietnamese | |
Vietnamese_Vietnam | |
Wolof_Senegal | |
isiXhosa_SouthAfrica | |
Yoruba_Nigeria | |
Chinese_Simplified | |
Chinese_Traditional | |
Chinese_PeoplesRepublicOfChina | |
Chinese_HongKongSAR | |
Chinese_MacaoSAR | |
Chinese_Singapore | |
Chinese_Taiwan | |
isiZulu_SouthAfrica |
Complex Type PictureparkFault
The gui language for this user, which is stored in the user profile, e.g. "English".
Type ApplicationLanguage
Value | Description |
---|---|
German | |
English | |
French | |
InvariantLanguage_InvariantCountry | |
Afrikaans | |
Afrikaans_SouthAfrica | |
Amharic_Ethiopia | |
Arabic | |
Arabic_UAE | |
Arabic_Bahrain | |
Arabic_Algeria | |
Arabic_Egypt | |
Arabic_Iraq | |
Arabic_Jordan | |
Arabic_Kuwait | |
Arabic_Lebanon | |
Arabic_Libya | |
Arabic_Morocco | |
Mapudungun_Chile | |
Arabic_Oman | |
Arabic_Qatar | |
Arabic_Saudi_Arabia | |
Arabic_Syria | |
Arabic_Tunisia | |
Arabic_Yemen | |
Assamese_India | |
Azeri | |
Azeri_Cyrillic_Azerbaijan | |
Azeri_Latin_Azerbaijan | |
Bashkir_Russia | |
Belarusian | |
Belarusian_Belarus | |
Bulgarian | |
Bulgarian_Bulgaria | |
Bengali_Bangladesh | |
Bengali_India | |
Tibetan_PeoplesRepublicOfChina | |
Breton_France | |
Bosnian_Cyrillic_BosniaAndHerzegovina | |
Bosnian_Latin_BosniaAndHerzegovina | |
Catalan | |
Catalan_Catalan | |
Corsican_France | |
Czech | |
Czech_CzechRepublic | |
Welsh_UnitedKingdom | |
Danish | |
Danish_Denmark | |
German_Austria | |
German_Switzerland | |
German_Germany | |
German_Liechtenstein | |
German_Luxembourg | |
LowerSorbian_Germany | |
Divehi | |
Divehi_Maldives | |
Greek | |
Greek_Greece | |
English_Caribbean | |
English_Australia | |
English_Belize | |
English_Canada | |
English_UnitedKingdom | |
English_Ireland | |
English_India | |
English_Jamaica | |
English_Malaysia | |
English_NewZealand | |
English_RepublicOfThePhilippines | |
English_Singapore | |
English_TrinidadAndTobago | |
English_UnitedStates | |
English_SouthAfrica | |
English_Zimbabwe | |
Spanish | |
Spanish_Argentina | |
Spanish_Bolivia | |
Spanish_Chile | |
Spanish_Colombia | |
Spanish_CostaRica | |
Spanish_DominicanRepublic | |
Spanish_Ecuador | |
Spanish_Spain | |
Spanish_Guatemala | |
Spanish_Honduras | |
Spanish_Mexico | |
Spanish_Nicaragua | |
Spanish_Panama | |
Spanish_Peru | |
Spanish_PuertoRico | |
Spanish_Paraguay | |
Spanish_ElSalvador | |
Spanish_UnitedStates | |
Spanish_Uruguay | |
Spanish_Venezuela | |
Estonian | |
Estonian_Estonia | |
Basque | |
Basque_Basque | |
Persian | |
Persian_Iran | |
Finnish | |
Finnish_Finland | |
Filipino_Philippines | |
Faroese | |
Faroese_FaroeIslands | |
French_Belgium | |
French_Canada | |
French_Switzerland | |
French_France | |
French_Luxembourg | |
French_PrincipalityOfMonaco | |
Frisian_Netherlands | |
Irish_Ireland | |
ScottishGaelic_UnitedKingdom | |
Galician | |
Galician_Galician | |
Alsatian_France | |
Gujarati | |
Gujarati_India | |
Hausa_Latin_Nigeria | |
Hebrew | |
Hebrew_Israel | |
Hindi | |
Hindi_India | |
Croatian | |
Croatian_Latin_BosniaAndHerzegovina | |
Croatian_Croatia | |
UpperSorbian_Germany | |
Hungarian | |
Hungarian_Hungary | |
Armenian | |
Armenian_Armenia | |
Indonesian | |
Indonesian_Indonesia | |
Igbo_Nigeria | |
Yi_PeoplesRepublicOfChina | |
Icelandic | |
Icelandic_Iceland | |
Italian | |
Italian_Switzerland | |
Italian_Italy | |
Inuktitut_Syllabics_Canada | |
Inuktitut_Latin_Canada | |
Japanese | |
Japanese_Japan | |
Georgian | |
Georgian_Georgia | |
Kazakh | |
Kazakh_Kazakhstan | |
Greenlandic_Greenland | |
Khmer_Cambodia | |
Kannada | |
Kannada_India | |
Korean | |
Konkani | |
Konkani_India | |
Korean_Korea | |
Kyrgyz | |
Kyrgyz_Kyrgyzstan | |
Luxembourgish_Luxembourg | |
Lao_LaoPDR | |
Lithuanian | |
Lithuanian_Lithuania | |
Latvian | |
Latvian_Latvia | |
Maori_NewZealand | |
Macedonian | |
Macedonian_FormerYugoslavRepublicofMacedonia | |
Malayalam_India | |
Mongolian | |
Mongolian_Cyrillic_Mongolia | |
Mongolian_TraditionalMongolian_PeoplesRepublicOfChina | |
Mohawk_Canada | |
Marathi | |
Marathi_India | |
Malay | |
Malay_BruneiDarussalam | |
Malay_Malaysia | |
Maltese_Malta | |
Norwegian_Bokml_Norway | |
Nepali_Nepal | |
Dutch | |
Dutch_Belgium | |
Dutch_Netherlands | |
Norwegian_Nynorsk_Norway | |
Norwegian | |
Sesothosa_Leboa_SouthAfrica | |
Occitan_France | |
Oriya_India | |
Punjabi | |
Punjabi_India | |
Polish | |
Polish_Poland | |
Dari_Afghanistan | |
Pashto_Afghanistan | |
Portuguese | |
Portuguese_Brazil | |
Portuguese_Portugal | |
Kiche_Guatemala | |
Quechua_Bolivia | |
Quechua_Ecuador | |
Quechua_Peru | |
Romansh_Switzerland | |
Romanian | |
Romanian_Romania | |
Russian | |
Russian_Russia | |
Kinyarwanda_Rwanda | |
Sanskrit | |
Yakut_Russia | |
Sanskrit_India | |
Sami_Northern_Finland | |
Sami_Northern_Norway | |
Sami_Northern_Sweden | |
Sinhala_SriLanka | |
Slovak | |
Slovak_Slovakia | |
Slovenian | |
Slovenian_Slovenia | |
Sami_Southern_Norway | |
Sami_Southern_Sweden | |
Sami_Lule_Norway | |
Sami_Lule_Sweden | |
Sami_Inari_Finland | |
Sami_Skolt_Finland | |
Albanian | |
Albanian_Albania | |
Serbian | |
Serbian_Cyrillic_BosniaAndHerzegovina | |
Serbian_Cyrillic_SerbiaAndMontenegro_Former | |
Serbian_Cyrillic_Montenegro | |
Serbian_Cyrillic_Serbia | |
Serbian_Latin_BosniaAndHerzegovina | |
Serbian_Latin_SerbiaAndMontenegro_Former | |
Serbian_Latin_Montenegro | |
Serbian_Latin_Serbia | |
Swedish | |
Swedish_Finland | |
Swedish_Sweden | |
Kiswahili | |
Kiswahili_Kenya | |
Syriac | |
Syriac_Syria | |
Tamil | |
Tamil_India | |
Telugu | |
Telugu_India | |
Tajik_Cyrillic_Tajikistan | |
Thai | |
Thai_Thailand | |
Turkmen_Turkmenistan | |
Setswana_SouthAfrica | |
Turkish | |
Turkish_Turkey | |
Tatar | |
Tatar_Russia | |
Tamazight_Latin_Algeria | |
Uyghur_PeoplesRepublicOfChina | |
Ukrainian | |
Ukrainian_Ukraine | |
Urdu | |
Urdu_IslamicRepublicOfPakistan | |
Uzbek | |
Uzbek_Cyrillic_Uzbekistan | |
Uzbek_Latin_Uzbekistan | |
Vietnamese | |
Vietnamese_Vietnam | |
Wolof_Senegal | |
isiXhosa_SouthAfrica | |
Yoruba_Nigeria | |
Chinese_Simplified | |
Chinese_Traditional | |
Chinese_PeoplesRepublicOfChina | |
Chinese_HongKongSAR | |
Chinese_MacaoSAR | |
Chinese_Singapore | |
Chinese_Taiwan | |
isiZulu_SouthAfrica |
Complex Type User
Type Language
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Abbreviation | string | |
AbbreviationISO6392 | string | |
Available4UserInterface | boolean | |
CatalogLanguageSqlName | string | |
EnglishName | string | |
IetfLanguageTag | string | |
IsNeutralCulture | boolean | |
LanguageId | int | |
LanguageTranslation | string | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CopyLanguageId | int | |
Language | Language | |
Language4AssetContainerId | int | |
LanguageId | int | |
ts | base64Binary | |
Complex Type ArrayOfLanguage4AssetContainer
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CopyLanguageId | int | |
Language | Language | |
Language4AssetContainerId | int | |
LanguageId | int | |
ts | base64Binary | |
Type Language4Content
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ContentLanguageId | int | |
DefaultLanguage4AssetContainerId | int | |
DefaultLanguage4MetadataId | int | |
IsDefaultLanguage4Content | boolean | |
Language | Language | |
Language4ContentId | int | |
ts | base64Binary | |
Complex Type ArrayOfLanguage4Content
Type Language4Content
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ContentLanguageId | int | |
DefaultLanguage4AssetContainerId | int | |
DefaultLanguage4MetadataId | int | |
IsDefaultLanguage4Content | boolean | |
Language | Language | |
Language4ContentId | int | |
ts | base64Binary | |
Optional. The id of the content language.
The Language4Content is not a language, but a language configuration set, which defines the respective languages for metadata, asset containers and searching.
If null, the default language4contentId for this Picturepark is used for CreateSession.
As with the ui language, this value is written to the session log and never used again for any other purposes. Neither is it returned in coreInfo.
After a user logs in, the content language for this user is taken from the content language defined for this user in the database.
Type int
Element CreateSession
The ID of the language for content which is used initially for this session. Behind this ID is a set of languages (user interface , metadata, asset containers).
Type int
Element LoginWithSecurityToken2
The id of a content language.
Language4Content is not a language, but a set of languages for specific purposes.
Different languages can be assigned for content, metadata, asset containers and fulltext indexing.
Type int
Complex Type User
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CatalogLanguageId | int | |
Language | Language | |
Language4FullTextIndexId | int | |
ts | base64Binary | |
Complex Type ArrayOfLanguage4FullTextIndex
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CatalogLanguageId | int | |
Language | Language | |
Language4FullTextIndexId | int | |
ts | base64Binary | |
Type Language4Metadata
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
IsRequired | boolean | |
Language | Language | |
Language4MetadataId | int | |
LanguageFallbacks | ArrayOfLanguageFallback | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Complex Type ArrayOfLanguage4Metadata
Type Language4Metadata
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
IsRequired | boolean | |
Language | Language | |
Language4MetadataId | int | |
LanguageFallbacks | ArrayOfLanguageFallback | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DefaultLanguage4ContentId | int | |
IsDefault | boolean | |
Language | Language | |
Language4UserInterfaceId | int | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Complex Type ArrayOfLanguage4UserInterface
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DefaultLanguage4ContentId | int | |
IsDefault | boolean | |
Language | Language | |
Language4UserInterfaceId | int | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Type Language4Version
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
IsFavorite | boolean | |
Language | Language | |
Language4VersionId | int | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Complex Type ArrayOfLanguage4Version
Type Language4Version
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
IsFavorite | boolean | |
Language | Language | |
Language4VersionId | int | |
LanguageId | int | |
SortOrder | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Type LanguageFallback
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FallbackLanguage | string | |
FallbackLanguageId | int | |
Language4MetadataId | int | |
LanguageFallbackId | int | |
SortOrder | int | |
ts | base64Binary | |
Complex Type ArrayOfLanguageFallback
Type LanguageFallback
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FallbackLanguage | string | |
FallbackLanguageId | int | |
Language4MetadataId | int | |
LanguageFallbackId | int | |
SortOrder | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LanguageFallback | LanguageFallback | |
Complex Type Language4Metadata
The language id (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..).
Type int
Complex Type AssetContainerTranslation
The id of the language which determines the country name (NOT the language spoken in this country).
Country names are available in the languages: 1:german, 2:english, 3:french.
Type int
Complex Type CountryTranslation
Type ArrayOfLanguage4AssetContainer
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4AssetContainer | Language4AssetContainer | |
Complex Type LanguageConfiguration
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Content | Language4Content | |
Complex Type LanguageConfiguration
Type ArrayOfLanguage4FullTextIndex
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4FullTextIndex | Language4FullTextIndex | |
Complex Type LanguageConfiguration
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Metadata | Language4Metadata | |
Complex Type LanguageConfiguration
Type ArrayOfLanguage4UserInterface
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4UserInterface | Language4UserInterface | |
Complex Type LanguageConfiguration
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Language4Version | Language4Version | |
Complex Type LanguageConfiguration
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserData
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserShort
Type LdapSecurityGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SecurityGroupDistinguishedName | string | |
UserGroup2LdapSecurityGroupId | int | |
UserGroupId | int | |
ts | base64Binary | |
Complex Type ArrayOfLdapSecurityGroup
Type LdapSecurityGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SecurityGroupDistinguishedName | string | |
UserGroup2LdapSecurityGroupId | int | |
UserGroupId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LdapSecurityGroup | LdapSecurityGroup | |
Complex Type UserGroupItem
Number of maximally returned itens.
Type int
Element GetAssetLinksById
Optional. The maximal number of rows returned. Default is unlimited.
Type int
Element GetUsers
Optional. The maximal number of assets returned. Default is unlimited.
Type int
Complex Type ExtendedAssetFilter
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Type ArrayOfKeyValueOfintPortViewField6jg_STziK
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintPortViewField6jg_STziK | anyType (restriction) | |
Complex Type PortAssetItem
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserData
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserShort
Type LogicalOperation
Always empty.
Complex Type ArrayOfLogicalOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LogicalOperation | LogicalOperation | |
Complex Type AndOperation
Type ArrayOfAssetContainerLogicalOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerLogicalOperation | AssetContainerLogicalOperation | |
Complex Type AssetContainerAndOperation
Type ArrayOfAssetContainerLogicalOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerLogicalOperation | AssetContainerLogicalOperation | |
Complex Type AssetContainerOrOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LogicalOperation | LogicalOperation | |
Complex Type OrOperation
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LoginResult | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element LoginResponse
LoggedIn, NotLoggedIn or LoggedInAsGuest.
Type LoginStatus
Value | Description |
---|---|
NotLoggedIn | |
LoggedInAsGuest | |
LoggedIn |
Complex Type User
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
clientGuid | string | The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server. |
securityToken | string | The security token, which has been returned by GetSecurityToken. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
clientGuid | string | The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server. |
securityToken | string | The security token, which has been returned by GetSecurityToken. |
language4ContentId | int | The ID of the language for content which is used initially for this session. Behind this ID is a set of languages (user interface , metadata, asset containers). |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LoginWithSecurityToken2Result | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element LoginWithSecurityToken2Response
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LoginWithSecurityTokenResult | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element LoginWithSecurityTokenResponse
Type string
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Type long
Needed only for logging purposes.
Type int
Complex Type DownloadOptions
Type ArrayOfBusinessProcessLink
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessLink | BusinessProcessLink | |
Complex Type BusinessProcessShort
Type ArrayOfBusinessProcessLink
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BusinessProcessLink | BusinessProcessLink | |
Complex Type BusinessProcessShort
See above under AssetVersions.
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Complex Type AssetItem
An array with all master AssetVersions for this asset.
This array contains all assets which are a parent version for this asset.
Type ArrayOfAssetVersion
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetVersion | AssetVersion |
Currently an asset version is either a language version or a slide. Language version: one or more assets in different languages are assigned to a common master asset, e.g. if you have a pdf brochure in several different languages. Slide: One or more slides are assigned to a PowerPoint presentation (from which they have been created). |
Complex Type AssetMetadata
Type MediaInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioCount | int | |
AudioStreams | ArrayOfAudioStream | |
Codec | string | |
DerivativeDefinitionId | int | |
DurationInSeconds | duration | |
Format | string | |
OverallBitRate | int | |
VideoCount | int | |
VideoStreams | ArrayOfVideoStream | |
Complex Type ArrayOfMediaInfo
Type MediaInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AudioCount | int | |
AudioStreams | ArrayOfAudioStream | |
Codec | string | |
DerivativeDefinitionId | int | |
DurationInSeconds | duration | |
Format | string | |
OverallBitRate | int | |
VideoCount | int | |
VideoStreams | ArrayOfVideoStream | |
A list of MediaInfos if the asset is an audio or a video.
Type ArrayOfMediaInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
MediaInfo | MediaInfo | |
Complex Type AssetMetadata
The number of assets per media type in the order of MediaTypeId.
E.g. 111,22,33. 111 assets belong to the first media type (e.g. "all"), 22 to the second and 33 to the third etc.
Please note: as with TotalAssets, these figures refer to the whole query, not just to the assets returned.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type AssetItemCollection
Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies.
Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia".
Default: all
MediaTypeIds = new List<int> {1,4,3}
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type ExtendedAssetFilter
List of xmp mappings, shows which Picturepark fields are mapped to which metadata fields in the image file.
This allows for the mappings to be displayed in the UI, e.g. in the upload mask.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
MetadataProperty | MetadataProperty | |
Complex Type Field
Type MetadataProperty
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
DataType | DataType | |
DataTypeId | int | |
IsArray | boolean | |
IsMappable | boolean | |
MetadataParentPropertyId | int | |
MetadataPropertyId | int | |
MetadataSchema | MetadataSchema | |
MetadataSchemaId | int | |
PropertyName | string | |
ts | base64Binary | |
Complex Type ArrayOfMetadataProperty
Type MetadataProperty
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
DataType | DataType | |
DataTypeId | int | |
IsArray | boolean | |
IsMappable | boolean | |
MetadataParentPropertyId | int | |
MetadataPropertyId | int | |
MetadataSchema | MetadataSchema | |
MetadataSchemaId | int | |
PropertyName | string | |
ts | base64Binary | |
Type MetadataSchema
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
MetadataSchemaId | int | |
Schema | string | |
ts | base64Binary | |
Complex Type MetadataProperty
Type MetadataSchema
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
MetadataSchemaId | int | |
Schema | string | |
ts | base64Binary | |
The modification date.
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type AssetContainerItem
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type AssetVersion
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DerivativeLock
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type ExtendedDerivative
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type RightTemplate
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type RightTemplate2AssetType
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type RightTemplate2Right
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type RightTemplate2UserGroup
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type Skin
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserData
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserShort
The id of the last user who edited the container.
Type int
Complex Type AssetContainerItem
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
sourceAssetContainerId | int | The id of the source asset container. |
destinationAssetContainerId | int | The id of the new parent asset container. |
insertBeforeAssetContainerId | int |
The id of the sibling container before which the source shall be inserted. Set to 0 if you wish to insert the moved container at the last position. |
Restricting anyType
Always empty.
The facet name.
Type string
Element GetFacetConfigurationExtended
The asset container name in the language defined by LanguageId.
Type string
Complex Type AssetContainerTranslation
Type string
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
The field name, e.g. AssetName, AssetDescription, FileSizeInBytes, CDF8 ..
Type string
Complex Type Field
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Complex Type Skin
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
IncludeMax | boolean | Include upper boundarie's value in result. Lucene syntax only! |
IncludeMin | boolean | Include lower boundarie's value in result. Lucene syntax only! |
LargerThanNumeric | float | |
SmallerThanNumeric | float | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualNumeric | float | |
Type NumericLargerThanOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
IncludeMin | boolean | Include lower boundarie's value in result. Lucene syntax only! |
LargerThanNumeric | float | |
Type NumericListEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualNumericList | ArrayOffloat | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
NotEqualNumeric | float | |
Type NumericSmallerThanOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
IncludeMax | boolean | Include upper boundarie's value in result. Lucene syntax only! |
SmallerThanNumeric | float | |
The start index of the current chunk in the source/destination file.
Type long
Element UploadChunk
Optional. If true, derivatives are not created (except the original derivative). Default is false.
Needed only in special cases where the user wishes to import his own derivatives.
Type boolean
Complex Type AssetImportOptions
Optional. If true, derivatives are not created (except the original derivative). Default is false.
Needed only in special cases where the user wishes to import his own derivatives.
Type boolean
Complex Type AssetUpdateOptions
Get only users with expired renewals.
Type boolean
Element GetUsers
Optional. This parameter is needed in order to display the opened part of a category branch.
You define a parent id (a) and an openedAssetContainerId (aaaa) below the parent and you will get the nodes on the line of descendants (a, aa, aaa, aaaa) plus all siblings of these nodes:
a (Parent)
aa bb cc dd ee (Child aa plus siblings bb, cc ..)
aaa bbb (Child aaa of aa plus siblings bbb ..)
aaaa bbbb cccc (Child aaaa of aaa plus siblings bbbb, cccc..)
Type int
Element GetAssetContainers
An array with all available options for this field.
Needed for ComboBox- and MultiCheckbox fields).
Type ArrayOfFieldOption
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOption | FieldOption | |
Complex Type Field
An array of PortDerivatives for this asset.
A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PortDerivative | PortDerivative | A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
Complex Type PortAssetItem
Original ExtendedDerivative.
The data for the original are always returned, even if there are no access rights to the original.
Type ExtendedDerivative
Contains elements as defined in the following table.
Complex Type AssetMetadata
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type DerivativeLock
Type OrOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ComparisonOperations | ArrayOfComparisonOperation | |
LogicalOperations | ArrayOfLogicalOperation | |
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Type ArrayOfKeyValueOfintPortViewField6jg_STziK
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintPortViewField6jg_STziK | anyType (restriction) | |
Complex Type PortAssetItem
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Type string
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
An array with all parent AssetItems.
An asset can have more than one parent.
Type ArrayOfAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetItem | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
Complex Type AssetMetadata
The id of the asset container where the new container is created.
Type int
Element CreateAssetContainer
The id of the AssetContainer (category or asset class) for which the children are to be returned.
Type int
Element GetAssetContainers
The id of the parent asset containert, is null for containers on the highest level.
Type int
Complex Type AssetContainerItem
The id of the parent asset.
Type int
Complex Type AssetMetadata
The id of the parent asset. Null, if this version is a master.
Type int
Complex Type AssetVersion
The password. Must have the minimum strength as defined for this customer.
Type string
Element CreateUser
The password must be submitted for Login, but is never returned.
Type string
Complex Type User
An array with the AssetContainerRights for the current user.
Type ArrayOfAssetContainerRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRight | AssetContainerRight | |
Complex Type AssetContainerItem
Type PersonalItemRight
Value | Description |
---|---|
View | |
Edit |
Complex Type ArrayOfPersonalItemRight
Type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfPersonalItemRightuUS27HWe | anyType (restriction) | |
Complex Type Rights
Type PictureparkErrorType
Value | Description |
---|---|
UnknownError | Unknown error |
InvalidSession | Session not valid |
InsufficientRights | This user does not have the necessary rights for this action |
InsertFailure | Insert failed |
UpdateFailure | Update failed |
DeletionFailure | Delete failed |
FalseParameters | Wrong parameters |
FileNotFoundInsufficientRights | Either file not found or the user does not have the necessary access rights |
NotInDB | Not found in database |
UploadFailure | File upload failed |
TypeMismatch | Type mismatch |
FileNotFound | File not found |
IncompleteData | Data are incomplete or invalid |
InvalidEmail | Invalid email address |
EmptyString | Invalid value: empty string |
EmailAlreadyInUse | This email address has already been allocated |
PasswordNotFound | Authentication user with this password not found |
UnknownEmail | There is no active user with this email address |
UnknownSecurityToken | Security token not found |
UserIdIsZero | User id was 0 for security token user |
RenewalUnnecessary | Renewal failed: No renewal needed |
UnknownRenewalEmail | Renewal failed: User with this email address not found |
NoExpirationDate | Renewal failed: No expiration date set |
TimespanExpired | Renewal failed: Timespan for renewal has expired |
RenewalTooEarly | Renewal failed: Too early, renewal not yet possible |
IncompleteRenewalData | Renewal failed: Data are not complete |
InvalidContact | Renewal failed: Invalid email address of contact |
IdenticalPassword | Renewal failed: Old and new password are identical |
InvalidOldPassword | Renewal failed: There is no user account with this (old) password |
WeakRenewalPassword | Renewal failed: The new password is not strong enough |
UserNotFound | User with this email and password not found |
SecurityTokenUser | Login failed: User is a security token user |
DeletedUser | Login failed: User has been deleted (user state = 10) |
ExpiredUser | Login failed: User has expired (user state = 20) |
LockedUser | Login failed: User is locked (user state = 21) |
DisapprovedUser | Login failed: User has been disapproved (user state = 22) |
UnconfirmedUser | Login failed: Registration has not yet been confirmed by the user (user state = 30) |
UserUnapproved | Login failed: User is waitung for approval (user state = 40) |
InvalidState | Login failed: User state is invalid |
NoSubstituteUser | User not deleted: Substitute responsible user does not exist |
PasswordSent | Sending of passwords not allowed in this Picturepark |
InvalidPassword | This password is not valid |
WeakPassword_1 | This password is not strong enough |
InvalidDate | This expiration date is not a valid date |
DatePassed | This expiration date lies in the past |
CannotSetState | This user state cannot be set directly |
IdNotFound | User with this id not found |
UserPasswordNotFound | User with this password not found |
IdIsZero | Invalid user id 0 |
ProtectedAccount | This user account is protected |
ConfirmableUserNotFound | Confirmation of registration failed: user not found |
AlreadyConfirmed | Confirmation of registration failed: user has been confirmed already |
AlreadyApproved | Confirmation of registration failed: user has been approved already |
StateNot30 | Confirmation of registration failed: user state is not 30 |
ContactEmailInvalid | Registration failed: email address of internal contact is not a valid email address |
ActiveUserEmailUnknown | Registration failed: there is no active user with this email address |
NotInternalContact | Registration failed: this user is not an internal contact |
UserEmailUnknown | User with this email address not found |
LDAPPasswordChanged | LDAP login failed. Probably LDAP password has been changed |
GuestLogin | Login as guest failed |
SecurityTokenExpired | Security token has expired |
LDAPServerNotRunning | LDAP server not running |
RenewalExpiredUser | Renewal expired |
LinkedUserAccountNotFound | Linked user account with this email {0} and password not found |
SecurityTokenIpMismatch | Security token IP mismatch |
DeletingGuestUser | Guest user cannot be deleted |
DeletingCurrentUser | Current User cannot be deleted |
InvalidSenderEmail | Email address of sender is invalid |
InvalidRecipientsEmail | Email addresses of all recipients are invalid |
EmailNotSent | No email could be sent |
PartialSending | Some emails could be sent, some not |
OrderFilesLogin | In this Picturepark only logged in users can order files |
UnfoundOrder | Order not found |
UnfoundSubOrder | Sub order not found |
InvalidOrderState | This is not a valid order state |
InvalidSubOrderState | This is not a valid sub order state |
InvalidOrderManager | The order manager is not a valid Picturepark user |
CopyrightExists | This copyright already exists |
CopyrightDuplicateName | A copyright with this name already exists |
CopyrightNoID | A copyright with this id does not exist |
CopyrightDeletionFailure | This copyright is assigned to assets and therefore cannot be deleted |
KeywordNotFound | A keyword with this id does not exist |
IllegalAssetContainerMove | An asset container cannot be moved into itself |
ParentNotFound | Parent asset container not found |
EmptyDownloadArray | Array of download files is empty. Probably due to missing access rights and/or because the files do not exist |
DownloadNotCreated | The system could not create the download file |
BaseLanguageDeletionFailure | The base language PDF cannot be deleted |
PlaceholderNotFound | Placeholder not found |
InvalidURI | Invalid URI |
ExtensionMissingForPlaceholder | Extension missing for placeholder |
FileNotFoundInUploadDirectory | File not found in upload directory |
FileIsDuplicate | File is duplicate |
AssetNotFound | Asset not found |
DownloadTokenNotValid | The specified download token is not valid |
NotFilledOutCorrectly | One or more fields are invalid please verify your inputs. |
IndexRebuildThresholdExceeded | The specified download token is not valid |
RootLevelPropagation | The specified download token is not valid |
SessionExpired | The current customer hasn't been initialized with a language yet. Please initialize the according base class with a language first |
ContentTypeException | |
ExpiredVersion | The current version ({0}) has expired. The application cannot be executed anymore. Please download and install the new version from {1}. Closing this message box will automatically open that link in your browser |
NotYetActivatedVersion | The current version ({0}) is a pre-release and has not been activated yet. This version will be functional as soon as the Picturepark servers get the according upgrade |
UnknownPictureparkUrl | No Picturepark found at the specified URL (404). Please ensure you used the correct format for the URL: yourcompany.picturepark.com |
WrongPictureparkUrl | Please ensure you entered the URL with http(s) prefix: http(s)://yourcompany.picturepark.com |
ClearCacheTimeout | The cache could not have been cleared because some thumbnails are still in use by a background process. Please try again |
InvalidProxyAuthentication | Proxy authentication required (407). Please check your proxy settings |
InvalidLanguage | The selected language is not valid for this Picturepark instance |
UpdateByOtherUser | |
SessionExpiredEventFired | The SessionExpired event has been fired |
DuplicateAsset | Duplicate asset. Already processed an asset with the file name |
InvalidCropXValue | Invalid CropX value: |
InvalidCropYValue | Invalid CropY value: |
InvalidReplicationAssetContainer | Cannot use this asset container for replication because it conflicts with another enabled replication asset container. Please check the Replication Manager |
SiteNotFound | Publisher site could not be found |
InvalidMetadataMapping | Metadata mapping is invalid |
InvalidFieldValue | Field value is invalid |
InvalidAssetType | The asset type of the specified file is not valid for this action |
DuplicateAssetContainer | An asset container with the same absolute path already exists. Please adjust asset container naming |
DerivativeNotFound | Derivative not found. Please repair the asset and retry |
ClientNotFound | Client not found. Please provide a valid client guid |
DuplicateSkinName | Duplicate skin name found. Please provide a unique skin name |
DuplicateSiteName | Duplicate site name found. Please provide a unique site name |
FieldNotFound | No field found whose name matches the given string |
NoRightTemplateFound | No right template found for this file type |
Languages4IsReferencedInLanguage4Contents | Cannot remove this language\n because it is referenced in Languages4Contents.\n\n Please check the Languages4Contents first |
LanguageIsReferenced | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
AccessDenied | Access Denied |
ForeingKeyMissing | Cannot remove this imageEncodingOption\n because it is referenced in Derivatives.\n\n Please check Derivatives first |
LanguageIsReferencedContentLanguages4MetadataMapping | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInMetadataMappings | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInFieldValues | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInOrders | Cannot remove this delivery method\n because it is referenced in orders |
ReferencedInWorkflows | Cannot remove this field\n because it is referenced in workflows |
ReferencedInAssetVersion | Cannot remove this field\n because it is referenced in workflows |
FieldExists | Cannot remove this field\n because it is referenced in workflows |
ImageEncodingOptionIsReferenced | Cannot remove this imageEncodingOption\n because it is referenced in Derivatives.\n\n Please check Derivatives first |
NoLicenseKey | No license key installed. Please install a valid license key over the ManagementConsole |
InvalidLicenseKey | The current license key is not valid |
ExpiredLicenseKey | The current license is expired |
InsufficientLicense | The current license is insufficend to performe this action |
DuplicateLicenseKey | The current license is insufficend to performe this action |
InsufficentDiskSpaceOnTarget | Insufficient disk space on target server |
AbsoluteSqlServer2ServerExchangeDirectoryPathIsUndefined | AbsoluteSqlServer2ServerExchangeDirectoryPath is undefined |
AbsoluteInstanceImagePoolPathIsUndefined | AbsoluteInstanceImagePoolPath is undefined |
InstanceImageFileAlreadyExists | Instance image file already exists |
InstanceImageFileNotFound | Instance image file not found |
WrongFormatOfCustomerAbbreviation | Wrong format of customer abbreviation |
WrongFormatOfDatabaseName | Wrong format of database name |
ProhibitedDatabaseName | Prohibited database name |
CustomerIdAlreadyExists | Customer id already exists |
DatabaseAlreadyExists | The target database (Initial catalog) already exists on the server |
PublicFileDirectoryAlreadyExists | Public target file directory already exists |
ProtectedFileDirectoryAlreadyExists | Protected target file directory already exists |
InvalidFilenameForInstanceImageFile | Invalid filename for instance image (iso) file |
InstanceImageFileWithThisNameAlreadyExistsOnTargetServer | An instance image file with this name exists already on the target server |
InvalidVersionForInstanceImageFile | Invalid version of instance image (iso) file |
InconsistentImportData | Inconsistent import data |
DuplicateSearchServerNodeUrl | Duplicate search server node URL |
SearchServerNodeStillInUse | Node is still mapped to a customer |
MultiplePrimarySearchNode | Primary search node already exists |
NoPrimarySearchNode | Primary search node not exists |
MasterNodeDependencies | Primary search node has dependencies |
NoMasterNodeFound | No primary master search node found |
NoReplicationDocumentFound | No replication document found |
NoStaticIndexDefinitionFound | No static index definition found |
DefaultDatabaseNotSet | No 'DefaultDatabase' set for DocumentStore |
InstanceImageFileCannotBeOpened | Instance image file cannot be opened |
InstanceImageFileIsIncomplete | Invalid instance image file. Data is incomplete |
NoDatabaseFoundForSourcePicturepark | There is no database defined for the source Picturepark. |
Type PictureparkFault
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ErrorCode | int | |
Language | ApplicationLanguage | |
Message | string | |
Type | PictureparkErrorType |
This is an enumeration, which is normally submitted in a form like "PictureparkErrorType.UnknownError" or "PictureparkErrorType.InvalidSession" etc. Due to the SOAP specification enumeration values are sent and received with its name in the String format, e.g. "UnknownError" or "InvalidSession" etc. Depending on the generated webservice proxy code the numeric values of the enums might be needed. In this latter unlikely case see here for the numeric values: http://webservice8.picturepark.com/PublicService.svc?xsd=xsd2 |
Type Version
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
_Build | int | |
_Major | int | |
_Minor | int | |
_Revision | int | |
Complex Type PublicConfiguration
Type PortAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the asset right template. |
AppliedAssetRightTemplateName | string | The translation of the asset right template in current user language. |
AssetId | int | The asset id. |
AssetTypeId | AssetType | |
AssetTypeTranslation | string | |
Copyright | string | |
CreationDate | string | |
Description | string | The asset's further description (in most cases it'll be the field AssetDescription). |
DownloadableDerivatives | ArrayOfPortDerivative |
An array of PortDerivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
FileExtension | string | |
FileSize | string | |
LargeThumbnailUrl | string | |
ListViewFields | ArrayOfKeyValueOfintPortViewField6jg_STziK | |
MediumThumbnailUrl | string | |
OrderableDerivatives | ArrayOfPortDerivative |
An array of PortDerivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
OverlayText | string | |
OverviewFields | ArrayOfKeyValueOfintPortViewField6jg_STziK | |
SmallThumbnailUrl | string | |
SubTitle | string | The asset's sub title in more detailed views. |
Title | string | The asset's title which is used all over the new port (in most cases it'll be the field AssetName). |
Complex Type ArrayOfPortAssetItem
Type PortAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AppliedAssetRightTemplateId | int | The id of the asset right template. |
AppliedAssetRightTemplateName | string | The translation of the asset right template in current user language. |
AssetId | int | The asset id. |
AssetTypeId | AssetType | |
AssetTypeTranslation | string | |
Copyright | string | |
CreationDate | string | |
Description | string | The asset's further description (in most cases it'll be the field AssetDescription). |
DownloadableDerivatives | ArrayOfPortDerivative |
An array of PortDerivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
FileExtension | string | |
FileSize | string | |
LargeThumbnailUrl | string | |
ListViewFields | ArrayOfKeyValueOfintPortViewField6jg_STziK | |
MediumThumbnailUrl | string | |
OrderableDerivatives | ArrayOfPortDerivative |
An array of PortDerivatives for this asset. A derivative is an asset which has been created automatically by the system, e.g. a certain image format or a movie. |
OverlayText | string | |
OverviewFields | ArrayOfKeyValueOfintPortViewField6jg_STziK | |
SmallThumbnailUrl | string | |
SubTitle | string | The asset's sub title in more detailed views. |
Title | string | The asset's title which is used all over the new port (in most cases it'll be the field AssetName). |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Assets | ArrayOfPortAssetItem | An array of AssetItem. |
TotalAssets | int |
The number of assets in the query. Please note: this figure is not necessarily identical with the number of AssetItems. Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter. |
Type PortDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
DerivativeDefinitionTranslation | string | |
DerivativeId | int | |
FileSize | string | |
Height | int | |
TraceUsagePurpose | boolean | |
Use4Preview | boolean | |
VersionOptionId | int | |
VersionTypeId | int | |
Width | int | |
Complex Type ArrayOfPortDerivative
Type PortDerivative
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetId | int | |
DerivativeDefinitionId | int | |
DerivativeDefinitionTranslation | string | |
DerivativeId | int | |
FileSize | string | |
Height | int | |
TraceUsagePurpose | boolean | |
Use4Preview | boolean | |
VersionOptionId | int | |
VersionTypeId | int | |
Width | int | |
Type PortViewField
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
IsFullWidth | boolean | |
Position | int | |
Values | ArrayOfstring | |
Holds the asset filter that has been provided for searching
Type ExtendedAssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
AssetContainerSearchOperation | AssetContainerLogicalOperation |
Optional. Define from which asset containers to get assets. See the general API docu overview for further examples! // EXAMPLE: Get assets from asset container id 123 plus all sub-containers: |
AssetTypeIds | ArrayOfint |
Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images. Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized. Default: all AssetTypeIds = new List<int> {2, 6, 20} |
Limit | int | Optional. The maximal number of assets returned. Default is unlimited. |
MediaTypeIds | ArrayOfint |
Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies. Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia". Default: all MediaTypeIds = new List<int> {1,4,3} |
ReturnMediaTypeCounts | boolean |
Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned. For performance reasons, this paramter should be set to false if not needed. Default: false |
SearchDesiredMetadataLanguageOnly | boolean | Optional. If true, a search is done only within language specific metadata. Default: false. |
SearchOnlyDeletedAssets | boolean | Optional. |
SearchOperation | LogicalOperation |
Optional. Define search parameters for a complex search. See the general API docu overview for further examples! See ComparisonOperation for available operators. // EXAMPLE: Get asset with AssetId 111: |
SimpleSearchString | string |
Optional. Use simple search, if you wish to search within all fields for a simple string.
|
SortInfos | ArrayOfSortInfo |
Sort parameters: the asset field and the direction (ascending or descending). This is the only required parameter! You may define several sort infos, e.g. AssetName asc, AssetId desc. List<SortInfo> sortInfos = new List<SortInfo>(); |
StartRow | int | Optional. The row in the query, from where on to return the assets. Default is 0. |
UnassignedAssetsOnly | boolean | Optional. If true, only assets which are in no category are returned. Default: false. |
VersionTypeIds | ArrayOfint |
Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions). This is not a filter for the assets, thus has no impact on the number of assets returned by the query. VersionTypeIds = new List<int> { 1, 3 } |
Complex Type FacetResults
If true, the system provides for a (pseudo) unique name for each derivative.
Depending on the download configuration of a particular Picturepark, each derivative normally has a unique name. If this is the case, the provideUniqueFileName-parameter is ignored.
But if for some reason identically named derivatives are downloaded as discrete files one by one, they would be overwritten by their namesakes.
In this case, if provideUniqueFileName is true, the system will append the derivative definition short name, e.g. "Internet" in order to create a (pseudo) unique file name.
Type boolean
Element DownloadExtended
E.g. http://picturepark.vit.local/Public/1/ThumbnailSmall/1031.jpg.
Type string
Complex Type Derivative
Complex Type ExtendedDerivative
Type PublicConfiguration
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Countries | ArrayOfCountry | |
DerivativeDefinitions | ArrayOfDerivativeDefinition | |
PictureparkVersion | Version | |
Type QName
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | Used in UI set to user language4content's caption |
DateRange | FacetDateRange | |
FromNumeric | float | |
Name | string | |
SortOrder | int | |
ToNumeric | float | |
Translations | ArrayOfFacetConfigurationTranslation | Used for configuration (read / save) |
Complex Type FacetValue
Type ArrayOfFacetConfigurationRange
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationRange | FacetConfigurationRange | |
Complex Type FacetConfigurationElement
An array with all AssetItems to which this asset refers (from Documents).
Type ArrayOfAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetItem | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
Complex Type AssetMetadata
An array with all AssetItems which refer to this asset (from AssetObjects).
Type ArrayOfAssetItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetItem | AssetItem | An AssetItem represents the attributes of one asset including relations to other assets. |
Complex Type AssetMetadata
Optional. The RegistrationState, if you wish to get only users with a certain regristration state.
Type RegistrationState
Value | Description |
---|---|
Waiting4EmailAuthentication | |
Waiting4ConfirmationByAdmin | |
Waiting4ConfirmationByContact | |
RejectedByAdmin | |
RejectedByContact |
Element GetUsers
Type RegistrationState
Value | Description |
---|---|
Waiting4EmailAuthentication | |
Waiting4ConfirmationByAdmin | |
Waiting4ConfirmationByContact | |
RejectedByAdmin | |
RejectedByContact |
Complex Type UserData
Type RegistrationState
Value | Description |
---|---|
Waiting4EmailAuthentication | |
Waiting4ConfirmationByAdmin | |
Waiting4ConfirmationByContact | |
RejectedByAdmin | |
RejectedByContact |
Type RegistrationState
Value | Description |
---|---|
Waiting4EmailAuthentication | |
Waiting4ConfirmationByAdmin | |
Waiting4ConfirmationByContact | |
RejectedByAdmin | |
RejectedByContact |
Complex Type UserShort
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Complex Type FacetResult
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int |
The id of the asset container. The deletion of an asset container includes the deletion of all sub containers! |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | An array of asset ids. |
deleteDependentAssets | boolean |
If true, asset versions depending on the deleted assets are also deleted. Assets versions are currently either language versions or slides (belonging to a Powerpoint presentation). |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetIds | ArrayOfint | List of asset ids. |
assetContainerIds | ArrayOfint | List of asset container ids. |
Restricting anyType
Always empty.
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetVersions | ArrayOfAssetVersion | A list of AssetVersions. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
userIds | ArrayOfint | A list of user ids. |
substituteUserId | int |
If a substitute user is submitted, all references to the deleted users will be replaced by the substitute. E.g. the substitute will be registered as the new responsible user for all assets, for which the deleted users had been responsible before. |
Restricting anyType
Always empty.
Type RenderingActionArgumentValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionArgumentId | int | |
RenderingActionArgumentValueId | int | |
RenderingActionValueId | int | |
Value | string | |
ts | base64Binary | |
Complex Type ArrayOfRenderingActionArgumentValue
Type RenderingActionArgumentValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionArgumentId | int | |
RenderingActionArgumentValueId | int | |
RenderingActionValueId | int | |
Value | string | |
ts | base64Binary | |
Type ArrayOfRenderingActionArgumentValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionArgumentValue | RenderingActionArgumentValue | |
Complex Type RenderingActionValue
Type RenderingActionValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetTypeId | int | |
DerivativeDefinitionId | int | |
RenderingActionArgumentValues | ArrayOfRenderingActionArgumentValue | |
RenderingActionId | int | |
RenderingActionValueId | int | |
SortOrder | int | |
ts | base64Binary | |
Complex Type ArrayOfRenderingActionValue
Type RenderingActionValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetTypeId | int | |
DerivativeDefinitionId | int | |
RenderingActionArgumentValues | ArrayOfRenderingActionArgumentValue | |
RenderingActionId | int | |
RenderingActionValueId | int | |
SortOrder | int | |
ts | base64Binary | |
Type ArrayOfRenderingActionValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenderingActionValue | RenderingActionValue | |
Complex Type DerivativeDefinition
The RenderingClient.
Type RenderingClient
Value | Description |
---|---|
Import | |
Update | |
Repair | |
Editor |
Element CreateRenderingJob
The rendering job id.
Each import must be assigned to a rendering job. Call CreateRenderingJob first to get a renderingJobId. This allows several imports to be pooled to one job.
Type int
Element ImportSingleAsset
The rendering job id.
Call CreateRenderingJob to get a renderingJobId. This allows several updates to be pooled to one job.
Type int
Element SaveDerivative
The rendering job id.
Each update must be assigned to a rendering job. Call CreateRenderingJob first to get a renderingJobId. This allows several updates to be pooled to one job.
Type int
Element UpdateOriginalDerivative
Technical flag concerning the rendering state.
Type RenderingState
Value | Description |
---|---|
Pending | |
Completed | |
Failed |
Complex Type Derivative
Complex Type ExtendedDerivative
Optional. The RenewalState, if you wish to get only users with a certain renewal state.
Type RenewalState
Value | Description |
---|---|
Waiting4RenewalByAdmin | |
Waiting4RenewalByContact | |
RejectedByAdmin | |
RejectedByContact |
Element GetUsers
Type RenewalState
Value | Description |
---|---|
Waiting4RenewalByAdmin | |
Waiting4RenewalByContact | |
RejectedByAdmin | |
RejectedByContact |
Complex Type UserData
Type RenewalState
Value | Description |
---|---|
Waiting4RenewalByAdmin | |
Waiting4RenewalByContact | |
RejectedByAdmin | |
RejectedByContact |
Type RenewalState
Value | Description |
---|---|
Waiting4RenewalByAdmin | |
Waiting4RenewalByContact | |
RejectedByAdmin | |
RejectedByContact |
Complex Type UserShort
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserData
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserShort
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RenewSessionResult | CoreInfo | This data structure, which is returned by CreateSession, contains the core session data. First input parameter for most public webservices. |
Type CoreInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClientId | int | The client id. |
CustomerId | int |
The id of the customer (Picturepark), which must be submitted when creating a session. For Picturepark server solutions, this id is usually 1. |
CustomerName | string | E.g. "Media database Walchwil". Currently not used, always null. |
GlobalUser | User | Session specific User data. |
SessionId | string | A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session. |
TraceJobId | int |
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.". Needed for tracing purposes only. |
User | User | Session specific User data. |
Element RenewSessionResponse
If true, field value will be splitted and formated by its special characters. The results will be added to the full text search index.
Type boolean
Complex Type Field
A result per field (facet)
Type ArrayOfFacetResult
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetResult | FacetResult | |
Complex Type FacetResults
Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage.
Type boolean
Complex Type AssetFilter
Complex Type ExtendedAssetFilter
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection.
These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter.
Type boolean
Complex Type AssetFilter
Complex Type ExtendedAssetFilter
Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned.
For performance reasons, this paramter should be set to false if not needed. Default: false
Type boolean
Complex Type ExtendedAssetFilter
Type Rights
Contains elements as defined in the following table.
Type RightTemplate
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Applicable | boolean | |
AssetTypeIds | ArrayOfint | |
Assigned | boolean | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Description | string | |
Editable | boolean | |
IsDefault | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Name | string | |
RightTemplateId | int | |
RightTemplateType | RightTemplateType | |
RightTemplates2AssetTypes | ArrayOfRightTemplate2AssetType | |
RightTemplates2Rights | ArrayOfRightTemplate2Right | |
RightTemplates2UserGroups | ArrayOfRightTemplate2UserGroup | |
SortOrder | int | |
ts | base64Binary | |
Complex Type ArrayOfRightTemplate
Type RightTemplate
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Applicable | boolean | |
AssetTypeIds | ArrayOfint | |
Assigned | boolean | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Description | string | |
Editable | boolean | |
IsDefault | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Name | string | |
RightTemplateId | int | |
RightTemplateType | RightTemplateType | |
RightTemplates2AssetTypes | ArrayOfRightTemplate2AssetType | |
RightTemplates2Rights | ArrayOfRightTemplate2Right | |
RightTemplates2UserGroups | ArrayOfRightTemplate2UserGroup | |
SortOrder | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetType | AssetType | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2AssetTypeId | int | |
RightTemplateId | int | |
ts | base64Binary | |
Complex Type ArrayOfRightTemplate2AssetType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetType | AssetType | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2AssetTypeId | int | |
RightTemplateId | int | |
ts | base64Binary | |
Type RightTemplate2Right
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRightId | int | |
AssetRightId | int | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
DerivativeDefinitionId | int | |
DerivativeDefinitionRightId | int | |
DerivativeRightId | int | |
FieldRightId | int | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2RightId | int | |
RightTemplateId | int | |
UserGroupId | int | |
UserGroupRightId | int | |
UserRightId | int | |
ts | base64Binary | |
Complex Type ArrayOfRightTemplate2Right
Type RightTemplate2Right
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRightId | int | |
AssetRightId | int | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
DerivativeDefinitionId | int | |
DerivativeDefinitionRightId | int | |
DerivativeRightId | int | |
FieldRightId | int | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2RightId | int | |
RightTemplateId | int | |
UserGroupId | int | |
UserGroupRightId | int | |
UserRightId | int | |
ts | base64Binary | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2UserGroupId | int | |
RightTemplateId | int | |
RightTemplateRight | RightTemplateRight | |
UserGroupId | int | |
Complex Type ArrayOfRightTemplate2UserGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
RightTemplate2UserGroupId | int | |
RightTemplateId | int | |
RightTemplateRight | RightTemplateRight | |
UserGroupId | int | |
The id of a right template.
Type int
Element SaveAssetContainerRights
The id of the right template.
Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true).
Type int
Element SaveAssetsRights
The id of the right template.
Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true).
Type int
Element SaveDerivativeRights
Type RightTemplateRight
Value | Description |
---|---|
View | |
Edit | |
Apply |
Complex Type RightTemplate2UserGroup
Type ArrayOfRightTemplate
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate | RightTemplate | |
Complex Type Rights
Type ArrayOfRightTemplate2AssetType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2AssetType | RightTemplate2AssetType | |
Complex Type RightTemplate
Type ArrayOfRightTemplate2Right
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2Right | RightTemplate2Right | |
Complex Type RightTemplate
Type ArrayOfRightTemplate2UserGroup
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
RightTemplate2UserGroup | RightTemplate2UserGroup | |
Complex Type RightTemplate
Type RightTemplateType
Value | Description |
---|---|
AssetContainer | |
Asset | |
DerivativeDefinition |
Complex Type RightTemplate
Type RightTemplateType
Value | Description |
---|---|
AssetContainer | |
Asset | |
DerivativeDefinition |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The id of the asset container. |
rightTemplateId | int | The id of a right template. |
isRightTemplateOverridden | boolean | If true, the right template is not used. |
userGroupAssetContainerRights | ArrayOfUserGroupAssetContainerRights | The list of UserGroupAssetContainerRights which defines the rights for each usergroup in the list. |
exceptedAssetContainerIds | ArrayOfint | A list of sub containers to be excluded (if IncludeSubAssetContainers is true ) |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
rightTemplateId | int |
The id of the right template. Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true). |
isAssetRightTemplateOverridden | boolean |
If true, the right template is not used and the individual right assignments are applied instead. If false, user groups in UserGroupAssetRights are ignored and can be set to null. |
assetIds | ArrayOfint | List of asset ids. |
userGroupAssetRights | ArrayOfUserGroupAssetRights | List<UserGroupAssetRights> |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
renderingJobId | int |
The rendering job id. Call CreateRenderingJob to get a renderingJobId. This allows several updates to be pooled to one job. |
derivativeUpdateOptions | DerivativeUpdateOptions | Complex data type containing multiple update parameters. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
rightTemplateId | int |
The id of the right template. Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true). |
isDerivativeRightTemplateOverridden | boolean |
If true, the right template is not used and the individual right assignments are applied instead. If false, user groups in UserGroupDerivativeRights are ignored and can be set to null. |
assetIds | ArrayOfint | List of asset ids. |
userGroupDerivativeRights | ArrayOfUserGroupDerivativeRights | List of datatype UserGroupDerivativeRights. |
Restricting anyType
Always empty.
Optional. If true, a search is done only within language specific metadata. Default: false.
Type boolean
Complex Type ExtendedAssetFilter
Type ExtendedAssetFilter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalSelectFields | ArrayOfstring |
Optional. A list of the names of additional fields to be returned, e.g. CreationDate, CreatedByUserId, Source .. By default only technical fields like AssetName, AssetDescription, FileSizeInBytes, FileExtensionId and technical image data etc. are returned, not the fields which contain the content meta data. AdditionalSelectFields = new List<string> { "Source", "CreationDate", "CreatedByUserId"}; |
BusinessProcessId | int | Optional. Not needed for integrators. |
BusinessProcessToken | string | Optional. Not needed for integrators. |
DesiredMetadataLanguage | ApplicationLanguage |
Optional. The language of the meta data to be returned. Picturepark allows meta data to be stored in several languages, e.g. in german, english, spanish and russian. DesiredMetadataLanguage = ApplicationLanguage.English |
ReturnAllLanguages | boolean | Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage. |
ReturnAllQueryAssetIds | boolean |
If true, a list of all asset ids in the query is returned in the AllQueryAssetIds property of the AssetItemCollection. These asset ids are not necessarily identical with the assets returned in the AssetItemCollection, e.g. due to the Limit parameter. |
AssetContainerSearchOperation | AssetContainerLogicalOperation |
Optional. Define from which asset containers to get assets. See the general API docu overview for further examples! // EXAMPLE: Get assets from asset container id 123 plus all sub-containers: |
AssetTypeIds | ArrayOfint |
Optional. List of the asset type ids for which the assets are returned, e.g. if you wish to get only pdfs and bitmap images. Asset types are e.g. "Unknown", "Bitmap", "VectorGraphic", "InterchangeDocument", "TextDocument" ... etc. Unlike media types they cannot be customized. Default: all AssetTypeIds = new List<int> {2, 6, 20} |
Limit | int | Optional. The maximal number of assets returned. Default is unlimited. |
MediaTypeIds | ArrayOfint |
Optional. List of the media type ids for which the assets are returned, e.g. if you wish to get only images and movies. Media types are customized sets of asset types, e.g. "Images", "Office" and "Multimedia". Default: all MediaTypeIds = new List<int> {1,4,3} |
ReturnMediaTypeCounts | boolean |
Optional. If true, MediaTypeCounts, an array with the numbers of all assets belonging to a certain media type, is returned. For performance reasons, this paramter should be set to false if not needed. Default: false |
SearchDesiredMetadataLanguageOnly | boolean | Optional. If true, a search is done only within language specific metadata. Default: false. |
SearchOnlyDeletedAssets | boolean | Optional. |
SearchOperation | LogicalOperation |
Optional. Define search parameters for a complex search. See the general API docu overview for further examples! See ComparisonOperation for available operators. // EXAMPLE: Get asset with AssetId 111: |
SimpleSearchString | string |
Optional. Use simple search, if you wish to search within all fields for a simple string.
|
SortInfos | ArrayOfSortInfo |
Sort parameters: the asset field and the direction (ascending or descending). This is the only required parameter! You may define several sort infos, e.g. AssetName asc, AssetId desc. List<SortInfo> sortInfos = new List<SortInfo>(); |
StartRow | int | Optional. The row in the query, from where on to return the assets. Default is 0. |
UnassignedAssetsOnly | boolean | Optional. If true, only assets which are in no category are returned. Default: false. |
VersionTypeIds | ArrayOfint |
Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions). This is not a filter for the assets, thus has no impact on the number of assets returned by the query. VersionTypeIds = new List<int> { 1, 3 } |
Complex Type FacetSearchParameter
Optional. Define search parameters for a complex search.
See the general API docu overview for further examples!
See ComparisonOperation for available operators.
// EXAMPLE: Get asset with AssetId 111:
.
List<ComparisonOperation> comparisonOperations = new List<ComparisonOperation>();
comparisonOperations.Add(new NumericEqualOperation()
. {FieldName = "AssetId", EqualNumeric = 111});
.
AndOperation searchOperation = new AndOperation()
. {ComparisonOperations = comparisonOperations};
.
ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
. SearchOperation = searchOperation,
. other parameters ..
}
Type LogicalOperation
Always empty.
Complex Type ExtendedAssetFilter
A list of FacetSearchParameter.
Type ArrayOfFacetSearchParameter
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetSearchParameter | FacetSearchParameter | |
Element GetFacets
Optional. If not empty, only asset containers with matching names and/or descriptions are returned.
Please note: there is always the complete line of parent nodes returned down to the matching nodes.
Type string
Element GetAssetContainers
Optional. A search string, e.g. "berg". Leave empty, if you wish to get all users.
Type string
Element GetUsers
The security token, which has been returned by GetSecurityToken.
Type string
Element LoginWithSecurityToken
The security token, which has been returned by GetSecurityToken.
Type string
Element LoginWithSecurityToken2
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetSelection | AssetSelection | |
Complex Type BusinessProcessShort
A list of FacetValue, can be null.
Type ArrayOfFacetValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetValue | FacetValue | |
Element GetFacets
Type FacetInnerSelectionBehavior
Value | Description |
---|---|
Or | |
And | |
ExclusiveOr |
Complex Type FacetConfigurationElement
Type FacetInnerSelectionBehavior
Value | Description |
---|---|
Or | |
And | |
ExclusiveOr |
Complex Type FacetResult
A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session.
Type string
Complex Type CoreInfo
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Type short
Optional. Use simple search, if you wish to search within all fields for a simple string.
ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
. SimpleSearchString = "Switzerland",
.
. other parameters
};
Type string
Complex Type ExtendedAssetFilter
Type SiteRight
Value | Description |
---|---|
List | |
Manage |
Complex Type ArrayOfSiteRight
Type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfSiteRightuUS27HWe | anyType (restriction) | |
Complex Type Rights
Optional. Available options: "SkinColor.Blue" and "SkinColor.Gray".
SkinColor? skin = SkinColor.Blue;
Type SkinColor
Value | Description |
---|---|
Gray | |
Blue | |
White |
Element CreateSession
Type Skin
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CanManage | boolean | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
CssSource | string | |
Deleted | boolean | |
HtmlSource | string | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Name | string | |
NamesOfMappedSitesWithSiteRightManage | ArrayOfstring | |
SkinId | int | |
TotalCountOfSiteMappings | int | |
ts | base64Binary | |
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Available options:Gray=0, Blue=1, White=2.
Type SkinColor
Value | Description |
---|---|
Gray | |
Blue | |
White |
Complex Type User
Type Skin
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
CanManage | boolean | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
CssSource | string | |
Deleted | boolean | |
HtmlSource | string | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Name | string | |
NamesOfMappedSitesWithSiteRightManage | ArrayOfstring | |
SkinId | int | |
TotalCountOfSiteMappings | int | |
ts | base64Binary | |
Type int
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Flag: sort child nodes alphabetically.
If true, child nodes are sorted alphabetically and sort order numbering is ignored.
Type boolean
Complex Type AssetContainerItem
Optional. The SortDirection (ascending or descending), default is ascending.
Type SortDirection
Value | Description |
---|---|
Asc | |
Desc |
Element GetUsers
Type SortDirection
Value | Description |
---|---|
Asc | |
Desc |
Complex Type SortInfo
Optional. A sortfield, e.g. "EmailAddress".
Type string
Element GetUsers
Type SortInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SortDirection | SortDirection | |
SortField | string | |
Complex Type ArrayOfSortInfo
Type SortInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SortDirection | SortDirection | |
SortField | string | |
Sort parameters: the asset field and the direction (ascending or descending).
This is the only required parameter!
You may define several sort infos, e.g. AssetName asc, AssetId desc.
List<SortInfo> sortInfos = new List<SortInfo>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });
Type ArrayOfSortInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SortInfo | SortInfo | |
Complex Type ExtendedAssetFilter
The relative sort order of siblings.
Type int
Complex Type AssetContainerItem
Type FieldValueSource
Value | Description |
---|---|
FieldValues | |
Assets | |
Derivatives | |
VideoStreams | |
AudioStreams | |
AssetClass | |
XmpMetadata |
Complex Type FieldValue
The id of the source asset container.
Type int
Element MoveAssetContainer
Optional. The row in the query, from where on to return the users. Default is 0.
Type int
Element GetUsers
Optional. The row in the query, from where on to return the assets. Default is 0.
Type int
Complex Type ExtendedAssetFilter
Type string
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
ContainsString | string | |
Type StringEmptyOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Type StringEqualOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualString | string | |
Type StringListContainsExactOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
ContainsExactStringList | ArrayOfstring | |
Type StringListContainsOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
ContainsStringList | ArrayOfstring | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
EqualStringList | ArrayOfstring | |
Type StringNotContainsOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
NotContainsString | string | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
NotEqualString | string | |
Type StringStartsWithOperation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldName | string | |
StartsWithString | string | |
Type string
Complex Type KnownFieldValue
Complex Type KnownFieldValueAssetContainerAssignment
Complex Type KnownFieldValueBoolean
Complex Type KnownFieldValueDateTime
Complex Type KnownFieldValueDouble
Complex Type KnownFieldValueInteger32
Complex Type KnownFieldValueInteger64
Complex Type KnownFieldValueString
Complex Type KnownFieldValueUserShort
The number of child nodes (children only, not grand children etc).
Type int
Complex Type AssetContainerItem
The id of the subscription action.
Type int
Element ConfirmSubscriptionInfoReceived
The id of the subscription action.
Type int
Element GetSubscriptionInfo
If a substitute user is submitted, all references to the deleted users will be replaced by the substitute.
E.g. the substitute will be registered as the new responsible user for all assets, for which the deleted users had been responsible before.
Type int
Element RemoveUsers
The asset's sub title in more detailed views.
Type string
Complex Type PortAssetItem
Type SuggestionSource
Value | Description |
---|---|
Default | |
Tokenized | |
None |
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Should the TagBox show the full path or only the Tag (AssetContainerName).
Type boolean
Complex Type FieldControlInfos
Optional. How to handle the temporary files.
Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.
TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile
Value | Description |
---|---|
KeepTemporaryFile | |
DeleteTemporaryFile | |
DeleteTemporaryFileAndContainingFolder |
Complex Type AssetUpdateOptions
Optional. How to handle the temporary files.
Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.
TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile
Value | Description |
---|---|
KeepTemporaryFile | |
DeleteTemporaryFile | |
DeleteTemporaryFileAndContainingFolder |
Complex Type DerivativeUpdateOptions
Value | Description |
---|---|
KeepTemporaryFile | |
DeleteTemporaryFile | |
DeleteTemporaryFileAndContainingFolder |
Type string
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
Type string
Complex Type FacetConfigurationExtended
Complex Type FacetConfigurationViewItem
The asset's title which is used all over the new port (in most cases it'll be the field AssetName).
Type string
Complex Type PortAssetItem
The number of assets in the query.
Please note: this figure is not necessarily identical with the number of AssetItems.
Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter.
Type int
Complex Type AssetItemCollection
The number of assets in the query.
Please note: this figure is not necessarily identical with the number of AssetItems.
Both figures may differ, if Limit and/or StartRow are greater 0 in ExtendedAssetFilter.
Type int
Complex Type PortAssetItemCollection
Number of layers (children, grand-children ..) to be returned. 1 = only the parentAssetContainerId is returned, 0 = all.
Type int
Element GetAssetContainers
The numbers of rows of a textarea.
Type int
Complex Type FieldControlInfos
TotalUsers is the number of rows in the query. If a limit is defined this figure may be higher than the number of records returned by the query.
Type int
Complex Type UserCollection
Optional. Only submit this parameter if the method call is part of a trace job. The traces within a trace job are pooled for special reporting capabilities.
To get a traceJobId, you must call the webservice CreateTraceJob, which is only available in the extended public webservices.
Needed for tracing purposes only.
Type int
Element CreateSession
Only submit this parameter if the method call is part of a trace job. The traces within a trace job are pooled for special reporting capabilities."
To get a traceJobId, you must call the webservice CreateTraceJob, which is only available in the extended public webservices.
Needed for tracing purposes only.
Type int
Element GetSecurityToken
Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.".
Needed for tracing purposes only.
Type int
Complex Type CoreInfo
The TraceJobType.
Type TraceJobType
Value | Description |
---|---|
AssetImport | |
AssetRepair | |
SubscriptionDispatch | |
AggregateTraffic | |
AggregateDiskspace | |
Workflow | |
PAS | |
ContentImport |
Element CreateTraceJob
Type TraceJobType
Value | Description |
---|---|
AssetImport | |
AssetRepair | |
SubscriptionDispatch | |
AggregateTraffic | |
AggregateDiskspace | |
Workflow | |
PAS | |
ContentImport |
The guid which has been returned by UploadFirstChunk
Type guid
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Element UploadChunk
The field data in the language of the current user.
Translation.Caption contains the field name in this language.
Type FieldTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AdditionalText | string | |
Caption | string | |
FieldId | int | |
FieldTranslationId | int | |
LanguageId | int | |
ToolTip | string | |
ts | base64Binary | |
Complex Type Field
Type ArrayOfAssetContainerTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTranslation | AssetContainerTranslation | Language specific data of one asset container. One item per asset container language. |
Complex Type AssetContainerAssignmentExtended
An array with the AssetContainerTranslations (names and descriptions) for each asset container language.
Type ArrayOfAssetContainerTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerTranslation | AssetContainerTranslation | Language specific data of one asset container. One item per asset container language. |
Complex Type AssetContainerItem
Type ArrayOfDerivativeDefinitionTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionTranslation | DerivativeDefinitionTranslation | |
Complex Type DerivativeDefinition
Used for configuration (read / save)
Type ArrayOfFacetConfigurationTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationTranslation | FacetConfigurationTranslation | |
Complex Type FacetConfigurationGroup
Used for configuration (read / save)
Type ArrayOfFacetConfigurationTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetConfigurationTranslation | FacetConfigurationTranslation | |
Complex Type FacetConfigurationRange
Currently not used.
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldTranslation | FieldTranslation | |
Complex Type Field
Type ArrayOfFieldOptionTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldOptionTranslation | FieldOptionTranslation | |
Complex Type FieldOption
Type ArrayOfUserGroupTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupTranslation | UserGroupTranslation | |
Complex Type UserGroupItem
Type PictureparkErrorType
Value | Description |
---|---|
UnknownError | Unknown error |
InvalidSession | Session not valid |
InsufficientRights | This user does not have the necessary rights for this action |
InsertFailure | Insert failed |
UpdateFailure | Update failed |
DeletionFailure | Delete failed |
FalseParameters | Wrong parameters |
FileNotFoundInsufficientRights | Either file not found or the user does not have the necessary access rights |
NotInDB | Not found in database |
UploadFailure | File upload failed |
TypeMismatch | Type mismatch |
FileNotFound | File not found |
IncompleteData | Data are incomplete or invalid |
InvalidEmail | Invalid email address |
EmptyString | Invalid value: empty string |
EmailAlreadyInUse | This email address has already been allocated |
PasswordNotFound | Authentication user with this password not found |
UnknownEmail | There is no active user with this email address |
UnknownSecurityToken | Security token not found |
UserIdIsZero | User id was 0 for security token user |
RenewalUnnecessary | Renewal failed: No renewal needed |
UnknownRenewalEmail | Renewal failed: User with this email address not found |
NoExpirationDate | Renewal failed: No expiration date set |
TimespanExpired | Renewal failed: Timespan for renewal has expired |
RenewalTooEarly | Renewal failed: Too early, renewal not yet possible |
IncompleteRenewalData | Renewal failed: Data are not complete |
InvalidContact | Renewal failed: Invalid email address of contact |
IdenticalPassword | Renewal failed: Old and new password are identical |
InvalidOldPassword | Renewal failed: There is no user account with this (old) password |
WeakRenewalPassword | Renewal failed: The new password is not strong enough |
UserNotFound | User with this email and password not found |
SecurityTokenUser | Login failed: User is a security token user |
DeletedUser | Login failed: User has been deleted (user state = 10) |
ExpiredUser | Login failed: User has expired (user state = 20) |
LockedUser | Login failed: User is locked (user state = 21) |
DisapprovedUser | Login failed: User has been disapproved (user state = 22) |
UnconfirmedUser | Login failed: Registration has not yet been confirmed by the user (user state = 30) |
UserUnapproved | Login failed: User is waitung for approval (user state = 40) |
InvalidState | Login failed: User state is invalid |
NoSubstituteUser | User not deleted: Substitute responsible user does not exist |
PasswordSent | Sending of passwords not allowed in this Picturepark |
InvalidPassword | This password is not valid |
WeakPassword_1 | This password is not strong enough |
InvalidDate | This expiration date is not a valid date |
DatePassed | This expiration date lies in the past |
CannotSetState | This user state cannot be set directly |
IdNotFound | User with this id not found |
UserPasswordNotFound | User with this password not found |
IdIsZero | Invalid user id 0 |
ProtectedAccount | This user account is protected |
ConfirmableUserNotFound | Confirmation of registration failed: user not found |
AlreadyConfirmed | Confirmation of registration failed: user has been confirmed already |
AlreadyApproved | Confirmation of registration failed: user has been approved already |
StateNot30 | Confirmation of registration failed: user state is not 30 |
ContactEmailInvalid | Registration failed: email address of internal contact is not a valid email address |
ActiveUserEmailUnknown | Registration failed: there is no active user with this email address |
NotInternalContact | Registration failed: this user is not an internal contact |
UserEmailUnknown | User with this email address not found |
LDAPPasswordChanged | LDAP login failed. Probably LDAP password has been changed |
GuestLogin | Login as guest failed |
SecurityTokenExpired | Security token has expired |
LDAPServerNotRunning | LDAP server not running |
RenewalExpiredUser | Renewal expired |
LinkedUserAccountNotFound | Linked user account with this email {0} and password not found |
SecurityTokenIpMismatch | Security token IP mismatch |
DeletingGuestUser | Guest user cannot be deleted |
DeletingCurrentUser | Current User cannot be deleted |
InvalidSenderEmail | Email address of sender is invalid |
InvalidRecipientsEmail | Email addresses of all recipients are invalid |
EmailNotSent | No email could be sent |
PartialSending | Some emails could be sent, some not |
OrderFilesLogin | In this Picturepark only logged in users can order files |
UnfoundOrder | Order not found |
UnfoundSubOrder | Sub order not found |
InvalidOrderState | This is not a valid order state |
InvalidSubOrderState | This is not a valid sub order state |
InvalidOrderManager | The order manager is not a valid Picturepark user |
CopyrightExists | This copyright already exists |
CopyrightDuplicateName | A copyright with this name already exists |
CopyrightNoID | A copyright with this id does not exist |
CopyrightDeletionFailure | This copyright is assigned to assets and therefore cannot be deleted |
KeywordNotFound | A keyword with this id does not exist |
IllegalAssetContainerMove | An asset container cannot be moved into itself |
ParentNotFound | Parent asset container not found |
EmptyDownloadArray | Array of download files is empty. Probably due to missing access rights and/or because the files do not exist |
DownloadNotCreated | The system could not create the download file |
BaseLanguageDeletionFailure | The base language PDF cannot be deleted |
PlaceholderNotFound | Placeholder not found |
InvalidURI | Invalid URI |
ExtensionMissingForPlaceholder | Extension missing for placeholder |
FileNotFoundInUploadDirectory | File not found in upload directory |
FileIsDuplicate | File is duplicate |
AssetNotFound | Asset not found |
DownloadTokenNotValid | The specified download token is not valid |
NotFilledOutCorrectly | One or more fields are invalid please verify your inputs. |
IndexRebuildThresholdExceeded | The specified download token is not valid |
RootLevelPropagation | The specified download token is not valid |
SessionExpired | The current customer hasn't been initialized with a language yet. Please initialize the according base class with a language first |
ContentTypeException | |
ExpiredVersion | The current version ({0}) has expired. The application cannot be executed anymore. Please download and install the new version from {1}. Closing this message box will automatically open that link in your browser |
NotYetActivatedVersion | The current version ({0}) is a pre-release and has not been activated yet. This version will be functional as soon as the Picturepark servers get the according upgrade |
UnknownPictureparkUrl | No Picturepark found at the specified URL (404). Please ensure you used the correct format for the URL: yourcompany.picturepark.com |
WrongPictureparkUrl | Please ensure you entered the URL with http(s) prefix: http(s)://yourcompany.picturepark.com |
ClearCacheTimeout | The cache could not have been cleared because some thumbnails are still in use by a background process. Please try again |
InvalidProxyAuthentication | Proxy authentication required (407). Please check your proxy settings |
InvalidLanguage | The selected language is not valid for this Picturepark instance |
UpdateByOtherUser | |
SessionExpiredEventFired | The SessionExpired event has been fired |
DuplicateAsset | Duplicate asset. Already processed an asset with the file name |
InvalidCropXValue | Invalid CropX value: |
InvalidCropYValue | Invalid CropY value: |
InvalidReplicationAssetContainer | Cannot use this asset container for replication because it conflicts with another enabled replication asset container. Please check the Replication Manager |
SiteNotFound | Publisher site could not be found |
InvalidMetadataMapping | Metadata mapping is invalid |
InvalidFieldValue | Field value is invalid |
InvalidAssetType | The asset type of the specified file is not valid for this action |
DuplicateAssetContainer | An asset container with the same absolute path already exists. Please adjust asset container naming |
DerivativeNotFound | Derivative not found. Please repair the asset and retry |
ClientNotFound | Client not found. Please provide a valid client guid |
DuplicateSkinName | Duplicate skin name found. Please provide a unique skin name |
DuplicateSiteName | Duplicate site name found. Please provide a unique site name |
FieldNotFound | No field found whose name matches the given string |
NoRightTemplateFound | No right template found for this file type |
Languages4IsReferencedInLanguage4Contents | Cannot remove this language\n because it is referenced in Languages4Contents.\n\n Please check the Languages4Contents first |
LanguageIsReferenced | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
AccessDenied | Access Denied |
ForeingKeyMissing | Cannot remove this imageEncodingOption\n because it is referenced in Derivatives.\n\n Please check Derivatives first |
LanguageIsReferencedContentLanguages4MetadataMapping | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInMetadataMappings | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInFieldValues | Cannot remove this language\n because it is referenced in Languages4UserInterfaces.\n\n Please check Languages4UserInterfaces first |
ReferencedInOrders | Cannot remove this delivery method\n because it is referenced in orders |
ReferencedInWorkflows | Cannot remove this field\n because it is referenced in workflows |
ReferencedInAssetVersion | Cannot remove this field\n because it is referenced in workflows |
FieldExists | Cannot remove this field\n because it is referenced in workflows |
ImageEncodingOptionIsReferenced | Cannot remove this imageEncodingOption\n because it is referenced in Derivatives.\n\n Please check Derivatives first |
NoLicenseKey | No license key installed. Please install a valid license key over the ManagementConsole |
InvalidLicenseKey | The current license key is not valid |
ExpiredLicenseKey | The current license is expired |
InsufficientLicense | The current license is insufficend to performe this action |
DuplicateLicenseKey | The current license is insufficend to performe this action |
InsufficentDiskSpaceOnTarget | Insufficient disk space on target server |
AbsoluteSqlServer2ServerExchangeDirectoryPathIsUndefined | AbsoluteSqlServer2ServerExchangeDirectoryPath is undefined |
AbsoluteInstanceImagePoolPathIsUndefined | AbsoluteInstanceImagePoolPath is undefined |
InstanceImageFileAlreadyExists | Instance image file already exists |
InstanceImageFileNotFound | Instance image file not found |
WrongFormatOfCustomerAbbreviation | Wrong format of customer abbreviation |
WrongFormatOfDatabaseName | Wrong format of database name |
ProhibitedDatabaseName | Prohibited database name |
CustomerIdAlreadyExists | Customer id already exists |
DatabaseAlreadyExists | The target database (Initial catalog) already exists on the server |
PublicFileDirectoryAlreadyExists | Public target file directory already exists |
ProtectedFileDirectoryAlreadyExists | Protected target file directory already exists |
InvalidFilenameForInstanceImageFile | Invalid filename for instance image (iso) file |
InstanceImageFileWithThisNameAlreadyExistsOnTargetServer | An instance image file with this name exists already on the target server |
InvalidVersionForInstanceImageFile | Invalid version of instance image (iso) file |
InconsistentImportData | Inconsistent import data |
DuplicateSearchServerNodeUrl | Duplicate search server node URL |
SearchServerNodeStillInUse | Node is still mapped to a customer |
MultiplePrimarySearchNode | Primary search node already exists |
NoPrimarySearchNode | Primary search node not exists |
MasterNodeDependencies | Primary search node has dependencies |
NoMasterNodeFound | No primary master search node found |
NoReplicationDocumentFound | No replication document found |
NoStaticIndexDefinitionFound | No static index definition found |
DefaultDatabaseNotSet | No 'DefaultDatabase' set for DocumentStore |
InstanceImageFileCannotBeOpened | Instance image file cannot be opened |
InstanceImageFileIsIncomplete | Invalid instance image file. Data is incomplete |
NoDatabaseFoundForSourcePicturepark | There is no database defined for the source Picturepark. |
Complex Type PictureparkFault
Optional. If true, only assets which are in no category are returned. Default: false.
Type boolean
Complex Type ExtendedAssetFilter
Type unsignedByte
Type unsignedInt
Type unsignedLong
Type unsignedShort
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The id of the asset container. |
assetContainerTranslations | ArrayOfAssetContainerTranslation | A list of AssetContainerTranslations with the language specific asset container names and descriptions. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetLinks | ArrayOfBusinessProcessShort | An array of BusinessProcessShort. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetId | int | The asset id |
fieldValues | ArrayOfFieldValue | A list of FieldValues. |
fieldValues2Remove | ArrayOfFieldValue | A list of field values to be deleted. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetFieldValues | ArrayOfAssetFieldValues | The list of AssetFieldValues to be updated. |
assetFieldValues2Remove | ArrayOfAssetFieldValues | The list of AssetFieldValues to be removed. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
assetContainerId | int | The asset container ID. |
fieldSetId | int | The field set ID to apply the new default value to. It can be obtained by calling GetFieldSetIdByFieldName |
defaultValues | ArrayOfFieldValue | The new default value. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
renderingJobId | int |
The rendering job id. Each update must be assigned to a rendering job. Call CreateRenderingJob first to get a renderingJobId. This allows several updates to be pooled to one job. |
assetUpdateOptions | AssetUpdateOptions | Complex data type containing multiple update parameters. |
Restricting anyType
Always empty.
If true, the action is recorded in the statistics table.
Type boolean
Element GetMetadata
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
userData | UserData | The (modified) UserData. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
transferGuid | guid | The guid which has been returned by UploadFirstChunk |
buffer | base64Binary | The buffer containing the chunk |
offset | long | The start index of the current chunk in the source/destination file. |
Restricting anyType
Always empty.
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
stream | StreamBody | A file stream |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UploadFileResult | guid | |
Type guid
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Element UploadFileResponse
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
coreInfo | CoreInfo | The CoreInfo object which has been returned by CreateSession. |
buffer | base64Binary | The buffer containing the first chunk. |
Restricting anyType
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UploadFirstChunkResult | guid | |
Type guid
Value must match the following pattern: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}
Element UploadFirstChunkResponse
E.g. "https//customer.picturepark.com/Website/default.aspx".
Type string
Complex Type HttpContextRequestInfo
E.g. "http://start-picturepark.vit.local/development/"
Type string
Complex Type HttpContextRequestInfo
The small thumbnail for preview in batch editor.
Type string
Complex Type AssetFieldValues
Any text, needed only for logging purposes.
Type string
Complex Type DownloadOptions
Session specific User data.
Type User
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DisplayName | string | First name plus last name |
string | ||
Language | ApplicationLanguage | The gui language for this user, which is stored in the user profile, e.g. "English". |
Language4ContentId | int |
The id of a content language. Language4Content is not a language, but a set of languages for specific purposes. Different languages can be assigned for content, metadata, asset containers and fulltext indexing. |
LoginStatus | LoginStatus | LoggedIn, NotLoggedIn or LoggedInAsGuest. |
Password | string | The password must be submitted for Login, but is never returned. |
Skin | SkinColor | Available options:Gray=0, Blue=1, White=2. |
UserGroups | ArrayOfint | Array of the ids of the assigned user groups. |
UserId | int | |
Complex Type CoreInfo
Type User
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DisplayName | string | First name plus last name |
string | ||
Language | ApplicationLanguage | The gui language for this user, which is stored in the user profile, e.g. "English". |
Language4ContentId | int |
The id of a content language. Language4Content is not a language, but a set of languages for specific purposes. Different languages can be assigned for content, metadata, asset containers and fulltext indexing. |
LoginStatus | LoginStatus | LoggedIn, NotLoggedIn or LoggedInAsGuest. |
Password | string | The password must be submitted for Login, but is never returned. |
Skin | SkinColor | Available options:Gray=0, Blue=1, White=2. |
UserGroups | ArrayOfint | Array of the ids of the assigned user groups. |
UserId | int | |
Needed for logging purposes. Must be one of DerivativeDownload, DerivativeView or AssetReplication.
Type UserAction
Value | Description |
---|---|
SuccessfulLogin | |
FailedLogin | |
AssetDetailView | |
DerivativeView | |
DerivativeDownload | |
DerivativeOrder | |
DerivativeMailing | |
AssetCreation | |
AssetMetadataModification | |
DerivativeModification | |
AssetDeletion | |
SimpleSearch | |
UserCreation | |
UserModification | |
UserDeletion | |
AssetReplication | |
DerivativeCreation | |
ContainerModification | |
AssetRightsModification | |
DerivativeRightsModification | |
ContainerRightsModification | |
AssetVersionsModification | |
ContainerAssignmentCreation | |
ContainerCreation | |
ContainerDeletion | |
ContainerMovement | |
RightTemplateCreation | |
RightTemplateModification | |
RightTemplatePropagation | |
RightTemplateDeletion | |
ContainerAssignmentDeletion | |
UserGroupCreation | |
UserGroupModification | |
UserGroupRightsModification | |
UserGroupDeletion | |
DerivativeOriginalUpdate | |
DerivativeCustomUpdate | |
ExtendedSearch | |
ReviewCreation | |
ReviewModification | |
ReviewDeletion | |
CommentCreation | |
CommentModification | |
CommentDeletion | |
CommentRating | |
MailingAssignmentCreation | |
MailingAssignmentDeletion | |
ManagedCuePoint | |
MailingModification | |
TermsAccepted |
Complex Type DownloadOptions
Type UserAction
Value | Description |
---|---|
SuccessfulLogin | |
FailedLogin | |
AssetDetailView | |
DerivativeView | |
DerivativeDownload | |
DerivativeOrder | |
DerivativeMailing | |
AssetCreation | |
AssetMetadataModification | |
DerivativeModification | |
AssetDeletion | |
SimpleSearch | |
UserCreation | |
UserModification | |
UserDeletion | |
AssetReplication | |
DerivativeCreation | |
ContainerModification | |
AssetRightsModification | |
DerivativeRightsModification | |
ContainerRightsModification | |
AssetVersionsModification | |
ContainerAssignmentCreation | |
ContainerCreation | |
ContainerDeletion | |
ContainerMovement | |
RightTemplateCreation | |
RightTemplateModification | |
RightTemplatePropagation | |
RightTemplateDeletion | |
ContainerAssignmentDeletion | |
UserGroupCreation | |
UserGroupModification | |
UserGroupRightsModification | |
UserGroupDeletion | |
DerivativeOriginalUpdate | |
DerivativeCustomUpdate | |
ExtendedSearch | |
ReviewCreation | |
ReviewModification | |
ReviewDeletion | |
CommentCreation | |
CommentModification | |
CommentDeletion | |
CommentRating | |
MailingAssignmentCreation | |
MailingAssignmentDeletion | |
ManagedCuePoint | |
MailingModification | |
TermsAccepted |
Complex Type UserActionHistoryInfo
Type UserAction
Value | Description |
---|---|
SuccessfulLogin | |
FailedLogin | |
AssetDetailView | |
DerivativeView | |
DerivativeDownload | |
DerivativeOrder | |
DerivativeMailing | |
AssetCreation | |
AssetMetadataModification | |
DerivativeModification | |
AssetDeletion | |
SimpleSearch | |
UserCreation | |
UserModification | |
UserDeletion | |
AssetReplication | |
DerivativeCreation | |
ContainerModification | |
AssetRightsModification | |
DerivativeRightsModification | |
ContainerRightsModification | |
AssetVersionsModification | |
ContainerAssignmentCreation | |
ContainerCreation | |
ContainerDeletion | |
ContainerMovement | |
RightTemplateCreation | |
RightTemplateModification | |
RightTemplatePropagation | |
RightTemplateDeletion | |
ContainerAssignmentDeletion | |
UserGroupCreation | |
UserGroupModification | |
UserGroupRightsModification | |
UserGroupDeletion | |
DerivativeOriginalUpdate | |
DerivativeCustomUpdate | |
ExtendedSearch | |
ReviewCreation | |
ReviewModification | |
ReviewDeletion | |
CommentCreation | |
CommentModification | |
CommentDeletion | |
CommentRating | |
MailingAssignmentCreation | |
MailingAssignmentDeletion | |
ManagedCuePoint | |
MailingModification | |
TermsAccepted |
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type UserActionHistoryInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
DerivativeDefinitionId | int | |
UrlThumbnailSmall | string | |
UserAction | UserAction | |
UserActionDate | DateTimeOffset | |
UserActionHistoryId | int | |
Complex Type ArrayOfUserActionHistoryInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
DerivativeDefinitionId | int | |
UrlThumbnailSmall | string | |
UserAction | UserAction | |
UserActionDate | DateTimeOffset | |
UserActionHistoryId | int | |
Type UserActionHistoryInfoCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
BatchGuid | string | |
TotalUserActionHistoryInfos | int | |
UserActionHistoryInfos | ArrayOfUserActionHistoryInfo | |
Type ArrayOfUserActionHistoryInfo
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserActionHistoryInfo | UserActionHistoryInfo | |
Complex Type UserActionHistoryInfoCollection
E.g. "Mozilla/5.0 (Windows NT 6.1; rv:2.0) Gecko/20100101 Firefox/4.0".
Type string
Complex Type HttpContextRequestInfo
Type UserCollection
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
TotalUsers | int | TotalUsers is the number of rows in the query. If a limit is defined this figure may be higher than the number of records returned by the query. |
Users | ArrayOfUserShort | An array of UserShort. |
Type UserCompact
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
EmailAddress | string | |
FirstName | string | |
LastName | string | |
UserId | int | |
UserData for the new user.
Type UserData
Contains elements as defined in the following table.
Element CreateUser
UserData for the user, who will later log in with the security token. Needed only if the PAS user does not yet exist, because in this case a new user account will be created for the PAS user.
Type UserData
Contains elements as defined in the following table.
Element GetSecurityToken
The (modified) UserData.
Type UserData
Contains elements as defined in the following table.
Element UpdateUser
Type UserData
Contains elements as defined in the following table.
Type UserDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRights | ArrayOfDerivativeDefinitionRights | |
UserGroup | UserGroupItem | |
Complex Type ArrayOfUserDerivativeRights
Type UserDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRights | ArrayOfDerivativeDefinitionRights | |
UserGroup | UserGroupItem | |
Type UserGroupItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroups | ArrayOfClaimGroup | |
IsDefault | boolean | |
IsGuestGroup | boolean | |
LdapSecurityGroups | ArrayOfLdapSecurityGroup | |
NeedsAllRights | boolean | |
NeedsAllUserRights | boolean | |
Translations | ArrayOfUserGroupTranslation | |
UserGroup | string | |
UserGroupId | int | |
ts | base64Binary | |
Complex Type UserDerivativeRights
Type UserGroupItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroups | ArrayOfClaimGroup | |
IsDefault | boolean | |
IsGuestGroup | boolean | |
LdapSecurityGroups | ArrayOfLdapSecurityGroup | |
NeedsAllRights | boolean | |
NeedsAllUserRights | boolean | |
Translations | ArrayOfUserGroupTranslation | |
UserGroup | string | |
UserGroupId | int | |
ts | base64Binary | |
Complex Type UserGroupAssetContainerRights
Type UserGroupItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroups | ArrayOfClaimGroup | |
IsDefault | boolean | |
IsGuestGroup | boolean | |
LdapSecurityGroups | ArrayOfLdapSecurityGroup | |
NeedsAllRights | boolean | |
NeedsAllUserRights | boolean | |
Translations | ArrayOfUserGroupTranslation | |
UserGroup | string | |
UserGroupId | int | |
ts | base64Binary | |
Complex Type UserGroupAssetRights
Type UserGroupItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroups | ArrayOfClaimGroup | |
IsDefault | boolean | |
IsGuestGroup | boolean | |
LdapSecurityGroups | ArrayOfLdapSecurityGroup | |
NeedsAllRights | boolean | |
NeedsAllUserRights | boolean | |
Translations | ArrayOfUserGroupTranslation | |
UserGroup | string | |
UserGroupId | int | |
ts | base64Binary | |
Complex Type UserGroupDerivativeRights
The list of UserGroupAssetContainerRights which defines the rights for each usergroup in the list.
Type ArrayOfUserGroupAssetContainerRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetContainerRights | UserGroupAssetContainerRights | |
Element SaveAssetContainerRights
Type UserGroupAssetContainerRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRights | ArrayOfAssetContainerRight | |
UserGroup | UserGroupItem | |
Complex Type ArrayOfUserGroupAssetContainerRights
Type UserGroupAssetContainerRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerRights | ArrayOfAssetContainerRight | |
UserGroup | UserGroupItem | |
List<UserGroupAssetRights>
Type ArrayOfUserGroupAssetRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetRights | UserGroupAssetRights | |
Element SaveAssetsRights
Type UserGroupAssetRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetRights | ArrayOfAssetRight | |
UserGroup | UserGroupItem | |
Complex Type ArrayOfUserGroupAssetRights
The assignment of certain rights for certain groups to this asset.
Needed only if IsAssetRightTemplateOverridden = true.
UserGroupItem userGroup3 = new UserGroupItem { UserGroupId = 3 };
UserGroupItem userGroup10 = new UserGroupItem { UserGroupId = 10 };
.
List<AssetRight> assetRights = new List<AssetRight>
{
. AssetRight.List,
. AssetRight.ManageDerivatives,
. AssetRight.ViewMetadata,
. AssetRight.ViewStatistics
};
.
List<UserGroupAssetRights> userGroupAssetRights = new List<UserGroupAssetRights>
{
. new UserGroupAssetRights{AssetRights = assetRights, UserGroup = userGroup10},
. new UserGroupAssetRights{AssetRights = assetRights, UserGroup = userGroup3}
};
.
UserGroupAssetRights = userGroupAssetRights
Type ArrayOfUserGroupAssetRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupAssetRights | UserGroupAssetRights | |
Complex Type AssetImportOptions
Type UserGroupAssetRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetRights | ArrayOfAssetRight | |
UserGroup | UserGroupItem | |
List of datatype UserGroupDerivativeRights.
Type ArrayOfUserGroupDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupDerivativeRights | UserGroupDerivativeRights | |
Element SaveDerivativeRights
Type UserGroupDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeRights | ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h | |
UserGroup | UserGroupItem | |
Complex Type ArrayOfUserGroupDerivativeRights
Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter.
Type ArrayOfUserGroupDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupDerivativeRights | UserGroupDerivativeRights | |
Complex Type AssetImportOptions
Type UserGroupDerivativeRights
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeRights | ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h | |
UserGroup | UserGroupItem | |
Optional. The id of a user group, if you wish to get only users from a certain group.
Type int
Element GetUsers
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type UserData
Type UserGroupItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
ClaimGroups | ArrayOfClaimGroup | |
IsDefault | boolean | |
IsGuestGroup | boolean | |
LdapSecurityGroups | ArrayOfLdapSecurityGroup | |
NeedsAllRights | boolean | |
NeedsAllUserRights | boolean | |
Translations | ArrayOfUserGroupTranslation | |
UserGroup | string | |
UserGroupId | int | |
ts | base64Binary | |
Type UserGroupRight
Value | Description |
---|---|
ViewUserGroup | |
EditUserGroup | |
DeleteUserGroup | |
ViewUserGroupRights | |
EditUserGroupRights | |
AssignUsers | |
EditUsers | |
ImpersonateUserGroup | |
ImpersonateUser |
Complex Type ArrayOfUserGroupRight
Type UserGroupRight
Value | Description |
---|---|
ViewUserGroup | |
EditUserGroup | |
DeleteUserGroup | |
ViewUserGroupRights | |
EditUserGroupRights | |
AssignUsers | |
EditUsers | |
ImpersonateUserGroup | |
ImpersonateUser |
Type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfUserGroupRightuUS27HWe | anyType (restriction) | |
Complex Type Rights
Array of the ids of the assigned user groups.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type User
Type UserGroupTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LanguageId | int | |
Name | string | |
UserGroupId | int | |
UserGroupTranslationId | int | |
ts | base64Binary | |
Complex Type ArrayOfUserGroupTranslation
Type UserGroupTranslation
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
LanguageId | int | |
Name | string | |
UserGroupId | int | |
UserGroupTranslationId | int | |
ts | base64Binary | |
The ip address of the user host.
Type string
Complex Type HttpContextRequestInfo
The DNS name of the user host.
Type string
Complex Type HttpContextRequestInfo
A list of user ids.
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Element RemoveUsers
Type UserRight
Value | Description |
---|---|
CreateUserGroups | |
EditRightsWithoutTemplate | |
CreateOrders | |
ViewAndEditAllOrders | |
EditOrderTypes | |
ViewAndEditOrderNotifications | |
CreateBusinessProcess | |
ViewAndEditAllBusinessProcesses | |
CreateMetadataExports | |
CreateAssets | |
DoBatchImport | |
ViewGlobalStatistics | |
ManageEmailSubscriptions | |
ManageAllSubscriptions | |
ViewAndEditMyAssets | |
ViewTraces | |
EditLanguageConfigurations | |
EditFieldDefinitions | |
RunWorkflows | |
EditSites | |
EditDerivativeDefinitions | |
EditCustomer | |
EditLdapConfigurations | |
EditCustomerHosts | |
EditFields | |
CreateRightTemplates | |
EditLanguages | |
EditTabs | |
EditLoginAndRegistration | |
EditIcons | |
CreatePublicSearches | |
ReorderContainingAssets | |
MetadataBatchUpdate | |
UseAssetConversion | |
EditAssetConversionPresets | |
EditWithoutAssetConversionPresets | |
ViewAndEditLicenseInformation | |
ViewAndEditStartPageFiles | |
ExecuteMaintenanceTasks | |
CreateReviews | |
ViewAndEditAllReviews | |
ManageDashboard | |
ViewDashboard | |
ManageAssetClasses | |
ManageExclusivityGroups | |
ManageExternalSystemSubscriptions | |
ManageWorkflowSubscriptions | |
UsePersonalSettings | |
UseSocialSharing | |
ViewRenderingStates | |
EditIdentityProviders |
Complex Type ArrayOfUserRight
Type UserRight
Value | Description |
---|---|
CreateUserGroups | |
EditRightsWithoutTemplate | |
CreateOrders | |
ViewAndEditAllOrders | |
EditOrderTypes | |
ViewAndEditOrderNotifications | |
CreateBusinessProcess | |
ViewAndEditAllBusinessProcesses | |
CreateMetadataExports | |
CreateAssets | |
DoBatchImport | |
ViewGlobalStatistics | |
ManageEmailSubscriptions | |
ManageAllSubscriptions | |
ViewAndEditMyAssets | |
ViewTraces | |
EditLanguageConfigurations | |
EditFieldDefinitions | |
RunWorkflows | |
EditSites | |
EditDerivativeDefinitions | |
EditCustomer | |
EditLdapConfigurations | |
EditCustomerHosts | |
EditFields | |
CreateRightTemplates | |
EditLanguages | |
EditTabs | |
EditLoginAndRegistration | |
EditIcons | |
CreatePublicSearches | |
ReorderContainingAssets | |
MetadataBatchUpdate | |
UseAssetConversion | |
EditAssetConversionPresets | |
EditWithoutAssetConversionPresets | |
ViewAndEditLicenseInformation | |
ViewAndEditStartPageFiles | |
ExecuteMaintenanceTasks | |
CreateReviews | |
ViewAndEditAllReviews | |
ManageDashboard | |
ViewDashboard | |
ManageAssetClasses | |
ManageExclusivityGroups | |
ManageExternalSystemSubscriptions | |
ManageWorkflowSubscriptions | |
UsePersonalSettings | |
UseSocialSharing | |
ViewRenderingStates | |
EditIdentityProviders |
Type ArrayOfUserRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserRight | UserRight | |
Complex Type Rights
An array of UserShort.
Type ArrayOfUserShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserShort | UserShort | |
Complex Type UserCollection
Type UserShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Address | string | |
AlternativeAddress | string | |
CanBeInternalContact | boolean | |
CanChangeOwnProfile | boolean | |
City | string | |
Comment | string | |
Company | string | |
CountryId | int | |
CountryTranslations | ArrayOfCountryTranslation | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Department | string | |
EmailAddress | string | |
ExpirationDate | DateTimeOffset | |
FieldValues | ArrayOfKnownFieldValue | |
FirstName | string | |
Guid4PasswordReset | string | |
InternalContactUserId | int | |
IsGuest | boolean | |
IsSupportContact | boolean | |
IsUpdaterServiceUser | boolean | |
LanguageId | int | |
LastActiveFacetConfigurationId | int | |
LastLoginDate | DateTimeOffset | |
LastName | string | |
LinkedGlobalUserId | int | |
LockDate | DateTimeOffset | |
LoginOnlyWithClaimsIdentity | boolean | |
LoginOnlyWithSecurityToken | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Phone | string | |
RegistrationStateId | RegistrationState | |
RenewalStateId | RenewalState | |
RenewalUntilDate | DateTimeOffset | |
RootSiteUrl | string | |
UseLdapAuthentication | boolean | |
UserId | int | |
Zip | string | |
ts | base64Binary | |
Complex Type ArrayOfUserShort
Type UserShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Address | string | |
AlternativeAddress | string | |
CanBeInternalContact | boolean | |
CanChangeOwnProfile | boolean | |
City | string | |
Comment | string | |
Company | string | |
CountryId | int | |
CountryTranslations | ArrayOfCountryTranslation | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Department | string | |
EmailAddress | string | |
ExpirationDate | DateTimeOffset | |
FieldValues | ArrayOfKnownFieldValue | |
FirstName | string | |
Guid4PasswordReset | string | |
InternalContactUserId | int | |
IsGuest | boolean | |
IsSupportContact | boolean | |
IsUpdaterServiceUser | boolean | |
LanguageId | int | |
LastActiveFacetConfigurationId | int | |
LastLoginDate | DateTimeOffset | |
LastName | string | |
LinkedGlobalUserId | int | |
LockDate | DateTimeOffset | |
LoginOnlyWithClaimsIdentity | boolean | |
LoginOnlyWithSecurityToken | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Phone | string | |
RegistrationStateId | RegistrationState | |
RenewalStateId | RenewalState | |
RenewalUntilDate | DateTimeOffset | |
RootSiteUrl | string | |
UseLdapAuthentication | boolean | |
UserId | int | |
Zip | string | |
ts | base64Binary | |
A regular expression used to check the input data, e.g. to enforce the input of an email address in a correct format.
Type string
Complex Type Field
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeRight | DerivativeRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetSelection | AssetSelection | |
Type ArrayOfDerivativeDefinitionRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DerivativeDefinitionRight | DerivativeDefinitionRight | |
Type ArrayOfFieldRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FieldRight | FieldRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
PersonalItemRight | PersonalItemRight | |
Type ArrayOfSiteRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
SiteRight | SiteRight | |
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
UserGroupRight | UserGroupRight | |
Type ArrayOfWidgetRight
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
WidgetRight | WidgetRight | |
Type PortViewField
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Caption | string | |
IsFullWidth | boolean | |
Position | int | |
Values | ArrayOfstring | |
Type AssetContainerAssignmentExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
FieldId | int | |
AssetContainerType | AssetContainerType | |
ExclusivityGroupId | int | |
FieldSetIds | ArrayOfint | |
IconId | int | |
Indexes | ArrayOfAssetContainerIndex | |
Translations | ArrayOfAssetContainerTranslation | |
Complex Type KnownFieldValueAssetContainerAssignment
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type KnownFieldValueDateTime
Type UserShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Address | string | |
AlternativeAddress | string | |
CanBeInternalContact | boolean | |
CanChangeOwnProfile | boolean | |
City | string | |
Comment | string | |
Company | string | |
CountryId | int | |
CountryTranslations | ArrayOfCountryTranslation | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Department | string | |
EmailAddress | string | |
ExpirationDate | DateTimeOffset | |
FieldValues | ArrayOfKnownFieldValue | |
FirstName | string | |
Guid4PasswordReset | string | |
InternalContactUserId | int | |
IsGuest | boolean | |
IsSupportContact | boolean | |
IsUpdaterServiceUser | boolean | |
LanguageId | int | |
LastActiveFacetConfigurationId | int | |
LastLoginDate | DateTimeOffset | |
LastName | string | |
LinkedGlobalUserId | int | |
LockDate | DateTimeOffset | |
LoginOnlyWithClaimsIdentity | boolean | |
LoginOnlyWithSecurityToken | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Phone | string | |
RegistrationStateId | RegistrationState | |
RenewalStateId | RenewalState | |
RenewalUntilDate | DateTimeOffset | |
RootSiteUrl | string | |
UseLdapAuthentication | boolean | |
UserId | int | |
Zip | string | |
ts | base64Binary | |
Complex Type KnownFieldValueUserShort
Type AssetContainerAssignmentExtended
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
AssetContainerId | int | |
AssetId | int | |
FieldId | int | |
AssetContainerType | AssetContainerType | |
ExclusivityGroupId | int | |
FieldSetIds | ArrayOfint | |
IconId | int | |
Indexes | ArrayOfAssetContainerIndex | |
Translations | ArrayOfAssetContainerTranslation | |
Complex Type FieldValue
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type FieldValue
Type DateTimeOffset
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
DateTime | dateTime | |
OffsetMinutes | short | |
Complex Type FieldValue
Type ArrayOfFacetValue
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
FacetValue | FacetValue | |
Complex Type FacetResult
Type ArrayOfstring
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
string | string | |
Complex Type PortViewField
Type UserShort
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Address | string | |
AlternativeAddress | string | |
CanBeInternalContact | boolean | |
CanChangeOwnProfile | boolean | |
City | string | |
Comment | string | |
Company | string | |
CountryId | int | |
CountryTranslations | ArrayOfCountryTranslation | |
CreatedByUserId | int | |
CreationDate | DateTimeOffset | |
Deleted | boolean | |
Department | string | |
EmailAddress | string | |
ExpirationDate | DateTimeOffset | |
FieldValues | ArrayOfKnownFieldValue | |
FirstName | string | |
Guid4PasswordReset | string | |
InternalContactUserId | int | |
IsGuest | boolean | |
IsSupportContact | boolean | |
IsUpdaterServiceUser | boolean | |
LanguageId | int | |
LastActiveFacetConfigurationId | int | |
LastLoginDate | DateTimeOffset | |
LastName | string | |
LinkedGlobalUserId | int | |
LockDate | DateTimeOffset | |
LoginOnlyWithClaimsIdentity | boolean | |
LoginOnlyWithSecurityToken | boolean | |
ModificationDate | DateTimeOffset | |
ModifiedByUserId | int | |
Phone | string | |
RegistrationStateId | RegistrationState | |
RenewalStateId | RenewalState | |
RenewalUntilDate | DateTimeOffset | |
RootSiteUrl | string | |
UseLdapAuthentication | boolean | |
UserId | int | |
Zip | string | |
ts | base64Binary | |
Complex Type FieldValue
The name of the version, e.g. "English" or "French".
Type string
Complex Type AssetVersion
Type Version
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
_Build | int | |
_Major | int | |
_Minor | int | |
_Revision | int | |
Versiontypes are e.g. Languages, History, Associated, Presentation etc.
They are individually configurable for each Picturepark. Language usually exists and has the id = 1.
Type int
Complex Type AssetVersion
Optional. Returns for each asset in the collection in addition to the other data the assigned versions (e.g. language versions).
This is not a filter for the assets, thus has no impact on the number of assets returned by the query.
VersionTypeIds = new List<int> { 1, 3 }
Type ArrayOfint
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
int | int | |
Complex Type ExtendedAssetFilter
Type duration
Value must match the following pattern: \-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?
The value must be greater than or equal to -P10675199DT2H48M5.4775808S.
The value must be less than or equal to P10675199DT2H48M5.4775807S.
Complex Type VideoStream
Type VideoStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
VideoBitRate | int | |
VideoCodec | string | |
VideoDisplayAspectRatio | string | |
VideoDuration | duration | |
VideoFormat | string | |
VideoFrameCount | int | |
VideoFrameRate | float | |
VideoHeight | int | |
VideoLanguage | string | |
VideoPixelAspectRatio | float | |
VideoResolution | int | |
VideoRotation | int | |
VideoStreamSize | long | |
VideoWidth | int | |
Complex Type ArrayOfVideoStream
Type VideoStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
VideoBitRate | int | |
VideoCodec | string | |
VideoDisplayAspectRatio | string | |
VideoDuration | duration | |
VideoFormat | string | |
VideoFrameCount | int | |
VideoFrameRate | float | |
VideoHeight | int | |
VideoLanguage | string | |
VideoPixelAspectRatio | float | |
VideoResolution | int | |
VideoRotation | int | |
VideoStreamSize | long | |
VideoWidth | int | |
Type ArrayOfVideoStream
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
VideoStream | VideoStream | |
Complex Type MediaInfo
Type WidgetRight
Value | Description |
---|---|
View | |
Manage | |
Reply | |
Rate |
Complex Type ArrayOfWidgetRight
Type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
KeyValueOfintArrayOfWidgetRightuUS27HWe | anyType (restriction) | |
Complex Type Rights
Type XmpItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Name | string | |
Value | string | |
children | ArrayOfXmpItem | |
expanded | boolean | |
leaf | boolean | |
Complex Type ArrayOfXmpItem
Type XmpItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
Name | string | |
Value | string | |
children | ArrayOfXmpItem | |
expanded | boolean | |
leaf | boolean | |
An array with XmpItems if the asset is an image and metadata mapping is enabled.
Type ArrayOfXmpItem
Contains elements as defined in the following table.
Component | Type | Description |
---|---|---|
XmpItem | XmpItem | |
Complex Type AssetMetadata
Technical flag concerning the rendering state.
Type boolean
Complex Type AssetItem
Technical flag concerning the rendering state.
Type boolean
Complex Type AssetItem