PPExtendedPublicService Web Service Reference

Table of Contents

Overview

Description

This document contains Web Service descriptions for the following services.

Web Services
Name  Description 
ExtendedPublicService 

ExtendedPublicService Web Service

Type

SOAP

Style

Document

See Also

Methods | Complex Types | Simple Types | Elements

Methods: ExtendedPublicService

Methods
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.

Method: AddAssets2AssetContainers

Description

Add (assign) assets to asset containers

Input (Literal)

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.
Output (Literal)

The output of this method is the document element AddAssets2AssetContainersResponse that is always empty.

Remarks

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.

Example

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);
            

Method: AddAssetVersions

Description

Add asset versions (currently: language version or slide)

Input (Literal)

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.

Output (Literal)

The output of this method is the document element AddAssetVersionsResponse that is always empty.

Remarks

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.

Example

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);
            

Method: ConfirmSubscriptionInfoReceived

Description

Call directly after successfully receiving data from GetSubscriptionInfo in order to delete the history.

Input (Literal)

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
Output (Literal)

A UserActionHistoryInfoCollection, which is a list of UserActionHistoryInfos for the subscriptionActionId

Example

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);
            

Method: CreateAssetContainer

Description

Create an asset container

Input (Literal)

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.
Output (Literal)

The id of the new asset container.

Element  Type  Description 
   
CreateAssetContainerResult  int 
Remarks

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.

Example

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);
            

Method: CreateAssetLink

Description

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.

Input (Literal)

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.
Output (Literal)

A BusinessProcessShort datatype.

Element  Type  Description 
   
CreateAssetLinkResult  BusinessProcessShort 
Example

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);
            

Method: CreateRenderingJob

Description

Creates a rendering job and returns the rendering job id, needed for some webservices like ImportSingleAsset and UpdateOriginalDerivative.

Input (Literal)

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.
Output (Literal)

The id of the rendering job.

Element  Type  Description 
   
CreateRenderingJobResult  int 
Example

CreateRenderingJob

// Create a rendering job of type "RenderingClient.Import".
            .
            RenderingClient renderingClient = RenderingClient.Import;
            int renderingJobId = PictureparkService.CreateRenderingJob(coreInfo, renderingClient);
            

Method: CreateSession

Description

Create a session

Input (Literal)

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.

Output (Literal)

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.
Example

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);
            

Method: CreateTraceJob

Description

Creates a trace job and returns the trace job id, sometimes needed for some webservices like CreateSession.

Input (Literal)

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.
Output (Literal)

The id of the trace job.

Element  Type  Description 
   
CreateTraceJobResult  int 
Example

CreateTraceJob

// Create a trace job of type TraceJobType.AssetImport.
            .
            TraceJobType traceJobType = TraceJobType.AssetImport;
            int traceJobId            = PictureparkService.CreateTraceJob(coreInfo, traceJobType);
            

Method: CreateUser

Description

Create a user

Input (Literal)

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.
Output (Literal)

The id of the new user.

Element  Type  Description 
   
CreateUserResult  int 
Remarks

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.

Example

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);
            

Method: DeleteAssetLinks

Description

Delete assetlinks

Input (Literal)

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.
Output (Literal)

The output of this method is the document element DeleteAssetLinksResponse that is always empty.

Example

DeleteAssetLinks

// Delete asset links with ids 1,2,3.
            .
            List<int> assetIds = new List<int>()  { 1, 2, 3 };
            PictureparkService.DeleteAssetLinks(coreInfo, assetIds);
            

Method: DeleteDerivative

Description

Delete a custom derivative (only custom derivatives may be deleted)

See SaveDerivative on how to upload / create a custom derivative.

Input (Literal)

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.
Output (Literal)

The output of this method is the document element DeleteDerivativeResponse that is always empty.

Example

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);
            

Method: Download

Description

Download a collection of assets as defined by assetSelection

Input (Literal)

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.
Output (Literal)

Returns a Download object.

Element  Type  Description 
   
DownloadResult  Download 
Remarks

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

Example

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);
            

Method: DownloadExtended

Description

Download a collection of assets with additional options

Input (Literal)

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.

Output (Literal)

Returns a data type Dictionary<Download, List<AssetSelection>>.

Element  Type  Description 
   
DownloadExtendedResult  ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK 
Example

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);
            

Method: GetAssetContainerRights

Description

Get access rights to asset containers for all user groups.

Input (Literal)

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.
Output (Literal)

A List<UserGroupAssetContainerRights>.

Element  Type  Description 
   
GetAssetContainerRightsResult  ArrayOfUserGroupAssetContainerRights 
Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the AssetContainerRight EditAssetContainerRights.

Example

GetAssetContainerRights

// Get asset container rights for asset container 1234.
            .
            int assetContainerId = 1234;
            List<UserGroupAssetContainerRights> userGroupAssetContainerRights = PictureparkService.GetAssetContainerRights(coreInfo, assetContainerId);
            

Method: GetAssetContainers

Description

Get a list of AssetContainerItems

Input (Literal)

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;
Output (Literal)

Returns a list of AssetContainerItems.

Element  Type  Description 
   
GetAssetContainersResult  ArrayOfAssetContainerItem 
Remarks

Exception AssetContainerTranslation for language {desiredAssetContainerLanguage} could not be found. is thrown if the submitted desiredAssetContainerLanguage is not found.

Example

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);
            

Method: GetAssetFields

Description

Get a list of all asset Field definitions.

Input (Literal)

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.
Output (Literal)

Returns a list of asset field definitions.

Element  Type  Description 
   
GetAssetFieldsResult  ArrayOfField 
Example

GetAssetFields


            List<Field> assetFields = PictureparkService.GetAssetFields(coreInfo);

Method: GetAssetLinksById

Description

Get a list of assetlinks

Input (Literal)

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.
Output (Literal)

A list of assetlinks, a BusinessProcessShort datatype.

Element  Type  Description 
   
GetAssetLinksByIdResult  ArrayOfBusinessProcessShort 
Example

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);
            

Method: GetAssetRights

Description

Get access rights to assets for all user groups.

Input (Literal)

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.
Output (Literal)

A List<UserGroupAssetRights>

Element  Type  Description 
   
GetAssetRightsResult  ArrayOfUserGroupAssetRights 
Example

GetAssetRights

// Get asset rights for asset 123.
            .
            int assetId = 123;
            List<UserGroupAssetRights> userGroupAssetRights = PictureparkService.GetAssetRights(coreInfo, assetId);
            

Method: GetAssets

Description

Get an AssetItemCollection as defined by extendedAssetFilter

Input (Literal)

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.
Output (Literal)

Returns an AssetItemCollection.

Element  Type  Description 
   
GetAssetsResult  AssetItemCollection 
Example

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);
            

Method: GetAssets2

Description

Get a collection of those PortAssetItems which match an active facet            

Input (Literal)

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 
Output (Literal)

A collection of asset items.

Element  Type  Description 
   
GetAssets2Result  PortAssetItemCollection 
Example

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);
            

Method: GetAssetsByIds

Description

Get an AssetItemCollection as defined by the array of asset ids

Input (Literal)

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.
Output (Literal)

Returns an AssetItemCollection.

Element  Type  Description 
   
GetAssetsByIdsResult  AssetItemCollection 
Example

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);
            

Method: GetAssetsMetadata

Description

Get a list of AssetFieldValues

See also similar webservice GetMetadata.

Input (Literal)

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.
Output (Literal)

Returns a list of AssetFieldValues.

Element  Type  Description 
   
GetAssetsMetadataResult  ArrayOfAssetFieldValues 
Example

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);
            

Method: GetAssetVersions

Description

Get asset AssetVersions

Input (Literal)

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.
Output (Literal)

A list of AssetVersions.

Element  Type  Description 
   
GetAssetVersionsResult  ArrayOfAssetVersion 
Example

GetAssetVersions

 // Get asset versions for asset 45
            .
            int assetId = 45;
            AssetFilter assetFilter = new AssetFilter();
            .
            List<AssetVersion> assetVersions = PictureparkService.GetAssetVersions(coreInfo, assetId, assetFilter);
            

Method: GetConfiguration

Description

Get the PublicConfiguration of the Picturepark

Input (Literal)

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.
Output (Literal)

The PublicConfiguration.

Element  Type  Description 
   
GetConfigurationResult  PublicConfiguration 
Example

GetConfiguration


            PublicConfiguration publicConfiguration = PictureparkService.GetConfiguration(coreInfo);
            

Method: GetConfigurationModificationDate

Description

Get the last modification date of the customer configuration

Input (Literal)

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.
Output (Literal)

DateTimeOffset configurationModificationDate.

Element  Type  Description 
   
GetConfigurationModificationDateResult  DateTimeOffset 
Example

GetConfigurationModificationDate


            System.DateTimeOffset configurationModificationDate = PictureparkService.GetConfigurationModificationDate(coreInfo);
            

Method: GetContentLanguages

Description

Get the list of Language4Content for this Picturepark

Input (Literal)

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.
Output (Literal)

A list of the content languages.

Element  Type  Description 
   
GetContentLanguagesResult  ArrayOfLanguage4Content 
Example

GetContentLanguages


            int customerId = 123;
            List<Language4Content> contentLanguages = PictureparkService.GetContentLanguages(customerId);
            

Method: GetDerivativeRights

Description

Get a list of UserDerivativeRights

Input (Literal)

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.
Output (Literal)

A List<UserDerivativeRights>

Element  Type  Description 
   
GetDerivativeRightsResult  ArrayOfUserDerivativeRights 
Remarks

PictureparkErrorType InsufficientRights: the user does not have the AssetRight ViewDerivativeRights.

Example

GetDerivativeRights

// Get rights to asset derivatives for asset 123.
            .
            int assetId = 123;
            List<UserDerivativeRights> userDerivativeRights = PictureparkService.GetDerivativeRights(coreInfo, assetId);
            

Method: GetDerivatives

Description

Get certain Derivatives for one or more assets

Input (Literal)

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.
Output (Literal)

A list of ExtendedDerivatives.

Element  Type  Description 
   
GetDerivativesResult  ArrayOfExtendedDerivative 
Example

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);
            

Method: GetFacetConfigurationExtended

Description

Get the FacetConfigurationExtended of a certain facet, usually needed for GetFacets and/or GetAssets2

Input (Literal)

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.
Output (Literal)

A facet configuration.

Element  Type  Description 
   
GetFacetConfigurationExtendedResult  FacetConfigurationExtended 
Example

GetFacetConfigurationExtended

// Get the facet configuration for "Facet2"
            string facetName = "Facet2";
            extendedFacetConfiguration = PictureparkService.GetFacetConfigurationExtended(coreInfo, facetName);
            

Method: GetFacets

Description

Get FacetResults, which contains the structure of the left panel in the new UI.

Input (Literal)

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.
Output (Literal)

Returns FacetResults

Element  Type  Description 
   
GetFacetsResult  FacetResults 
Example

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");
            

Method: GetFieldSetIdByFieldName

Description

Gets the field set ID that matches the field's name (case sensitive!).

Input (Literal)

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!).
Output (Literal)

The field set ID.

Element  Type  Description 
   
GetFieldSetIdByFieldNameResult  int 

Method: GetLanguageConfiguration

Description

Get the LanguageConfiguration for a user

Input (Literal)

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.
Output (Literal)

The language configuration for the currently logged in user.

Element  Type  Description 
   
GetLanguageConfigurationResult  LanguageConfiguration 
Example

GetLanguageConfiguration

// Get the language configuration for this Picturepark.
            .
            LanguageConfiguration languageConfiguration = PictureparkService.GetLanguageConfiguration(coreInfo);
            

Method: GetMetadata

Description

Get AssetMetadata of an asset

See also similar webservice GetAssetsMetadata.

Input (Literal)

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.
Output (Literal)

Returns the AssetMetadata for an asset.

Element  Type  Description 
   
GetMetadataResult  AssetMetadata  Represents the metadata of an asset.
Example

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);
            

Method: GetRights

Description

Get a collection of rights for the current user

The returned Rights contain:  DerivativeDefinitionRights, FieldRights, UserRights, UserGroupRights and RightTemplates.

Input (Literal)

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.
Output (Literal)

The rights for a user

Element  Type  Description 
   
GetRightsResult  Rights 
Example

GetRights

// Get a collection of all rights. 
            .
            Rights rights = PictureparkService.GetRights(coreInfo);
            

Method: GetSecurityToken

Description

Get a security token, which is needed for LoginWithSecurityToken

Input (Literal)

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.

Output (Literal)

Returns a security token, which is a guid, e.g. "59fa91c1-73ea-46f0-b2ae-76c0457c7b16".

Element  Type  Description 
   
GetSecurityTokenResult  string 
Remarks

             The email and password of the PAS authenticationUser are usually stored in a web.config file.            

Example

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);
            

Method: GetSubscriptionInfo

Description

Returns a list of UserActionHistoryInfo which is needed by the Event Subscription Service (ESS)

Input (Literal)

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.
Output (Literal)

A UserActionHistoryInfoCollection, which is a list of UserActionHistoryInfos for the subscriptionActionId

Element  Type  Description 
   
GetSubscriptionInfoResult  UserActionHistoryInfoCollection 
Example

GetSubscriptionInfo

// Get subscription infos
            int subscriptionActionId = 2;
            bool distinct            = true;
            .
            UserActionHistoryInfoCollection subscriptionInfo = PictureparkService.GetSubscriptionInfo(coreInfo, subscriptionActionId, distinct);
            

Method: GetTotalAssets

Input (Literal)

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 
Output (Literal)

The output of this method is the document element GetTotalAssetsResponse having the structure defined by the following table.

Element  Type  Description 
   
GetTotalAssetsResult  ArrayOfAssetContainerTotalAssets 

Method: GetUserById

Description

Get UserData for a user

Input (Literal)

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.
Output (Literal)

A UserData object.

Element  Type  Description 
   
GetUserByIdResult  UserData 
Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the UserGroupRight ViewUserGroup.

 This exception is also thrown, if the user does not exist.

Example

GetUserById

// Get user data for user 1234.
            .
            int userId = 1234;
            UserData userData = PictureparkService.GetUserById(coreInfo, userId);

Method: GetUsers

Description

Get a UserCollection

Input (Literal)

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.
Output (Literal)

UserCollection

Element  Type  Description 
   
GetUsersResult  UserCollection 
Example

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
            );
            

Method: ImportSingleAsset

Description

Import a single asset

Input (Literal)

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.

Output (Literal)

The id of the imported asset.

Element  Type  Description 
   
ImportSingleAssetResult  int 
Remarks

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.

Example

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);
            

Method: IsValid

Description

Check the validity of a session

Input (Literal)

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.
Output (Literal)

True or false

Element  Type  Description 
   
IsValidResult  boolean 
Example

IsValid

// Check validity of this session (includes session renewal).
            .
            bool isValid = PictureparkService.IsValid(coreInfo);
            

Method: Login

Description

Log in

Input (Literal)

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.
Output (Literal)

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.
Remarks

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.

Example

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);
            

Method: LoginWithSecurityToken

Description

Log in with a security token as a PAS (Picturepark Authentication Service) user

Input (Literal)

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.
Output (Literal)

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.
Remarks

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.

Example

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);

Method: LoginWithSecurityToken2

Description

Log in with a security token as a PAS (Picturepark Authentication Service) user

Input (Literal)

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).
Output (Literal)

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.
Remarks

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.

Example

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);

Method: MoveAssetContainer

Description

Move an asset container

Input (Literal)

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.

Output (Literal)

The output of this method is the document element MoveAssetContainerResponse that is always empty.

Remarks

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.

Example

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);
            

Method: RemoveAssetContainer

Description

Remove (delete) an asset container

Input (Literal)

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!

Output (Literal)

The output of this method is the document element RemoveAssetContainerResponse that is always empty.

Remarks

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.

Example

RemoveAssetContainer

// Delete asset container 1234 (does not delete assets in container).
            .
            int assetId = 1234;
            PictureparkService.RemoveAssetContainer(coreInfo, assetId);
            

Method: RemoveAssets

Description

Remove (delete) assets

Input (Literal)

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).

Output (Literal)

The output of this method is the document element RemoveAssetsResponse that is always empty.

Remarks

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).

Example

RemoveAssets

// Delete assets 111, 222 and 333.
            .
            List<int> assetIds         = new List<int> {111, 222, 333};
            bool deleteDependentAssets = false;
            .
            PictureparkService.RemoveAssets(coreInfo, assetIds, deleteDependentAssets);
            

Method: RemoveAssetsFromAssetContainers

Description

Remove (un-assign) assets from asset containers

Input (Literal)

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.
Output (Literal)

The output of this method is the document element RemoveAssetsFromAssetContainersResponse that is always empty.

Remarks

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.

Example

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);
            

Method: RemoveAssetVersions

Description

Remove asset versions (currently: language version or slide)

Input (Literal)

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.
Output (Literal)

The output of this method is the document element RemoveAssetVersionsResponse that is always empty.

Remarks

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.

Example

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);
            

Method: RemoveUsers

Description

Remove (delete) users

Input (Literal)

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.

Output (Literal)

The output of this method is the document element RemoveUsersResponse that is always empty.

Remarks

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.

Example

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);
            

Method: RenewSession

Description

Renew a session (prevent a timeout)

Input (Literal)

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.
Output (Literal)

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.
Example

RenewSession

// Renew this session (prevent timeout).
            .
            PictureparkService.RenewSession(coreInfo);
            

Method: SaveAssetContainerRights

Description

Save the access rights for an asset container

Input (Literal)

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 )
Output (Literal)

The output of this method is the document element SaveAssetContainerRightsResponse that is always empty.

Remarks

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.

Example

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);
            

Method: SaveAssetsRights

Description

Save (modify) asset rights

Input (Literal)

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>
Output (Literal)

The output of this method is the document element SaveAssetsRightsResponse that is always empty.

Example

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);
            

Method: SaveDerivative

Description

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.

Input (Literal)

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.
Output (Literal)

The output of this method is the document element SaveDerivativeResponse that is always empty.

Example

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);
            

Method: SaveDerivativeRights

Description

Save (modify) derivative rights

Input (Literal)

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.
Output (Literal)

The output of this method is the document element SaveDerivativeRightsResponse that is always empty.

Example

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);
            

Method: UpdateAssetContainer

Description

Update an asset container (modify names and descriptions)

Input (Literal)

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.
Output (Literal)

The output of this method is the document element UpdateAssetContainerResponse that is always empty.

Remarks

PictureparkErrorType InsufficientRights is thrown, if the user lacks the necessary rights.

 This exception is also thrown, if the assetContainerId does not exist.

Example

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);
            

Method: UpdateAssetLinks

Description

Update assetlinks

Input (Literal)

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.
Output (Literal)

The output of this method is the document element UpdateAssetLinksResponse that is always empty.

Example

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);
            

Method: UpdateAssetMetadata

Description

Update asset metadata

Input (Literal)

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.
Output (Literal)

The output of this method is the document element UpdateAssetMetadataResponse that is always empty.

Example

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);
            

Method: UpdateAssetsMetadata

Description

Update metadata of several assets (batch update)

Input (Literal)

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.
Output (Literal)

The output of this method is the document element UpdateAssetsMetadataResponse that is always empty.

Example

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);
            

Method: UpdateFieldSetDefaultValue

Description

Sets default value(s) for the provided asset container ID / field set ID combination.

Input (Literal)

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.
Output (Literal)

The output of this method is the document element UpdateFieldSetDefaultValueResponse that is always empty.

Example

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);
             

Method: UpdateOriginalDerivative

Description

Replace the original file of an asset

Input (Literal)

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.
Output (Literal)

The output of this method is the document element UpdateOriginalDerivativeResponse that is always empty.

Example

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);
            

Method: UpdateUser

Description

Update user data

Input (Literal)

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.
Output (Literal)

The output of this method is the document element UpdateUserResponse that is always empty.

Remarks

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.

Example

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);
            

Method: UploadChunk

Description

Upload file by chunks. Use this method to upload the remaining chunks following the first chunk uploaded by UploadFirstChunk.

Input (Literal)

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.
Output (Literal)

The output of this method is the document element UploadChunkResponse that is always empty.

Example

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;
             }
            }
            

Method: UploadFile

Description

Upload a file by streaming

Input (Literal)

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
Output (Literal)

The guid of the uploaded file, which must then be submitted to ImportSingleAsset.

Element  Type  Description 
   
UploadFileResult  guid 
Remarks

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.

Example

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);
            

Method: UploadFirstChunk

Description

Upload file by chunks. Use this method to upload the first chunk.

Input (Literal)

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.
Output (Literal)

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 
Example

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);
            

Complex Types: ExtendedPublicService

Complex Types
Name 
AndOperation 
ArrayOfAssetContainerAssignmentExtended 
ArrayOfAssetContainerComparisonOperation 
ArrayOfAssetContainerIndex 
ArrayOfAssetContainerItem 
ArrayOfAssetContainerLogicalOperation 
ArrayOfAssetContainerRight 
ArrayOfAssetContainerTotalAssets 
ArrayOfAssetContainerTranslation 
ArrayOfAssetFieldValues 
ArrayOfAssetItem 
ArrayOfAssetObject 
ArrayOfAssetRight 
ArrayOfAssetSelection 
ArrayOfAssetVersion 
ArrayOfAudioStream 
ArrayOfBusinessProcessLink 
ArrayOfBusinessProcessShort 
ArrayOfClaimGroup 
ArrayOfComparisonOperation 
ArrayOfCountry 
ArrayOfCountryTranslation 
ArrayOfDerivative 
ArrayOfDerivativeDefinition 
ArrayOfDerivativeDefinition2AssetType 
ArrayOfDerivativeDefinitionRight 
ArrayOfDerivativeDefinitionRights 
ArrayOfDerivativeDefinitionTranslation 
ArrayOfDerivativeRight 
ArrayOfDocument 
ArrayOfDocumentPage 
ArrayOfExtendedDerivative 
ArrayOfFacetConfigurationElement 
ArrayOfFacetConfigurationGroup 
ArrayOfFacetConfigurationRange 
ArrayOfFacetConfigurationTranslation 
ArrayOfFacetResult 
ArrayOfFacetSearchParameter 
ArrayOfFacetValue 
ArrayOfField 
ArrayOfFieldOption 
ArrayOfFieldOptionTranslation 
ArrayOfFieldRight 
ArrayOfFieldTranslation 
ArrayOfFieldValue 
ArrayOffloat 
ArrayOfint 
ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h 
ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK 
ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe 
ArrayOfKeyValueOfintPortViewField6jg_STziK 
ArrayOfKnownFieldValue 
ArrayOfLanguage4AssetContainer 
ArrayOfLanguage4Content 
ArrayOfLanguage4FullTextIndex 
ArrayOfLanguage4Metadata 
ArrayOfLanguage4UserInterface 
ArrayOfLanguage4Version 
ArrayOfLanguageFallback 
ArrayOfLdapSecurityGroup 
ArrayOfLogicalOperation 
ArrayOfMediaInfo 
ArrayOfMetadataProperty 
ArrayOfPersonalItemRight 
ArrayOfPortAssetItem 
ArrayOfPortDerivative 
ArrayOfRenderingActionArgumentValue 
ArrayOfRenderingActionValue 
ArrayOfRightTemplate 
ArrayOfRightTemplate2AssetType 
ArrayOfRightTemplate2Right 
ArrayOfRightTemplate2UserGroup 
ArrayOfSiteRight 
ArrayOfSortInfo 
ArrayOfstring 
ArrayOfUserActionHistoryInfo 
ArrayOfUserDerivativeRights 
ArrayOfUserGroupAssetContainerRights 
ArrayOfUserGroupAssetRights 
ArrayOfUserGroupDerivativeRights 
ArrayOfUserGroupRight 
ArrayOfUserGroupTranslation 
ArrayOfUserRight 
ArrayOfUserShort 
ArrayOfVideoStream 
ArrayOfWidgetRight 
ArrayOfXmpItem 
AssetContainerAndOperation 
AssetContainerAssignment 
AssetContainerAssignmentExtended 
AssetContainerComparisonOperation 
AssetContainerExcludeFieldOperation 
AssetContainerExcludeOperation 
AssetContainerIncludeFieldOperation 
AssetContainerIncludeOperation 
AssetContainerIndex 
AssetContainerItem 
AssetContainerLogicalOperation 
AssetContainerOrOperation 
AssetContainerTotalAssets 
AssetContainerTranslation 
AssetFieldValues 
AssetFilter 
AssetImportOptions 
AssetItem 
AssetItemCollection 
AssetMetadata 
AssetObject 
AssetSelection 
AssetUpdateOptions 
AssetVersion 
AudioStream 
BusinessProcessLink 
BusinessProcessShort 
ClaimGroup 
ComparisonOperation 
CoreInfo 
Country 
CountryTranslation 
DateTimeAfterOperation 
DateTimeBeforeOperation 
DateTimeBetweenOperation 
DateTimeEqualOperation 
DateTimeNowAfterOperation 
DateTimeNowAfterOrEqualOperation 
DateTimeNowBeforeOrEqualOperation 
DateTimeNowLastOperation 
DateTimeNowNextOperation 
DateTimeNowOlderOperation 
DateTimeOffset 
Derivative 
DerivativeDefinition 
DerivativeDefinition2AssetType 
DerivativeDefinitionRights 
DerivativeDefinitionTranslation 
DerivativeLock 
DerivativeUpdateOptions 
Document 
DocumentPage 
Download 
DownloadOptions 
ExtendedAssetFilter 
ExtendedDerivative 
FacetConfigurationElement 
FacetConfigurationExtended 
FacetConfigurationGroup 
FacetConfigurationJson 
FacetConfigurationRange 
FacetConfigurationTranslation 
FacetConfigurationViewItem 
FacetDateRange 
FacetResult 
FacetResults 
FacetSearchParameter 
FacetValue 
Field 
FieldControlInfos 
FieldOption 
FieldOptionTranslation 
FieldTranslation 
FieldValue 
HttpContextRequestInfo 
Impersonation 
KnownFieldValue 
KnownFieldValueAssetContainerAssignment 
KnownFieldValueBoolean 
KnownFieldValueDateTime 
KnownFieldValueDouble 
KnownFieldValueInteger32 
KnownFieldValueInteger64 
KnownFieldValueString 
KnownFieldValueUserShort 
Language 
Language4AssetContainer 
Language4Content 
Language4FullTextIndex 
Language4Metadata 
Language4UserInterface 
Language4Version 
LanguageConfiguration 
LanguageFallback 
LdapSecurityGroup 
LogicalOperation 
MediaInfo 
MetadataProperty 
MetadataSchema 
NumericBetweenOperation 
NumericEqualOperation 
NumericLargerThanOperation 
NumericListEqualOperation 
NumericNotEqualOperation 
NumericSmallerThanOperation 
OrOperation 
PictureparkFault 
PortAssetItem 
PortAssetItemCollection 
PortDerivative 
PortViewField 
PublicConfiguration 
RenderingActionArgumentValue 
RenderingActionValue 
Rights 
RightTemplate 
RightTemplate2AssetType 
RightTemplate2Right 
RightTemplate2UserGroup 
Skin 
SortInfo 
StringContainsOperation 
StringEmptyOperation 
StringEqualOperation 
StringListContainsExactOperation 
StringListContainsOperation 
StringListEqualOperation 
StringNotContainsOperation 
StringNotEmptyOperation 
StringNotEqualOperation 
StringStartsWithOperation 
User 
UserActionHistoryInfo 
UserActionHistoryInfoCollection 
UserCollection 
UserCompact 
UserData 
UserDerivativeRights 
UserGroupAssetContainerRights 
UserGroupAssetRights 
UserGroupDerivativeRights 
UserGroupItem 
UserGroupTranslation 
UserShort 
Version 
VideoStream 
XmpItem 

Complex Type: AndOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfComparisonOperation 
LogicalOperations  ArrayOfLogicalOperation 
Referenced By

Complex Type: ArrayOfAssetContainerAssignmentExtended

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerAssignmentExtended  AssetContainerAssignmentExtended 
Referenced By

Complex Type: ArrayOfAssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerComparisonOperation  AssetContainerComparisonOperation 
Referenced By

Complex Type: ArrayOfAssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerIndex  AssetContainerIndex 
Referenced By

Complex Type: ArrayOfAssetContainerItem

Content Model

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.
Referenced By

Complex Type: ArrayOfAssetContainerLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerLogicalOperation  AssetContainerLogicalOperation 
Referenced By

Complex Type: ArrayOfAssetContainerRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRight  AssetContainerRight 
Referenced By

Complex Type: ArrayOfAssetContainerTotalAssets

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerTotalAssets  AssetContainerTotalAssets 
Referenced By

Complex Type: ArrayOfAssetContainerTranslation

Content Model

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.
Referenced By

Complex Type: ArrayOfAssetFieldValues

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetFieldValues  AssetFieldValues 
Referenced By

Complex Type: ArrayOfAssetItem

Content Model

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.
Referenced By

Complex Type: ArrayOfAssetObject

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetObject  AssetObject 
Referenced By

Complex Type: ArrayOfAssetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRight  AssetRight 
Referenced By

Complex Type: ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 
Referenced By

Complex Type: ArrayOfAssetVersion

Content Model

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).

Referenced By

Complex Type: ArrayOfAudioStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AudioStream  AudioStream 
Referenced By

Complex Type: ArrayOfBusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessLink  BusinessProcessLink 
Referenced By

Complex Type: ArrayOfBusinessProcessShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessShort  BusinessProcessShort 
Referenced By

Complex Type: ArrayOfClaimGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ClaimGroup  ClaimGroup 
Referenced By

Complex Type: ArrayOfComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperation  ComparisonOperation 
Referenced By

Complex Type: ArrayOfCountry

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Country  Country 
Referenced By

Complex Type: ArrayOfCountryTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CountryTranslation  CountryTranslation 
Referenced By

Complex Type: ArrayOfDerivative

Content Model

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.
Referenced By

Complex Type: ArrayOfDerivativeDefinition

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinition  DerivativeDefinition 
Referenced By

Complex Type: ArrayOfDerivativeDefinition2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinition2AssetType  DerivativeDefinition2AssetType 
Referenced By

Complex Type: ArrayOfDerivativeDefinitionRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRight  DerivativeDefinitionRight 
Referenced By

Complex Type: ArrayOfDerivativeDefinitionRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  DerivativeDefinitionRights 
Referenced By

Complex Type: ArrayOfDerivativeDefinitionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionTranslation  DerivativeDefinitionTranslation 
Referenced By

Complex Type: ArrayOfDerivativeRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeRight  DerivativeRight 
Referenced By

Complex Type: ArrayOfDocument

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Document  Document 
Referenced By

Complex Type: ArrayOfDocumentPage

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DocumentPage  DocumentPage 
Referenced By

Complex Type: ArrayOfExtendedDerivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ExtendedDerivative  ExtendedDerivative  An extended derivative provides more detailed information than the usual derivative.
Referenced By

Complex Type: ArrayOfFacetConfigurationElement

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationElement  FacetConfigurationElement 
Referenced By

Complex Type: ArrayOfFacetConfigurationGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationGroup  FacetConfigurationGroup 
Referenced By

Complex Type: ArrayOfFacetConfigurationRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationRange  FacetConfigurationRange 
Referenced By

Complex Type: ArrayOfFacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationTranslation  FacetConfigurationTranslation 
Referenced By

Complex Type: ArrayOfFacetResult

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetResult  FacetResult 
Referenced By

Complex Type: ArrayOfFacetSearchParameter

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetSearchParameter  FacetSearchParameter 
Referenced By

Complex Type: ArrayOfFacetValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetValue  FacetValue 
Referenced By

Complex Type: ArrayOfField

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Field  Field  Defines the attributes of a Field (Asset-, User- or AssetContainerField)
Referenced By

Complex Type: ArrayOfFieldOption

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOption  FieldOption 
Referenced By

Complex Type: ArrayOfFieldOptionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOptionTranslation  FieldOptionTranslation 
Referenced By

Complex Type: ArrayOfFieldRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldRight  FieldRight 
Referenced By

Complex Type: ArrayOfFieldTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldTranslation  FieldTranslation 
Referenced By

Complex Type: ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Complex Type: ArrayOffloat

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
float  float 
Referenced By

Complex Type: ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Complex Type: ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfFieldRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfPersonalItemRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfSiteRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfUserGroupRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfWidgetRightuUS27HWe  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKeyValueOfintPortViewField6jg_STziK

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintPortViewField6jg_STziK  anyType (restriction) 
Referenced By

Complex Type: ArrayOfKnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KnownFieldValue  KnownFieldValue 
Referenced By

Complex Type: ArrayOfLanguage4AssetContainer

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4AssetContainer  Language4AssetContainer 
Referenced By

Complex Type: ArrayOfLanguage4Content

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Content  Language4Content 
Referenced By

Complex Type: ArrayOfLanguage4FullTextIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4FullTextIndex  Language4FullTextIndex 
Referenced By

Complex Type: ArrayOfLanguage4Metadata

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Metadata  Language4Metadata 
Referenced By

Complex Type: ArrayOfLanguage4UserInterface

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4UserInterface  Language4UserInterface 
Referenced By

Complex Type: ArrayOfLanguage4Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Version  Language4Version 
Referenced By

Complex Type: ArrayOfLanguageFallback

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LanguageFallback  LanguageFallback 
Referenced By

Complex Type: ArrayOfLdapSecurityGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LdapSecurityGroup  LdapSecurityGroup 
Referenced By

Complex Type: ArrayOfLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LogicalOperation  LogicalOperation 
Referenced By

Complex Type: ArrayOfMediaInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
MediaInfo  MediaInfo 
Referenced By

Complex Type: ArrayOfMetadataProperty

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
MetadataProperty  MetadataProperty 
Referenced By

Complex Type: ArrayOfPersonalItemRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
PersonalItemRight  PersonalItemRight 
Referenced By

Complex Type: ArrayOfPortAssetItem

Content Model

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
Referenced By

Complex Type: ArrayOfPortDerivative

Content Model

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.
Referenced By

Complex Type: ArrayOfRenderingActionArgumentValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionArgumentValue  RenderingActionArgumentValue 
Referenced By

Complex Type: ArrayOfRenderingActionValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionValue  RenderingActionValue 
Referenced By

Complex Type: ArrayOfRightTemplate

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate  RightTemplate 
Referenced By

Complex Type: ArrayOfRightTemplate2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2AssetType  RightTemplate2AssetType 
Referenced By

Complex Type: ArrayOfRightTemplate2Right

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2Right  RightTemplate2Right 
Referenced By

Complex Type: ArrayOfRightTemplate2UserGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2UserGroup  RightTemplate2UserGroup 
Referenced By

Complex Type: ArrayOfSiteRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SiteRight  SiteRight 
Referenced By

Complex Type: ArrayOfSortInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SortInfo  SortInfo 
Referenced By

Complex Type: ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Complex Type: ArrayOfUserActionHistoryInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserActionHistoryInfo  UserActionHistoryInfo 
Referenced By

Complex Type: ArrayOfUserDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserDerivativeRights  UserDerivativeRights 
Referenced By

Complex Type: ArrayOfUserGroupAssetContainerRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetContainerRights  UserGroupAssetContainerRights 
Referenced By

Complex Type: ArrayOfUserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetRights  UserGroupAssetRights 
Referenced By

Complex Type: ArrayOfUserGroupDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupDerivativeRights  UserGroupDerivativeRights 
Referenced By

Complex Type: ArrayOfUserGroupRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupRight  UserGroupRight 
Referenced By

Complex Type: ArrayOfUserGroupTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupTranslation  UserGroupTranslation 
Referenced By

Complex Type: ArrayOfUserRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserRight  UserRight 
Referenced By

Complex Type: ArrayOfUserShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserShort  UserShort 
Referenced By

Complex Type: ArrayOfVideoStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
VideoStream  VideoStream 
Referenced By

Complex Type: ArrayOfWidgetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
WidgetRight  WidgetRight 
Referenced By

Complex Type: ArrayOfXmpItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
XmpItem  XmpItem 
Referenced By

Complex Type: AssetContainerAndOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfAssetContainerComparisonOperation 
LogicalOperations  ArrayOfAssetContainerLogicalOperation 
Referenced By

Complex Type: AssetContainerAssignment

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
AssetId  int 
FieldId  int 
Referenced By

Complex Type: AssetContainerAssignmentExtended

Content Model

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 
Referenced By

Complex Type: AssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerExcludeFieldOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerExcludeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerIncludeFieldOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerIncludeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Complex Type: AssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AbsolutePathById  string 
AssetContainerIndexId  int 
LanguageId  int 
ts  base64Binary 
Referenced By

Complex Type: AssetContainerItem

Content Model

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 
Referenced By

Complex Type: AssetContainerLogicalOperation

Referenced By

Complex Type: AssetContainerOrOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfAssetContainerComparisonOperation 
LogicalOperations  ArrayOfAssetContainerLogicalOperation 
Referenced By

Complex Type: AssetContainerTotalAssets

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
TotalAssets  int 
Referenced By

Complex Type: AssetContainerTranslation

Content Model

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 
Referenced By

Complex Type: AssetFieldValues

Content Model

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.
Referenced By

Complex Type: AssetFilter

Content Model

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.

Referenced By

Complex Type: AssetImportOptions

Content Model

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).


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},
.  ..
};

FileName  string  The file name with extension, needed only for an upload by MTOM.
ImportGuid  guid 

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,

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.


ImportUrl = "http://picturepark.com/images/image1234.jpg"

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.


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

UserGroupDerivativeRights  ArrayOfUserGroupDerivativeRights  Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter.
Referenced By

Complex Type: AssetItem

Content Model

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.
Referenced By

Complex Type: AssetItemCollection

Content Model

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.

Referenced By

Complex Type: AssetMetadata

Content Model

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.
Referenced By

Complex Type: AssetObject

Content Model

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 
Referenced By

Complex Type: AssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
DerivativeDefinitionId  int 
Referenced By

Complex Type: AssetUpdateOptions

Content Model

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.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

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.


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,
. ..
};

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.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Referenced By

Complex Type: AssetVersion

Content Model

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 
Referenced By

Complex Type: AudioStream

Content Model

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 
Referenced By

Complex Type: BusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
BusinessProcessUrl  anyURI 
DerivativeDefinitionId  int 
Referenced By

Complex Type: BusinessProcessShort

Content Model

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 
Referenced By

Complex Type: ClaimGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GroupSid  string 
IdentityProviderId  int 
UserGroupId  int 
UserGroups2ClaimGroupId  int 
Referenced By

Complex Type: ComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Referenced By

Complex Type: CoreInfo

Content Model

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.
Referenced By

Complex Type: Country

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Code  string 
CountryId  int 
Name  string 
Referenced By

Complex Type: CountryTranslation

Content Model

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.

Referenced By

Complex Type: DateTimeAfterOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AfterDateTime  DateTimeOffset 
Referenced By

Complex Type: DateTimeBeforeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
BeforeDateTime  DateTimeOffset 
Referenced By

Complex Type: DateTimeBetweenOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AfterDateTime  DateTimeOffset 
BeforeDateTime  DateTimeOffset 
Referenced By

Complex Type: DateTimeEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualDateTime  DateTimeOffset 
Referenced By

Complex Type: DateTimeNowAfterOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowAfterOrEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowBeforeOrEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowLastOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowNextOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeNowOlderOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 
Referenced By

Complex Type: DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Complex Type: Derivative

Content Model

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 
Referenced By

Complex Type: DerivativeDefinition

Content Model

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 
Referenced By

Complex Type: DerivativeDefinition2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetTypeId  int 
DerivativeDefinition2AssetTypeId  int 
DerivativeDefinitionId  int 
ts  base64Binary 
Referenced By

Complex Type: DerivativeDefinitionRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionId  int 
DerivativeRights  ArrayOfDerivativeRight 
Referenced By

Complex Type: DerivativeDefinitionTranslation

Content Model

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 
Referenced By

Complex Type: DerivativeLock

Content Model

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 
Referenced By

Complex Type: DerivativeUpdateOptions

Content Model

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.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

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.


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,
};

TemporaryFileHandling  TemporaryFileHandling 

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Referenced By

Complex Type: Document

Content Model

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 
Referenced By

Complex Type: DocumentPage

Content Model

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 
Referenced By

Complex Type: Download

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AvailableUntilDate  DateTimeOffset 
DownloadFileName  string 
DownloadToken  string 
FileSize  long 
URL  string 
Referenced By

Complex Type: DownloadOptions

Content Model

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.
Referenced By

Complex Type: ExtendedAssetFilter

Content Model

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:
.
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 ..
}

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:
.
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 ..
}

SimpleSearchString  string 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

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>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });

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 }
Referenced By
Remarks

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 }
};

Complex Type: ExtendedDerivative

Content Model

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 
CreationDate  DateTimeOffset 
Deleted  boolean 
EpsHeightInPoints  double 
EpsIsRasterized  boolean 
EpsWidthInPoints  double 
ImageBitsPerChannel  int 
ImageBitsPerPixel  int 
ImageChannels  string 
ImageColorProfile  string 
ImageColorSpaceId  int 
ImageHasAdobeResourceData  boolean 
ImageHasAlpha  boolean 
ImageHasExifData  boolean 
ImageHasIptcData  boolean 
ImageHasXmpData  boolean 
ImageHeightInCm  double 
ImageHeightInInch  double 
ImageHorizontalResolution  double 
ImageIsExtended  boolean 
ImageIsIndexed  boolean 
ImagePixelFormat  string 
ImageTotalFrames  int 
ImageTotalUnspecifiedTiffExtraChannels  int 
ImageUncompressedSizeInBytes  long 
ImageVerticalResolution  double 
ImageWidthInCm  double 
ImageWidthInInch  double 
ModificationDate  DateTimeOffset 
Sha1Hash  string 
Referenced By

Complex Type: FacetConfigurationElement

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
IsInitiallyOpen  boolean 
Ranges  ArrayOfFacetConfigurationRange 
SelectionBehavior  FacetInnerSelectionBehavior 
SortOrder  int 
Referenced By

Complex Type: FacetConfigurationExtended

Content Model

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
Referenced By

Complex Type: FacetConfigurationGroup

Content Model

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)
Referenced By

Complex Type: FacetConfigurationJson

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Elements  ArrayOfFacetConfigurationElement 
Groups  ArrayOfFacetConfigurationGroup 
Referenced By

Complex Type: FacetConfigurationRange

Content Model

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)
Referenced By

Complex Type: FacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
LanguageId  int 
Referenced By

Complex Type: FacetConfigurationViewItem

Content Model

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 
Referenced By

Complex Type: FacetDateRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
From  string 
To  string 
Referenced By

Complex Type: FacetResult

Content Model

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 
Referenced By

Complex Type: FacetResults

Content Model

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)
Referenced By

Complex Type: FacetSearchParameter

Content Model

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
Referenced By

Complex Type: FacetValue

Content Model

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 
Referenced By

Complex Type: Field

Content Model

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.
Referenced By

Complex Type: FieldControlInfos

Content Model

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.
Referenced By

Complex Type: FieldOption

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
SortOrder  int 
Translations  ArrayOfFieldOptionTranslation 
ValueString  string 
ts  base64Binary 
Referenced By

Complex Type: FieldOptionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOptionId  int 
FieldOptionTranslationId  int 
LanguageId  int 
ValueString  string 
ts  base64Binary 
Referenced By

Complex Type: FieldTranslation

Content Model

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 
Referenced By

Complex Type: FieldValue

Content Model

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 
Referenced By

Complex Type: HttpContextRequestInfo

Content Model

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.
Referenced By

Complex Type: Impersonation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ImpersonatedEmailAddress  string 
ImpersonationId  int 
Referenced By

Complex Type: KnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Referenced By

Complex Type: KnownFieldValueAssetContainerAssignment

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  AssetContainerAssignmentExtended 
Referenced By

Complex Type: KnownFieldValueBoolean

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  boolean 
Referenced By

Complex Type: KnownFieldValueDateTime

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  DateTimeOffset 
Referenced By

Complex Type: KnownFieldValueDouble

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  double 
Referenced By

Complex Type: KnownFieldValueInteger32

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  int 
Referenced By

Complex Type: KnownFieldValueInteger64

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  long 
Referenced By

Complex Type: KnownFieldValueString

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
LanguageId  int 
Value  string 
Referenced By

Complex Type: KnownFieldValueUserShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  UserShort 
Referenced By

Complex Type: Language

Content Model

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 
Referenced By

Complex Type: Language4AssetContainer

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CopyLanguageId  int 
Language  Language 
Language4AssetContainerId  int 
LanguageId  int 
ts  base64Binary 
Referenced By

Complex Type: Language4Content

Content Model

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 
Referenced By

Complex Type: Language4FullTextIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CatalogLanguageId  int 
Language  Language 
Language4FullTextIndexId  int 
ts  base64Binary 
Referenced By

Complex Type: Language4Metadata

Content Model

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 
Referenced By

Complex Type: Language4UserInterface

Content Model

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 
Referenced By

Complex Type: Language4Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
IsFavorite  boolean 
Language  Language 
Language4VersionId  int 
LanguageId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Complex Type: LanguageConfiguration

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Languages4AssetContainers  ArrayOfLanguage4AssetContainer 
Languages4Contents  ArrayOfLanguage4Content 
Languages4FullTextIndexes  ArrayOfLanguage4FullTextIndex 
Languages4Metadata  ArrayOfLanguage4Metadata 
Languages4UserInterfaces  ArrayOfLanguage4UserInterface 
Languages4Version  ArrayOfLanguage4Version 
Referenced By

Complex Type: LanguageFallback

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FallbackLanguage  string 
FallbackLanguageId  int 
Language4MetadataId  int 
LanguageFallbackId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Complex Type: LdapSecurityGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SecurityGroupDistinguishedName  string 
UserGroup2LdapSecurityGroupId  int 
UserGroupId  int 
ts  base64Binary 
Referenced By

Complex Type: LogicalOperation

Referenced By

Complex Type: MediaInfo

Content Model

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 
Referenced By

Complex Type: MetadataProperty

Content Model

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 
Referenced By

Complex Type: MetadataSchema

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
MetadataSchemaId  int 
Schema  string 
ts  base64Binary 
Referenced By

Complex Type: NumericBetweenOperation

Content Model

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 
Referenced By

Complex Type: NumericEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualNumeric  float 
Referenced By

Complex Type: NumericLargerThanOperation

Content Model

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 
Referenced By

Complex Type: NumericListEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualNumericList  ArrayOffloat 
Referenced By

Complex Type: NumericNotEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotEqualNumeric  float 
Referenced By

Complex Type: NumericSmallerThanOperation

Content Model

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 
Referenced By

Complex Type: OrOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfComparisonOperation 
LogicalOperations  ArrayOfLogicalOperation 
Referenced By

Complex Type: PictureparkFault

Content Model

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

Referenced By

Complex Type: PortAssetItem

Content Model

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).
Referenced By

Complex Type: PortAssetItemCollection

Content Model

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.

Referenced By

Complex Type: PortDerivative

Content Model

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 
Referenced By

Complex Type: PortViewField

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
IsFullWidth  boolean 
Position  int 
Values  ArrayOfstring 
Referenced By

Complex Type: PublicConfiguration

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Countries  ArrayOfCountry 
DerivativeDefinitions  ArrayOfDerivativeDefinition 
PictureparkVersion  Version 
Referenced By

Complex Type: RenderingActionArgumentValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionArgumentId  int 
RenderingActionArgumentValueId  int 
RenderingActionValueId  int 
Value  string 
ts  base64Binary 
Referenced By

Complex Type: RenderingActionValue

Content Model

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 
Referenced By

Complex Type: Rights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe 
FieldRights  ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe 
HasPPMCRights  boolean 
PersonalItemRights  ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe 
RightTemplates  ArrayOfRightTemplate 
SiteRights  ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe 
UserGroupRights  ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe 
UserRights  ArrayOfUserRight 
WidgetRights  ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe 
Referenced By

Complex Type: RightTemplate

Content Model

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 
Referenced By

Complex Type: RightTemplate2AssetType

Content Model

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 
Referenced By

Complex Type: RightTemplate2Right

Content Model

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 
Referenced By

Complex Type: RightTemplate2UserGroup

Content Model

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 
Referenced By

Complex Type: Skin

Content Model

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 
Referenced By

Complex Type: SortInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SortDirection  SortDirection 
SortField  string 
Referenced By

Complex Type: StringContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
ContainsString  string 
Referenced By

Complex Type: StringEmptyOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Referenced By

Complex Type: StringEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualString  string 
Referenced By

Complex Type: StringListContainsExactOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
ContainsExactStringList  ArrayOfstring 
Referenced By

Complex Type: StringListContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
ContainsStringList  ArrayOfstring 
Referenced By

Complex Type: StringListEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualStringList  ArrayOfstring 
Referenced By

Complex Type: StringNotContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotContainsString  string 
Referenced By

Complex Type: StringNotEmptyOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Referenced By

Complex Type: StringNotEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotEqualString  string 
Referenced By

Complex Type: StringStartsWithOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
StartsWithString  string 
Referenced By

Complex Type: User

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DisplayName  string  First name plus last name
Email  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 
Referenced By

Complex Type: UserActionHistoryInfo

Content Model

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 
Referenced By

Complex Type: UserActionHistoryInfoCollection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BatchGuid  string 
TotalUserActionHistoryInfos  int 
UserActionHistoryInfos  ArrayOfUserActionHistoryInfo 
Referenced By

Complex Type: UserCollection

Content Model

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.
Referenced By

Complex Type: UserCompact

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
EmailAddress  string 
FirstName  string 
LastName  string 
UserId  int 
Referenced By

Complex Type: UserData

Content Model

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 
Country  Country 
CountryId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Department  string 
EmailAddress  string 
ExpirationDate  DateTimeOffset 
FieldValues  ArrayOfFieldValue 
FirstName  string 
Guid4PasswordReset  string 
HasTermsAccepted  boolean 
Impersonation  Impersonation 
InternalContactUserId  int 
IsGuest  boolean 
IsSupport  boolean 
IsSupportContact  boolean 
IsUpdaterServiceUser  boolean 
LanguageId  int 
LastActiveFacetConfigurationId  int 
LastLoginDate  DateTimeOffset 
LastName  string 
LockDate  DateTimeOffset 
LoginOnlyWithClaimsIdentity  boolean 
LoginOnlyWithSecurityToken  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Phone  string 
RegistrationState  RegistrationState 
RenewalState  RenewalState 
RenewalUntilDate  DateTimeOffset 
SiteId  int 
UseLdapAuthentication  boolean 
UserGroupIds  ArrayOfint 
UserId  int 
Zip  string 
ts  base64Binary 
Referenced By

Complex Type: UserDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  ArrayOfDerivativeDefinitionRights 
UserGroup  UserGroupItem 
Referenced By

Complex Type: UserGroupAssetContainerRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRights  ArrayOfAssetContainerRight 
UserGroup  UserGroupItem 
Referenced By

Complex Type: UserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRights  ArrayOfAssetRight 
UserGroup  UserGroupItem 
Referenced By

Complex Type: UserGroupDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeRights  ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h 
UserGroup  UserGroupItem 
Referenced By

Complex Type: UserGroupItem

Content Model

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 
Referenced By

Complex Type: UserGroupTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LanguageId  int 
Name  string 
UserGroupId  int 
UserGroupTranslationId  int 
ts  base64Binary 
Referenced By

Complex Type: UserShort

Content Model

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 
Referenced By

Complex Type: Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
_Build  int 
_Major  int 
_Minor  int 
_Revision  int 
Referenced By

Complex Type: VideoStream

Content Model

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 
Referenced By

Complex Type: XmpItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Name  string 
Value  string 
children  ArrayOfXmpItem 
expanded  boolean 
leaf  boolean 
Referenced By

Simple Types: ExtendedPublicService

Simple Types
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 

Simple Type: ApplicationLanguage

Description

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

Derived By

Restricting string

Enumeration
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 
Referenced By

Simple Type: AssetContainerRight

Derived By

Restricting string

Enumeration
Value  Description 
List 
ViewContent 
Rename 
Delete 
AssignAssets 
CreateSubContainer 
Move 
ReorderContainer 
EditAssetContainerRights 
ViewAssetContainerRights 
Referenced By

Simple Type: AssetContainerType

Derived By

Restricting string

Enumeration
Value  Description 
Category 
AssetClass 
Referenced By

Simple Type: AssetObjectType

Derived By

Restricting string

Enumeration
Value  Description 
LinkedAsset 
LinkedUrl 
Rectangle 
Text 
Arrow 
Referenced By

Simple Type: AssetRight

Derived By

Restricting string

Enumeration
Value  Description 
List 
ViewMetadata 
EditMetadata 
Delete 
ManageDerivatives 
ViewRights 
EditRights 
EditContainerAssignments 
ViewVersions 
EditVersions 
ViewStatistics 
ViewJournal 
ViewEmbeddedMetadata 
Referenced By

Simple Type: AssetType

Derived By

Restricting string

Enumeration
Value  Description 
Unknown 
Bitmap 
VectorGraphic 
RawImage 
InterchangeDocument 
WordProcessingDocument 
TextDocument 
DesktopPublishingDocument 
Presentation 
Spreadsheet 
Archive 
Audio 
Video 
Font 
Multimedia 
Application 
SourceCode 
Database 
Cad 
Model3d 
Referenced By

Simple Type: BitrateMode

Derived By

Restricting string

Enumeration
Value  Description 
Variable 
Constant 
Referenced By

Simple Type: BusinessProcessType

Derived By

Restricting string

Enumeration
Value  Description 
AssetMailing 
AssetReview 
AssetLink 
AssetPublishing 
Referenced By

Simple Type: char

Derived By

Restricting int

Referenced By

Simple Type: ComparisonOperationType

Derived By

Restricting string

Enumeration
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 
Referenced By

Simple Type: ControlType

Derived By

Restricting string

Enumeration
Value  Description 
ComboBox 
DateField 
DateTimeField 
Checkbox 
MultiCheckbox 
RadioButton 
TextField 
TextArea 
Label 
NumberField 
Password 
InternalContactEmailField 
ComboBox4Users 
TagBox 
Referenced By

Simple Type: DataType

Derived By

Restricting string

Enumeration
Value  Description 
Integer32 
Integer64 
String 
Date 
DateTime 
Boolean 
Double 
AlphaHandling 
BlurType 
FlipType 
NullableInteger32 
Float 
UserShort 
NullableDouble 
Color 
AssetContainerAssignment 
Referenced By

Simple Type: DerivativeDefinitionRight

Derived By

Restricting string

Enumeration
Value  Description 
CanBeOrdered 
Referenced By

Simple Type: DerivativeRight

Derived By

Restricting string

Enumeration
Value  Description 
Download 
Referenced By

Simple Type: DerivativeType

Derived By

Restricting string

Enumeration
Value  Description 
Original 
Static 
Dynamic 
ThumbnailSmall 
ThumbnailMedium 
ThumbnailLarge 
Custom 
Referenced By

Simple Type: duration

Derived By

Restricting duration

Restrictions
Referenced By

Simple Type: FacetInnerSelectionBehavior

Derived By

Restricting string

Enumeration
Value  Description 
Or 
And 
ExclusiveOr 
Referenced By

Simple Type: FieldLookupEntity

Derived By

Restricting string

Enumeration
Value  Description 
FieldValues 
Assets 
Derivatives 
Users 
Orders 
ClientOnly 
Assets2AssetContainers 
VideoStreams 
AudioStreams 
Referenced By

Simple Type: FieldOptionsLookupEntity

Derived By

Restricting string

Enumeration
Value  Description 
Languages4UserInterfaces 
Countries 
Users 
AssetRightTemplates 
DerivativeRightTemplates 
Sites 
Referenced By

Simple Type: FieldRight

Derived By

Restricting string

Enumeration
Value  Description 
ViewFieldValues 
EditFieldValues 
EditFieldOptions 
Referenced By

Simple Type: FieldType

Derived By

Restricting string

Enumeration
Value  Description 
AssetField 
UserField 
AssetContainerField 
Referenced By

Simple Type: FieldValueSource

Derived By

Restricting string

Enumeration
Value  Description 
FieldValues 
Assets 
Derivatives 
VideoStreams 
AudioStreams 
AssetClass 
XmpMetadata 
Referenced By

Simple Type: guid

Derived By

Restricting string

Restrictions
Referenced By

Simple Type: LoginStatus

Derived By

Restricting string

Enumeration
Value  Description 
NotLoggedIn 
LoggedInAsGuest 
LoggedIn 
Referenced By

Simple Type: PersonalItemRight

Derived By

Restricting string

Enumeration
Value  Description 
View 
Edit 
Referenced By

Simple Type: PictureparkErrorType

Description

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

Derived By

Restricting string

Enumeration
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.
Referenced By

Simple Type: RegistrationState

Derived By

Restricting string

Enumeration
Value  Description 
Waiting4EmailAuthentication 
Waiting4ConfirmationByAdmin 
Waiting4ConfirmationByContact 
RejectedByAdmin 
RejectedByContact 
Referenced By

Simple Type: RenderingClient

Derived By

Restricting string

Enumeration
Value  Description 
Import 
Update 
Repair 
Editor 
Referenced By

Simple Type: RenderingState

Derived By

Restricting string

Enumeration
Value  Description 
Pending 
Completed 
Failed 
Referenced By

Simple Type: RenewalState

Derived By

Restricting string

Enumeration
Value  Description 
Waiting4RenewalByAdmin 
Waiting4RenewalByContact 
RejectedByAdmin 
RejectedByContact 
Referenced By

Simple Type: RightTemplateRight

Derived By

Restricting string

Enumeration
Value  Description 
View 
Edit 
Apply 
Referenced By

Simple Type: RightTemplateType

Derived By

Restricting string

Enumeration
Value  Description 
AssetContainer 
Asset 
DerivativeDefinition 
Referenced By

Simple Type: SiteRight

Derived By

Restricting string

Enumeration
Value  Description 
List 
Manage 
Referenced By

Simple Type: SkinColor

Description

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

Derived By

Restricting string

Enumeration
Value  Description 
Gray 
Blue 
White 
Referenced By

Simple Type: SortDirection

Derived By

Restricting string

Enumeration
Value  Description 
Asc 
Desc 
Referenced By

Simple Type: StreamBody

Derived By

Restricting base64Binary

Referenced By

Simple Type: SuggestionSource

Derived By

Restricting string

Enumeration
Value  Description 
Default 
Tokenized 
None 
Referenced By

Simple Type: TemporaryFileHandling

Derived By

Restricting string

Enumeration
Value  Description 
KeepTemporaryFile 
DeleteTemporaryFile 
DeleteTemporaryFileAndContainingFolder 
Referenced By

Simple Type: TraceJobType

Derived By

Restricting string

Enumeration
Value  Description 
AssetImport 
AssetRepair 
SubscriptionDispatch 
AggregateTraffic 
AggregateDiskspace 
Workflow 
PAS 
ContentImport 
Referenced By

Simple Type: UserAction

Derived By

Restricting string

Enumeration
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 
Referenced By

Simple Type: UserGroupRight

Derived By

Restricting string

Enumeration
Value  Description 
ViewUserGroup 
EditUserGroup 
DeleteUserGroup 
ViewUserGroupRights 
EditUserGroupRights 
AssignUsers 
EditUsers 
ImpersonateUserGroup 
ImpersonateUser 
Referenced By

Simple Type: UserRight

Derived By

Restricting string

Enumeration
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 
Referenced By

Simple Type: WidgetRight

Derived By

Restricting string

Enumeration
Value  Description 
View 
Manage 
Reply 
Rate 
Referenced By

Elements: ExtendedPublicService

Elements
Name  Description 
_Build [type Version] 
_Major [type Version] 
_Minor [type Version] 
_Revision [type Version] 
Abbreviation [type Language] 
AbbreviationISO6392 [type Language] 
AbsoluteCheckoutFilePath [type DerivativeLock] 
AbsoluteImportFilePath [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");

AbsoluteImportFilePath [type DerivativeUpdateOptions] 

The uri of the import file path. Not needed if MTOM is used.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

AbsolutePath [type AssetContainerIndex] 
AbsolutePath [type Download] 
AbsolutePathById [type AssetContainerIndex] 
AddAssets2AssetContainers 
AddAssets2AssetContainersResponse 
AddAssetVersions 
AddAssetVersionsResponse 
AdditionalSelectFields [type AssetFilter] 

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"};
AdditionalText [type FieldTranslation] 
additionalUserGroupRightsCheck [element GetUsers]  Optional. Get only users in groups to which the current user has a certain UserGroupRight.
additionalUserRightsCheck [element GetUsers]  Optional. Get only users with this UserRight.
Address [type UserData] 
Address [type UserShort] 
AfterDateTime [type DateTimeAfterOperation] 
AfterDateTime [type DateTimeBetweenOperation] 
AllQueryAssetIds [type AssetItemCollection] 

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.

AlternativeAddress [type UserData] 
AlternativeAddress [type UserShort] 
Analyzed [type Field]  Defines if the field gets analyzed by RavenDB
AndOperation 
anyType 
anyURI 
Applicable [type RightTemplate] 
ApplicationLanguage 
AppliedAssetRightTemplateId [type AssetItem]  The id of the asset right template. Is ignored, if IsAssetRightTemplateOverridden = true.
AppliedAssetRightTemplateId [type AssetMetadata]  The id of the assigned right template.
AppliedAssetRightTemplateId [type PortAssetItem]  The id of the asset right template.
AppliedAssetRightTemplateName [type PortAssetItem]  The translation of the asset right template in current user language.
AppliedDerivativeRightTemplateId [type AssetItem]  The id of the derivative right template. Is ignored, if IsDerivativeRightTemplateOverridden = true.
AppliedDerivativeRightTemplateId [type AssetMetadata]  The id of the right template used to define the access rights for the derivative formats.
AppliedRightTemplateId [type AssetContainerItem]  The id of the applied right template.Is ignored, if IsRightTemplateOverridden = true
ArrayOfAssetContainerAssignmentExtended 
ArrayOfAssetContainerComparisonOperation 
ArrayOfAssetContainerIndex 
ArrayOfAssetContainerItem 
ArrayOfAssetContainerLogicalOperation 
ArrayOfAssetContainerRight 
ArrayOfAssetContainerTotalAssets 
ArrayOfAssetContainerTranslation 
ArrayOfAssetFieldValues 
ArrayOfAssetItem 
ArrayOfAssetObject 
ArrayOfAssetRight 
ArrayOfAssetSelection 
ArrayOfAssetVersion 
ArrayOfAudioStream 
ArrayOfBusinessProcessLink 
ArrayOfBusinessProcessShort 
ArrayOfClaimGroup 
ArrayOfComparisonOperation 
ArrayOfCountry 
ArrayOfCountryTranslation 
ArrayOfDerivative 
ArrayOfDerivativeDefinition 
ArrayOfDerivativeDefinition2AssetType 
ArrayOfDerivativeDefinitionRight 
ArrayOfDerivativeDefinitionRights 
ArrayOfDerivativeDefinitionTranslation 
ArrayOfDerivativeRight 
ArrayOfDocument 
ArrayOfDocumentPage 
ArrayOfExtendedDerivative 
ArrayOfFacetConfigurationElement 
ArrayOfFacetConfigurationGroup 
ArrayOfFacetConfigurationRange 
ArrayOfFacetConfigurationTranslation 
ArrayOfFacetResult 
ArrayOfFacetSearchParameter 
ArrayOfFacetValue 
ArrayOfField 
ArrayOfFieldOption 
ArrayOfFieldOptionTranslation 
ArrayOfFieldRight 
ArrayOfFieldTranslation 
ArrayOfFieldValue 
ArrayOffloat 
ArrayOfint 
ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h 
ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK 
ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe 
ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe 
ArrayOfKeyValueOfintPortViewField6jg_STziK 
ArrayOfKnownFieldValue 
ArrayOfLanguage4AssetContainer 
ArrayOfLanguage4Content 
ArrayOfLanguage4FullTextIndex 
ArrayOfLanguage4Metadata 
ArrayOfLanguage4UserInterface 
ArrayOfLanguage4Version 
ArrayOfLanguageFallback 
ArrayOfLdapSecurityGroup 
ArrayOfLogicalOperation 
ArrayOfMediaInfo 
ArrayOfMetadataProperty 
ArrayOfPersonalItemRight 
ArrayOfPortAssetItem 
ArrayOfPortDerivative 
ArrayOfRenderingActionArgumentValue 
ArrayOfRenderingActionValue 
ArrayOfRightTemplate 
ArrayOfRightTemplate2AssetType 
ArrayOfRightTemplate2Right 
ArrayOfRightTemplate2UserGroup 
ArrayOfSiteRight 
ArrayOfSortInfo 
ArrayOfstring 
ArrayOfUserActionHistoryInfo 
ArrayOfUserDerivativeRights 
ArrayOfUserGroupAssetContainerRights 
ArrayOfUserGroupAssetRights 
ArrayOfUserGroupDerivativeRights 
ArrayOfUserGroupRight 
ArrayOfUserGroupTranslation 
ArrayOfUserRight 
ArrayOfUserShort 
ArrayOfVideoStream 
ArrayOfWidgetRight 
ArrayOfXmpItem 
aspNetSessionId [element CreateSession]  Optional. The aspNetSessionId (if known), which enables the system to retrieve a lost session, e.g. in case of a browser reload.
Asset [type AssetVersion] 
AssetContainerAndOperation 
AssetContainerAssignment 
AssetContainerAssignmentExtended [type ArrayOfAssetContainerAssignmentExtended] 
AssetContainerAssignmentExtended 
AssetContainerAssignments [type AssetMetadata] 

An array with all AssetContainerAssignmentExtendeds for this asset.

An asset can be assigned to many asset containers.

AssetContainerComparisonOperation [type ArrayOfAssetContainerComparisonOperation] 
AssetContainerComparisonOperation 
AssetContainerExcludeFieldOperation 
AssetContainerExcludeOperation 
assetContainerId [element GetAssetContainerRights]  The id of the asset container.
assetContainerId [element GetFieldSetIdByFieldName]  The asset container ID.
assetContainerId [element RemoveAssetContainer] 

The id of the asset container.

The deletion of an asset container includes the deletion of all sub containers!

assetContainerId [element SaveAssetContainerRights]  The id of the asset container.
assetContainerId [element UpdateAssetContainer]  The id of the asset container.
assetContainerId [element UpdateFieldSetDefaultValue]  The asset container ID.
AssetContainerId [type AssetContainerAssignment] 
AssetContainerId [type AssetContainerComparisonOperation] 
AssetContainerId [type AssetContainerExcludeFieldOperation] 
AssetContainerId [type AssetContainerIncludeFieldOperation] 
AssetContainerId [type AssetContainerItem]  The id of the asset container.
AssetContainerId [type AssetContainerTotalAssets] 
AssetContainerId [type AssetContainerTranslation] 
AssetContainerId [type FacetValue] 
AssetContainerId [type UserActionHistoryInfo] 
assetContainerIds [element AddAssets2AssetContainers]  Array of asset container ids.
assetContainerIds [element GetTotalAssets] 
assetContainerIds [element RemoveAssetsFromAssetContainers]  List of asset container ids.
AssetContainerIds [type AssetImportOptions] 

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.

AssetContainerIncludeFieldOperation 
AssetContainerIncludeOperation 
AssetContainerIndex [type ArrayOfAssetContainerIndex] 
AssetContainerIndex 
AssetContainerIndexId [type AssetContainerIndex] 
AssetContainerItem [type ArrayOfAssetContainerItem] 
AssetContainerItem 
AssetContainerLogicalOperation [type ArrayOfAssetContainerLogicalOperation] 
AssetContainerLogicalOperation 
AssetContainerName [type AssetContainerItem]  The asset container name depends on the parameter desiredAssetContainerLanguage in GetAssetContainers.
AssetContainerOrOperation 
AssetContainerRight [type ArrayOfAssetContainerRight] 
AssetContainerRight 
AssetContainerRightId [type RightTemplate2Right] 
AssetContainerRights [type UserGroupAssetContainerRights] 
AssetContainerSearchOperation [type ExtendedAssetFilter] 

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 ..
}

AssetContainerTotalAssets [type ArrayOfAssetContainerTotalAssets] 
AssetContainerTotalAssets 
AssetContainerTranslation [type ArrayOfAssetContainerTranslation] 
AssetContainerTranslation 
AssetContainerTranslationId [type AssetContainerTranslation] 
assetContainerTranslations [element CreateAssetContainer]  A list of AssetContainerTranslations with the language specific asset container names and descriptions.
assetContainerTranslations [element UpdateAssetContainer]  A list of AssetContainerTranslations with the language specific asset container names and descriptions.
assetContainerType [element GetAssetContainers] 

Optional. Either Category or AssetClass.

AssetContainerType? assetContainerType = AssetContainerType.AssetClass;
AssetContainerType [type AssetContainerAssignmentExtended] 
AssetContainerType [type AssetContainerItem]  The asset container type, either Category or AssetClass.
AssetContainerType [type Field] 

The asset container type, either Category or AssetClass.

This property is needed for asset classes.

AssetContainerType 
assetFieldValues [element UpdateAssetsMetadata]  The list of AssetFieldValues to be updated.
AssetFieldValues [type ArrayOfAssetFieldValues] 
AssetFieldValues 
assetFieldValues2Remove [element UpdateAssetsMetadata]  The list of AssetFieldValues to be removed.
assetFilter [element GetAssets2]  An asset filter.
assetFilter [element GetAssetsByIds]  The assetFilter allows the definition of some additional parameters.
assetFilter [element GetAssetVersions]  An asset filter, may be empty.
AssetFilter 
assetId [element DeleteDerivative]  The asset id.
assetId [element GetAssetRights]  The asset id.
assetId [element GetAssetVersions]  The asset id.
assetId [element GetDerivativeRights]  The asset id.
assetId [element GetMetadata]  The asset id.
assetId [element UpdateAssetMetadata]  The asset id
AssetId [type AssetContainerAssignment] 
AssetId [type AssetFieldValues]  The asset id.
AssetId [type AssetItem]  The asset id.
AssetId [type AssetObject] 
AssetId [type AssetSelection] 
AssetId [type AssetUpdateOptions]  The asset id.
AssetId [type BusinessProcessLink] 
AssetId [type Derivative] 
AssetId [type DerivativeLock] 
AssetId [type DerivativeUpdateOptions]  The asset id.
AssetId [type FieldValue] 
AssetId [type PortAssetItem]  The asset id.
AssetId [type PortDerivative] 
AssetId [type UserActionHistoryInfo] 
assetIds [element AddAssets2AssetContainers]  Array of asset ids.
assetIds [element GetAssetsByIds]  The int array of asset ids to be returned.
assetIds [element GetAssetsMetadata]  A list of asset ids.
assetIds [element RemoveAssets]  An array of asset ids.
assetIds [element RemoveAssetsFromAssetContainers]  List of asset ids.
assetIds [element SaveAssetsRights]  List of asset ids.
assetIds [element SaveDerivativeRights]  List of asset ids.
assetImportOptions [element ImportSingleAsset] 

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.

AssetImportOptions 
AssetItem [type ArrayOfAssetItem] 
AssetItem 
AssetItemCollection 
assetLinks [element UpdateAssetLinks]  An array of BusinessProcessShort.
AssetMetadata 
AssetObject [type ArrayOfAssetObject] 
AssetObject 
AssetObjectId [type AssetObject] 
AssetObjects [type DocumentPage] 
AssetObjectType [type AssetObject] 
AssetObjectType 
AssetRight [type ArrayOfAssetRight] 
AssetRight 
AssetRightId [type RightTemplate2Right] 
AssetRights [type AssetItem]  An array with all AssetRights for the current user.
AssetRights [type AssetMetadata]  array with all AssetRights for the current user.
AssetRights [type UserGroupAssetRights] 
AssetRightTemplateId [type AssetImportOptions]  The id of an AssetRightTemplate.
Assets [type AssetItemCollection]  An array of AssetItem.
Assets [type PortAssetItemCollection]  An array of AssetItem.
assetSelection [element Download]  A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds.
assetSelection [element DownloadExtended]  A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds.
assetSelection [element GetDerivatives]  A list of AssetSelections.
AssetSelection [type ArrayOfAssetSelection] 
AssetSelection 
assetSelections [element CreateAssetLink]  A list of asset selections.
AssetType [type RightTemplate2AssetType] 
AssetType 
AssetTypeId [type AssetItem]  In Picturepark, assets are categorized into AssetTypes according to their file extensions.
AssetTypeId [type AssetMetadata]  Bitmap, VectorGraphic, TextDocument, Audio, Video ..
AssetTypeId [type DerivativeDefinition2AssetType] 
AssetTypeId [type PortAssetItem] 
AssetTypeId [type RenderingActionValue] 
AssetTypeIds [type ExtendedAssetFilter] 

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}
AssetTypeIds [type Field]  An array with the ids of asset types assigned to this field. Currently not used.
AssetTypeIds [type RightTemplate] 
AssetTypeTranslation [type PortAssetItem] 
assetUpdateOptions [element UpdateOriginalDerivative]  Complex data type containing multiple update parameters.
AssetUpdateOptions 
AssetVersion [type ArrayOfAssetVersion] 
AssetVersion 
AssetVersionId [type AssetVersion] 
assetVersions [element AddAssetVersions] 

A list of AssetVersions.

There are currently two types of assetversions: languages and slides.

assetVersions [element RemoveAssetVersions]  A list of AssetVersions.
AssetVersions [type AssetImportOptions]  Optional. List of asset versions.
AssetVersions [type AssetItem] 

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.

AssetVersions [type AssetMetadata] 

An array with all AssetVersions for this asset.

This array contains all asset versions which have this asset as a parent.

Assigned [type RightTemplate] 
AudioBitRate [type AudioStream] 
AudioBitrate [type DerivativeDefinition] 
AudioBitRateMode [type AudioStream] 
AudioChannelPositions [type AudioStream] 
AudioChannels [type AudioStream] 
AudioCodec [type AudioStream] 
AudioCount [type MediaInfo] 
AudioDuration [type AudioStream] 
AudioFormat [type AudioStream] 
AudioLanguage [type AudioStream] 
AudioQuality [type DerivativeDefinition] 
AudioResolution [type AudioStream] 
AudioSamplingFrequency [type DerivativeDefinition] 
AudioSamplingRate [type AudioStream] 
AudioStream [type ArrayOfAudioStream] 
AudioStream 
AudioStreams [type MediaInfo] 
AudioStreamSize [type AudioStream] 
AudioUse4Preview [type DerivativeDefinition] 
authenticationUser [element GetSecurityToken]  The email address of the user, who serves to authenticate the connection.
authenticationUserPassword [element GetSecurityToken]  The password of that user.
Available4UserInterface [type Language] 
AvailableDerivativeDefinitions [type AssetItem]  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.
AvailableUntilDate [type Download] 
Average [type FacetValue] 
AvPresetId [type DerivativeDefinition] 
base64Binary 
BaseAssetContainerId [type FacetConfigurationViewItem] 
BaseAssetContainerId [type Field]  Needed for control type TagBox and defines root of the tagbox.
batchGuid [element ConfirmSubscriptionInfoReceived]  The guid received from GetSubscriptionInfo
BatchGuid [type UserActionHistoryInfoCollection] 
BeforeDateTime [type DateTimeBeforeOperation] 
BeforeDateTime [type DateTimeBetweenOperation] 
BitrateMode 
boolean 
Boost [type Field]  Defines the boost factor for Fulltext search
buffer [element UploadChunk]  The buffer containing the chunk
buffer [element UploadFirstChunk]  The buffer containing the first chunk.
businessProcessId [element GetMetadata]  Optional. Not needed by integrators.
BusinessProcessId [type AssetFilter]  Optional. Not needed for integrators.
BusinessProcessId [type BusinessProcessShort] 
BusinessProcessId [type DownloadOptions] 

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.

businessProcessIds [element DeleteAssetLinks]  A list of the businessprocess ids to be deleted.
businessProcessIds [element GetAssetLinksById]  A list of businessprocess ids.
BusinessProcessLink [type ArrayOfBusinessProcessLink] 
BusinessProcessLink 
BusinessProcessShort [type ArrayOfBusinessProcessShort] 
BusinessProcessShort 
businessProcessToken [element GetMetadata]  Optional. Not needed by integrators.
BusinessProcessToken [type AssetFilter]  Optional. Not needed for integrators.
BusinessProcessToken [type DownloadOptions]  Token for a business process, must be given in combination with a BusinessProcessId.
BusinessProcessType [type BusinessProcessShort] 
BusinessProcessType 
BusinessProcessUrl [type BusinessProcessLink] 
byte 
CanBeInternalContact [type UserData] 
CanBeInternalContact [type UserShort] 
CanChangeOwnProfile [type UserData] 
CanChangeOwnProfile [type UserShort] 
CanManage [type Skin] 
Caption [type FacetConfigurationGroup]  Used in UI set to user language4content's caption
Caption [type FacetConfigurationRange]  Used in UI set to user language4content's caption
Caption [type FacetConfigurationTranslation] 
Caption [type FacetResult] 
Caption [type FieldTranslation] 
Caption [type MetadataProperty] 
Caption [type MetadataSchema] 
Caption [type PortViewField] 
CaptionsOfUncollapsedFacetGroups [type FacetSearchParameter]  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.
CatalogLanguageId [type Language4FullTextIndex] 
CatalogLanguageSqlName [type Language] 
char 
CheckoutReason [type DerivativeLock] 
Children [type AssetContainerItem]  An array with child AssetContainerItems.
children [type XmpItem] 
City [type UserData] 
City [type UserShort] 
ClaimGroup [type ArrayOfClaimGroup] 
ClaimGroup 
ClaimGroups [type UserGroupItem] 
ClientComputerName [type DerivativeLock] 
ClientFileModificationDate [type DerivativeLock] 
clientGuid [element CreateSession]  The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
clientGuid [element GetSecurityToken]  The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
clientGuid [element LoginWithSecurityToken]  The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
clientGuid [element LoginWithSecurityToken2]  The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.
ClientId [type CoreInfo]  The client id.
Code [type Country] 
Codec [type MediaInfo] 
Comment [type UserData] 
Comment [type UserShort] 
CommentId [type AssetObject] 
Company [type UserData] 
Company [type UserShort] 
ComparisonOperation [type ArrayOfComparisonOperation] 
ComparisonOperation [type FacetValue] 
ComparisonOperation 
ComparisonOperations [type AndOperation] 
ComparisonOperations [type AssetContainerAndOperation] 
ComparisonOperations [type AssetContainerOrOperation] 
ComparisonOperations [type OrOperation] 
ComparisonOperationType [type FacetValue] 
ComparisonOperationType 
ConfirmSubscriptionInfoReceived 
ConfirmSubscriptionInfoReceivedResponse 
ContainsExactStringList [type StringListContainsExactOperation] 
ContainsString [type StringContainsOperation] 
ContainsStringList [type StringListContainsOperation] 
ContentLanguageId [type Language4Content] 
ControlType [type Field]  ComboBox, DateField, Checkbox ..
ControlType 
CopyLanguageId [type Language4AssetContainer] 
Copyright [type PortAssetItem] 
coreInfo [element AddAssets2AssetContainers]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element AddAssetVersions]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element ConfirmSubscriptionInfoReceived]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element CreateAssetContainer]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element CreateAssetLink]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element CreateRenderingJob]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element CreateTraceJob]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element CreateUser]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element DeleteAssetLinks]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element DeleteDerivative]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element Download]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element DownloadExtended]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssetContainerRights]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssetContainers]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssetFields]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssetLinksById]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssetRights]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssets]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssets2]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssetsByIds]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssetsMetadata]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetAssetVersions]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetConfiguration]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetConfigurationModificationDate] 
coreInfo [element GetDerivativeRights]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetDerivatives]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetFacetConfigurationExtended]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetFacets]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetFieldSetIdByFieldName]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetLanguageConfiguration]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetMetadata]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetRights]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetSubscriptionInfo]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetTotalAssets] 
coreInfo [element GetUserById]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element GetUsers]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element ImportSingleAsset]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element IsValid]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element Login]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element LoginWithSecurityToken]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element LoginWithSecurityToken2]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element MoveAssetContainer]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element RemoveAssetContainer]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element RemoveAssets]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element RemoveAssetsFromAssetContainers]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element RemoveAssetVersions]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element RemoveUsers]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element RenewSession]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element SaveAssetContainerRights]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element SaveAssetsRights]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element SaveDerivative]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element SaveDerivativeRights]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UpdateAssetContainer]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UpdateAssetLinks]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UpdateAssetMetadata]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UpdateAssetsMetadata]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UpdateFieldSetDefaultValue]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UpdateOriginalDerivative]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UpdateUser]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UploadChunk]  The CoreInfo object which has been returned by CreateSession.
coreInfo [element UploadFirstChunk]  The CoreInfo object which has been returned by CreateSession.
CoreInfo 
Count [type FacetValue] 
Countries [type PublicConfiguration] 
Country [type ArrayOfCountry] 
Country [type UserData] 
Country 
CountryId [type Country] 
CountryId [type CountryTranslation]  The id of the country.
CountryId [type UserData] 
CountryId [type UserShort] 
CountryName [type CountryTranslation] 

The name of the country in german(1), english(2) or french(3).

E.g. "Deutschland", "Germany", "Allemagne".

CountryTranslation [type ArrayOfCountryTranslation] 
CountryTranslation 
CountryTranslationId [type CountryTranslation] 
CountryTranslations [type UserShort] 
CreateAssetContainer 
CreateAssetContainerResponse 
CreateAssetContainerResult [element CreateAssetContainerResponse] 
CreateAssetLink 
CreateAssetLinkResponse 
CreateAssetLinkResult [element CreateAssetLinkResponse] 
CreatedByUserId [type AssetContainerItem]  The id of the user who created the container.
CreatedByUserId [type AssetVersion] 
CreatedByUserId [type RightTemplate] 
CreatedByUserId [type RightTemplate2AssetType] 
CreatedByUserId [type RightTemplate2Right] 
CreatedByUserId [type RightTemplate2UserGroup] 
CreatedByUserId [type Skin] 
CreatedByUserId [type UserData] 
CreatedByUserId [type UserShort] 
CreateHistoricVersion [type AssetUpdateOptions]  Optional. If true, the old asset is not overwritten, but kept as a historic version. Default is false.
CreateRenderingJob 
CreateRenderingJobResponse 
CreateRenderingJobResult [element CreateRenderingJobResponse] 
CreateSession 
CreateSessionResponse 
CreateSessionResult [element CreateSessionResponse] 
createSingleDownload4MultipleFiles [element DownloadExtended] 

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.

CreateTraceJob 
CreateTraceJobResponse 
CreateTraceJobResult [element CreateTraceJobResponse] 
CreateUser 
CreateUserResponse 
CreateUserResult [element CreateUserResponse] 
CreateZip4SingleFile [type DownloadOptions]  If false and the download contains only one file, then the file is not zipped.
CreationDate [type AssetContainerItem]  The creation date.
CreationDate [type AssetVersion] 
CreationDate [type DerivativeLock] 
CreationDate [type ExtendedDerivative] 
CreationDate [type PortAssetItem] 
CreationDate [type RightTemplate] 
CreationDate [type RightTemplate2AssetType] 
CreationDate [type RightTemplate2Right] 
CreationDate [type RightTemplate2UserGroup] 
CreationDate [type Skin] 
CreationDate [type UserData] 
CreationDate [type UserShort] 
CssSource [type Skin] 
customerId [element CreateSession]  The id of the customer (picturepark), e.g. 123.
customerId [element GetContentLanguages]  The customer id.
customerId [element GetSecurityToken]  The id of the customer (picturepark), e.g. 27.
CustomerId [type CoreInfo] 

The id of the customer (Picturepark), which must be submitted when creating a session.

For Picturepark server solutions, this id is usually 1.

CustomerName [type CoreInfo]  E.g. "Media database Walchwil". Currently not used, always null.
DataType [type Field]  Integer32, String, Date, Boolean ..
DataType [type MetadataProperty] 
DataType 
DataTypeId [type MetadataProperty] 
DateRange [type FacetConfigurationRange] 
DateTime [type DateTimeOffset] 
dateTime 
DateTimeAfterOperation 
DateTimeBeforeOperation 
DateTimeBetweenOperation 
DateTimeEqualOperation 
DateTimeNowAfterOperation 
DateTimeNowAfterOrEqualOperation 
DateTimeNowBeforeOrEqualOperation 
DateTimeNowLastOperation 
DateTimeNowNextOperation 
DateTimeNowOlderOperation 
DateTimeOffset 
decimal 
DefaultGridColumnWidth [type Field]  The default field column width for the asset browser grid view.
DefaultLanguage4AssetContainerId [type Language4Content] 
DefaultLanguage4ContentId [type Language4UserInterface] 
DefaultLanguage4MetadataId [type Language4Content] 
defaultValues [element UpdateFieldSetDefaultValue]  The new default value.
DeleteAssetLinks 
DeleteAssetLinksResponse 
Deleted [type AssetVersion] 
Deleted [type DerivativeLock] 
Deleted [type ExtendedDerivative] 
Deleted [type RightTemplate] 
Deleted [type RightTemplate2AssetType] 
Deleted [type RightTemplate2Right] 
Deleted [type RightTemplate2UserGroup] 
Deleted [type Skin] 
Deleted [type UserShort] 
deleteDependentAssets [element RemoveAssets] 

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).

DeleteDependentAssets [type AssetUpdateOptions]  Optional. If true, dependent assets like versions are deleted. Default is false.
DeleteDerivative 
DeleteDerivativeResponse 
Department [type UserData] 
Department [type UserShort] 
Derivative [type ArrayOfDerivative] 
Derivative 
DerivativeDefinition [type ArrayOfDerivativeDefinition] 
DerivativeDefinition 
DerivativeDefinition2AssetType [type ArrayOfDerivativeDefinition2AssetType] 
DerivativeDefinition2AssetType 
DerivativeDefinition2AssetTypeId [type DerivativeDefinition2AssetType] 
DerivativeDefinition2AssetTypes [type DerivativeDefinition] 
derivativeDefinitionId [element DeleteDerivative]  The derivative definition id.
DerivativeDefinitionId [type AssetObject] 
DerivativeDefinitionId [type AssetSelection] 
DerivativeDefinitionId [type BusinessProcessLink] 
DerivativeDefinitionId [type Derivative] 
DerivativeDefinitionId [type DerivativeDefinition] 
DerivativeDefinitionId [type DerivativeDefinition2AssetType] 
DerivativeDefinitionId [type DerivativeDefinitionRights] 
DerivativeDefinitionId [type DerivativeDefinitionTranslation] 
DerivativeDefinitionId [type DerivativeLock] 
DerivativeDefinitionId [type DerivativeUpdateOptions]  The deriviative definition id.
DerivativeDefinitionId [type MediaInfo] 
DerivativeDefinitionId [type PortDerivative] 
DerivativeDefinitionId [type RenderingActionValue] 
DerivativeDefinitionId [type RightTemplate2Right] 
DerivativeDefinitionId [type UserActionHistoryInfo] 
DerivativeDefinitionRight [type ArrayOfDerivativeDefinitionRight] 
DerivativeDefinitionRight 
DerivativeDefinitionRightId [type RightTemplate2Right] 
DerivativeDefinitionRights [type ArrayOfDerivativeDefinitionRights] 
DerivativeDefinitionRights [type Rights] 
DerivativeDefinitionRights [type UserDerivativeRights] 
DerivativeDefinitionRights 
DerivativeDefinitions [type PublicConfiguration] 
DerivativeDefinitionTranslation [type ArrayOfDerivativeDefinitionTranslation] 
DerivativeDefinitionTranslation [type PortDerivative] 
DerivativeDefinitionTranslation 
DerivativeDefinitionTranslationId [type DerivativeDefinitionTranslation] 
DerivativeId [type Derivative] 
DerivativeId [type DerivativeLock] 
DerivativeId [type PortDerivative] 
DerivativeLock [type AssetMetadata]  DerivativeLock. If not null this asset is locked.
DerivativeLock 
DerivativeLockId [type DerivativeLock] 
DerivativeModificationDate [type DerivativeLock] 
DerivativeModifiedByUser [type DerivativeLock] 
DerivativeRight [type ArrayOfDerivativeRight] 
DerivativeRight 
DerivativeRightId [type RightTemplate2Right] 
DerivativeRights [type DerivativeDefinitionRights] 
DerivativeRights [type UserGroupDerivativeRights] 
DerivativeRightTemplateId [type AssetImportOptions]  The id of a DerivativeRightTemplate.
Derivatives [type AssetItem] 

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.

Derivatives [type AssetMetadata] 

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.

DerivativeType [type DerivativeDefinition] 
DerivativeType 
derivativeUpdateOptions [element SaveDerivative]  Complex data type containing multiple update parameters.
DerivativeUpdateOptions 
description [element CreateAssetLink]  The description.
Description [type AssetContainerTranslation]  The asset container description in the language defined by LanguageId.
Description [type AssetVersion] 
Description [type BusinessProcessShort] 
Description [type DerivativeDefinitionTranslation] 
Description [type PortAssetItem]  The asset's further description (in most cases it'll be the field AssetDescription).
Description [type RightTemplate] 
desiredAssetContainerLanguage [element GetAssetContainers] 

Optional. The language (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..).

ApplicationLanguage? desiredAssetContainerLanguage = ApplicationLanguage.English;
DesiredMetadataLanguage [type AssetFilter] 

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
destinationAssetContainerId [element MoveAssetContainer]  The id of the new parent asset container.
DisplayName [type User]  First name plus last name
distinct [element GetSubscriptionInfo]  Flag: return distinct values only.
Document [type ArrayOfDocument] 
Document 
DocumentId [type Document] 
DocumentId [type DocumentPage] 
DocumentPage [type ArrayOfDocumentPage] 
DocumentPage 
DocumentPageId [type AssetObject] 
DocumentPageId [type DocumentPage] 
DocumentPages [type Document] 
Documents [type AssetMetadata]  An array with all assigned Documents.
double 
Download 
Download 
DownloadableDerivatives [type PortAssetItem] 

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.

DownloadExtended 
DownloadExtendedResponse 
DownloadExtendedResult [element DownloadExtendedResponse] 
DownloadFileName [type Download] 
downloadOptions [element Download]  Defines the download options.
downloadOptions [element DownloadExtended]  Defines the download options.
DownloadOptions 
DownloadResponse 
DownloadResult [element DownloadResponse] 
DownloadToken [type Download] 
duration 
DurationInSeconds [type MediaInfo] 
Editable [type RightTemplate] 
Elements [type FacetConfigurationJson] 
Email [type User] 
emailAddress [element GetSecurityToken]  The email address of the (PAS) user, who will later log in from the publisher with the security token
EmailAddress [type UserCompact] 
EmailAddress [type UserData] 
EmailAddress [type UserShort] 
EnglishName [type Language] 
EpsHeightInPoints [type ExtendedDerivative] 
EpsIsRasterized [type ExtendedDerivative] 
EpsWidthInPoints [type ExtendedDerivative] 
EqualDateTime [type DateTimeEqualOperation] 
EqualNumeric [type NumericEqualOperation] 
EqualNumericList [type NumericListEqualOperation] 
EqualString [type StringEqualOperation] 
EqualStringList [type StringListEqualOperation] 
ErrorCode [type PictureparkFault] 
exceptedAssetContainerIds [element SaveAssetContainerRights]  A list of sub containers to be excluded (if IncludeSubAssetContainers is true )
ExclusivityGroupId [type AssetContainerAssignmentExtended] 
ExclusivityGroupId [type AssetContainerItem] 

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.

expanded [type XmpItem] 
expirationDate [element CreateAssetLink]  The expiry date.
ExpirationDate [type BusinessProcessShort] 
ExpirationDate [type UserData] 
ExpirationDate [type UserShort] 
extendedAssetFilter [element GetAssets]  The extendedAssetFilter allows the definition of many additional parameters.
ExtendedAssetFilter 
ExtendedDerivative [type ArrayOfExtendedDerivative] 
ExtendedDerivative 
FacetConfigurationElement [type ArrayOfFacetConfigurationElement] 
FacetConfigurationElement 
FacetConfigurationExtended 
FacetConfigurationGroup [type ArrayOfFacetConfigurationGroup] 
FacetConfigurationGroup 
FacetConfigurationId [type BusinessProcessShort] 
FacetConfigurationId [type FacetConfigurationViewItem] 
FacetConfigurationId [type FacetSearchParameter] 
FacetConfigurationJson [type FacetConfigurationViewItem] 
FacetConfigurationJson 
FacetConfigurationRange [type ArrayOfFacetConfigurationRange] 
FacetConfigurationRange 
FacetConfigurationTranslation [type ArrayOfFacetConfigurationTranslation] 
FacetConfigurationTranslation 
FacetConfigurationViewItem 
FacetDateRange 
FacetInnerSelectionBehavior 
FacetResult [type ArrayOfFacetResult] 
FacetResult 
FacetResults 
FacetSearchParameter [type ArrayOfFacetSearchParameter] 
FacetSearchParameter 
FacetValue [type ArrayOfFacetValue] 
FacetValue 
FallbackLanguage [type LanguageFallback] 
FallbackLanguageId [type LanguageFallback] 
Field [type ArrayOfField] 
Field 
FieldControlInfoId [type FieldControlInfos]  The id of the field control info.
FieldControlInfos [type Field]  Control Infos.
FieldControlInfos 
FieldId [type AssetContainerAssignment] 
FieldId [type FacetConfigurationElement] 
FieldId [type FacetResult]  Serves as identifier for the UI
FieldId [type FacetValue] 
FieldId [type Field]  The id of the field.
FieldId [type FieldControlInfos]  The id of the field.
FieldId [type FieldOption] 
FieldId [type FieldTranslation] 
FieldId [type FieldValue] 
FieldId [type KnownFieldValue] 
fieldIds [element GetAssetsMetadata]  A list of field ids.
FieldIds [type FacetConfigurationExtended] 
FieldIds [type FacetConfigurationGroup] 
FieldIdsOfFacets [type FacetSearchParameter]  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 [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.
FieldLookupEntity [type Field]  The name of the table to which the field belongs: FieldValues, Assets, Derivatives ..
FieldLookupEntity 
FieldLookupEntityId [type Field]  The id of the FieldLookupEntity (see there).
fieldName [element GetFieldSetIdByFieldName]  The field name (case sensitive!).
FieldName [type ComparisonOperation] 
FieldName [type FacetValue] 
FieldOption [type ArrayOfFieldOption] 
FieldOption 
FieldOptionId [type FieldOption] 
FieldOptionId [type FieldOptionTranslation] 
FieldOptionId [type FieldValue] 
FieldOptionId [type KnownFieldValue] 
FieldOptionsLookupEntity [type Field] 

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.

FieldOptionsLookupEntity 
FieldOptionsLookupEntityId [type Field]  The id of the FieldOptionsLookupEntityId (see there).
FieldOptionTranslation [type ArrayOfFieldOptionTranslation] 
FieldOptionTranslation 
FieldOptionTranslationId [type FieldOptionTranslation] 
FieldRight [type ArrayOfFieldRight] 
FieldRight 
FieldRightId [type RightTemplate2Right] 
FieldRights [type Rights] 
fieldSetId [element UpdateFieldSetDefaultValue]  The field set ID to apply the new default value to. It can be obtained by calling GetFieldSetIdByFieldName
FieldSetIds [type AssetContainerAssignmentExtended] 
FieldSetIds [type AssetContainerItem] 

A list of assigned field set ids.

FieldSetIds define which fields are assigned to an asset container. Needed for AssetClasses.

FieldSetIds [type AssetFieldValues]  The fieldSetIds for this asset.
FieldSetIds [type AssetItem] 

A list of assigned field set ids.

FieldSetIds define which fields are assigned to an asset. Needed for AssetClasses.

FieldTranslation [type ArrayOfFieldTranslation] 
FieldTranslation 
FieldTranslationId [type FieldTranslation] 
FieldType [type Field]  AssetField, UserField or AssetContainerField.
FieldType 
FieldValue [type ArrayOfFieldValue] 
FieldValue 
FieldValueId [type FieldValue] 
fieldValues [element UpdateAssetMetadata]  A list of FieldValues.
FieldValues [type AssetFieldValues]  Array of field values for this asset.
FieldValues [type AssetImportOptions] 

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},
.  ..
};

FieldValues [type AssetItem] 

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.

FieldValues [type AssetMetadata]  An array with all FieldValues for this asset.
FieldValues [type DerivativeLock] 
FieldValues [type UserData] 
FieldValues [type UserShort] 
fieldValues2Remove [element UpdateAssetMetadata]  A list of field values to be deleted.
FieldValueSource 
FileExtension [type PortAssetItem] 
FileExtensionId [type Derivative] 
FileName [type AssetImportOptions]  The file name with extension, needed only for an upload by MTOM.
FileName [type AssetUpdateOptions]  The file name, which must have an extension. Needed only for an upload by MTOM.
FileName [type Derivative]  E.g. "Matterhorn1.jpg".
FileName [type DerivativeUpdateOptions]  The file name, which must have an extension. Needed only for an upload by MTOM.
FileSize [type Download] 
FileSize [type PortAssetItem] 
FileSize [type PortDerivative] 
FileSizeInBytes [type Derivative] 
FirstName [type UserCompact] 
FirstName [type UserData] 
FirstName [type UserShort] 
float [type ArrayOffloat] 
float 
Format [type MediaInfo] 
From [type FacetDateRange] 
FromNumeric [type FacetConfigurationRange] 
GetAssetContainerRights 
GetAssetContainerRightsResponse 
GetAssetContainerRightsResult [element GetAssetContainerRightsResponse] 
GetAssetContainers 
GetAssetContainersResponse 
GetAssetContainersResult [element GetAssetContainersResponse] 
GetAssetFields 
GetAssetFieldsResponse 
GetAssetFieldsResult [element GetAssetFieldsResponse] 
GetAssetLinksById 
GetAssetLinksByIdResponse 
GetAssetLinksByIdResult [element GetAssetLinksByIdResponse] 
GetAssetRights 
GetAssetRightsResponse 
GetAssetRightsResult [element GetAssetRightsResponse] 
GetAssets 
GetAssets2 
GetAssets2Response 
GetAssets2Result [element GetAssets2Response] 
GetAssetsByIds 
GetAssetsByIdsResponse 
GetAssetsByIdsResult [element GetAssetsByIdsResponse] 
GetAssetsMetadata 
GetAssetsMetadataResponse 
GetAssetsMetadataResult [element GetAssetsMetadataResponse] 
GetAssetsResponse 
GetAssetsResult [element GetAssetsResponse] 
GetAssetVersions 
GetAssetVersionsResponse 
GetAssetVersionsResult [element GetAssetVersionsResponse] 
GetConfiguration 
GetConfigurationModificationDate 
GetConfigurationModificationDateResponse 
GetConfigurationModificationDateResult [element GetConfigurationModificationDateResponse] 
GetConfigurationResponse 
GetConfigurationResult [element GetConfigurationResponse] 
GetContentLanguages 
GetContentLanguagesResponse 
GetContentLanguagesResult [element GetContentLanguagesResponse] 
GetDerivativeRights 
GetDerivativeRightsResponse 
GetDerivativeRightsResult [element GetDerivativeRightsResponse] 
GetDerivatives 
GetDerivativesResponse 
GetDerivativesResult [element GetDerivativesResponse] 
GetFacetConfigurationExtended 
GetFacetConfigurationExtendedResponse 
GetFacetConfigurationExtendedResult [element GetFacetConfigurationExtendedResponse] 
GetFacets 
GetFacetsResponse 
GetFacetsResult [element GetFacetsResponse] 
GetFieldSetIdByFieldName 
GetFieldSetIdByFieldNameResponse 
GetFieldSetIdByFieldNameResult [element GetFieldSetIdByFieldNameResponse] 
GetLanguageConfiguration 
GetLanguageConfigurationResponse 
GetLanguageConfigurationResult [element GetLanguageConfigurationResponse] 
GetMetadata 
GetMetadataResponse 
GetMetadataResult [element GetMetadataResponse] 
GetRights 
GetRightsResponse 
GetRightsResult [element GetRightsResponse] 
GetSecurityToken 
GetSecurityTokenResponse 
GetSecurityTokenResult [element GetSecurityTokenResponse] 
GetSubscriptionInfo 
GetSubscriptionInfoResponse 
GetSubscriptionInfoResult [element GetSubscriptionInfoResponse] 
GetTotalAssets 
GetTotalAssetsResponse 
GetTotalAssetsResult [element GetTotalAssetsResponse] 
GetUserById 
GetUserByIdResponse 
GetUserByIdResult [element GetUserByIdResponse] 
GetUsers 
GetUsersResponse 
GetUsersResult [element GetUsersResponse] 
GlobalUser [type CoreInfo]  Session specific User data.
Group [type DerivativeDefinition] 
Group [type FacetResult] 
Groups [type FacetConfigurationJson] 
GroupSid [type ClaimGroup] 
guid 
Guid4PasswordReset [type UserData] 
Guid4PasswordReset [type UserShort] 
HasPPMCRights [type Rights] 
HasTermsAccepted [type UserData] 
Height [type PortDerivative] 
HeightInCm [type AssetObject] 
HeightInCm [type DocumentPage] 
HideBackendLink [type FacetConfigurationViewItem] 
HistoricVersionDescription [type AssetUpdateOptions]  Optional. Same logic as HistoricVersionName.
HistoricVersionDescription4Master [type AssetUpdateOptions]  Optional. Same logic as HistoricVersionName4Master.
HistoricVersionName [type AssetUpdateOptions]  Optional. The name of the newly created historic version (if param CreateHistoricVersion = true).
HistoricVersionName4Master [type AssetUpdateOptions]  Optional. The historic version name of the newly uploaded asset (if param CreateHistoricVersion = true).
Hits [type FacetValue] 
HtmlSource [type Skin] 
httpContextRequestInfo [element CreateSession] 

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.

HttpContextRequestInfo 
IconId [type AssetContainerAssignmentExtended] 
IconId [type AssetContainerItem]  The id of the icon used for the display of the asset container.
IconId [type DerivativeDefinition] 
IdentityProviderId [type ClaimGroup] 
IetfLanguageTag [type Language] 
ImageBitsPerChannel [type ExtendedDerivative] 
ImageBitsPerPixel [type ExtendedDerivative] 
ImageChannels [type ExtendedDerivative] 
ImageColorProfile [type ExtendedDerivative] 
ImageColorProfileId [type DerivativeDefinition] 
ImageColorSpaceId [type ExtendedDerivative] 
ImageColorTransformationIntentId [type DerivativeDefinition] 
ImageEncodingOptionId [type DerivativeDefinition] 
ImageHasAdobeResourceData [type ExtendedDerivative] 
ImageHasAlpha [type ExtendedDerivative] 
ImageHasExifData [type ExtendedDerivative] 
ImageHasIptcData [type ExtendedDerivative] 
ImageHasXmpData [type ExtendedDerivative] 
ImageHeight [type Derivative] 
ImageHeightInCm [type ExtendedDerivative] 
ImageHeightInInch [type ExtendedDerivative] 
ImageHorizontalResolution [type ExtendedDerivative] 
ImageIsExtended [type ExtendedDerivative] 
ImageIsIndexed [type ExtendedDerivative] 
ImageKeepClippingPath [type DerivativeDefinition] 
ImagePixelFormat [type ExtendedDerivative] 
ImageResolution [type DerivativeDefinition] 
ImageTotalFrames [type ExtendedDerivative] 
ImageTotalUnspecifiedTiffExtraChannels [type ExtendedDerivative] 
ImageUncompressedSizeInBytes [type ExtendedDerivative] 
ImageVerticalResolution [type ExtendedDerivative] 
ImageWidth [type Derivative] 
ImageWidthInCm [type ExtendedDerivative] 
ImageWidthInInch [type ExtendedDerivative] 
ImpersonatedEmailAddress [type Impersonation] 
Impersonation [type UserData] 
Impersonation 
ImpersonationId [type Impersonation] 
ImportGuid [type AssetImportOptions] 

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,

ImportGuid [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,
. ..
};

ImportGuid [type DerivativeUpdateOptions] 

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,
};

ImportRelativeFilePath [type AssetImportOptions]  Needed only for batch import, which is not available for public webservices.
ImportSingleAsset 
ImportSingleAssetResponse 
ImportSingleAssetResult [element ImportSingleAssetResponse] 
ImportUrl [type AssetImportOptions] 

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"

IncludeInAssetIndexFullTexts [type Field]  If true, this field is searched in case of a full text search.
IncludeInCustomDBIndex [type Field]  If true, this field is searched in case of a full text index.
IncludeMax [type NumericBetweenOperation]  Include upper boundarie's value in result. Lucene syntax only!
IncludeMax [type NumericSmallerThanOperation]  Include upper boundarie's value in result. Lucene syntax only!
IncludeMin [type NumericBetweenOperation]  Include lower boundarie's value in result. Lucene syntax only!
IncludeMin [type NumericLargerThanOperation]  Include lower boundarie's value in result. Lucene syntax only!
IncludeSubAssetContainers [type AssetContainerComparisonOperation] 
IncludeSubAssetContainers [type AssetContainerExcludeFieldOperation] 
IncludeSubAssetContainers [type AssetContainerIncludeFieldOperation] 
Indexes [type AssetContainerAssignmentExtended] 
Indexes [type AssetContainerItem]  An array with the indexes for each asset container language (contains the language specific absolute paths, e.g. "animals\pets\dogs\")
InitialAssetFilter [type FacetConfigurationExtended] 
insertBeforeAssetContainerId [element MoveAssetContainer] 

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.

int [type ArrayOfint] 
int 
InternalContactUserId [type UserData] 
InternalContactUserId [type UserShort] 
IsArray [type MetadataProperty] 
isAssetRightTemplateOverridden [element SaveAssetsRights] 

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.

IsAssetRightTemplateOverridden [type AssetImportOptions] 

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.

IsAssetRightTemplateOverridden [type AssetItem]  If true, the applied asset right template is ignored and the rights particularly assigned to this asset are applied.
IsAssetRightTemplateOverridden [type AssetMetadata]  If true, there are more specific access rights defined for this asset and the settings of the AppliedAssetRightTemplateId are ignored.
IsDefault [type FacetConfigurationViewItem] 
IsDefault [type Language4UserInterface] 
IsDefault [type RightTemplate] 
IsDefault [type UserGroupItem] 
IsDefaultLanguage4Content [type Language4Content] 
isDerivativeRightTemplateOverridden [element SaveDerivativeRights] 

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.

IsDerivativeRightTemplateOverridden [type AssetImportOptions]  Optional. If true, the assigned DerivativeRightTemplateId is ignored and rights specifically assigned to this derivative are applied. Default is false.
IsDerivativeRightTemplateOverridden [type AssetItem]  If true, the applied derivative right template is ignored and the rights particularly assigned to the derivatives are applied.
IsDerivativeRightTemplateOverridden [type AssetMetadata]  Same logic as with IsAssetRightTemplateOverridden.
IsFavorite [type Language4Version] 
IsFullWidth [type PortViewField] 
IsGuest [type UserData] 
IsGuest [type UserShort] 
IsGuestGroup [type UserGroupItem] 
IsInitiallyOpen [type FacetConfigurationElement] 
IsInitiallyOpen [type FacetConfigurationGroup] 
IsInitiallyOpen [type FacetResult] 
IsLanguageSpecific [type Field]  Language specific fields like AssetName and AssetDescription may have different values depending on the language.
IsMappable [type MetadataProperty] 
IsNeutralCulture [type Language] 
IsOpen [type FacetResult] 
IsReadOnly [type Field]  A read only field can be updated only by the system, not by a user.
IsRequired [type Field]  If true, this field cannot be empty or null.
IsRequired [type Language4Metadata] 
isRightTemplateOverridden [element SaveAssetContainerRights]  If true, the right template is not used.
IsRightTemplateOverridden [type AssetContainerItem]  If true, the applied right template is ignored and the rights particularly assigned to this asset container are applied.
IsSelected [type FacetValue] 
IsSupport [type UserData] 
IsSupportContact [type UserData] 
IsSupportContact [type UserShort] 
IsSystemField [type Field]  A system field like Sha1Hash or Fulltext is needed for programming purposes and not visible for a user.
IsUpdaterServiceUser [type UserData] 
IsUpdaterServiceUser [type UserShort] 
IsValid 
IsValidResponse 
IsValidResult [element IsValidResponse] 
JsonSerializedSvgAttributes [type AssetObject] 
KeepAssetId4NewFileOnHistorize [type AssetUpdateOptions]  If true, the new file inherits the asset id of the old.
KeepOriginalFileName [type DownloadOptions]  If false the original filename is taken and the configured download filename rules are ignored.
Key [type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h/KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h] 
Key [type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK/KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK] 
Key [type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe/KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe] 
Key [type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe/KeyValueOfintArrayOfFieldRightuUS27HWe] 
Key [type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe/KeyValueOfintArrayOfPersonalItemRightuUS27HWe] 
Key [type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe/KeyValueOfintArrayOfSiteRightuUS27HWe] 
Key [type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe/KeyValueOfintArrayOfUserGroupRightuUS27HWe] 
Key [type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe/KeyValueOfintArrayOfWidgetRightuUS27HWe] 
Key [type ArrayOfKeyValueOfintPortViewField6jg_STziK/KeyValueOfintPortViewField6jg_STziK] 
KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h [type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h] 
KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK [type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK] 
KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe] 
KeyValueOfintArrayOfFieldRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe] 
KeyValueOfintArrayOfPersonalItemRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe] 
KeyValueOfintArrayOfSiteRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe] 
KeyValueOfintArrayOfUserGroupRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe] 
KeyValueOfintArrayOfWidgetRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe] 
KeyValueOfintPortViewField6jg_STziK [type ArrayOfKeyValueOfintPortViewField6jg_STziK] 
KnownFieldValue [type ArrayOfKnownFieldValue] 
KnownFieldValue 
KnownFieldValueAssetContainerAssignment 
KnownFieldValueBoolean 
KnownFieldValueDateTime 
KnownFieldValueDouble 
KnownFieldValueInteger32 
KnownFieldValueInteger64 
KnownFieldValueString 
KnownFieldValueUserShort 
language [element CreateSession] 

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.

Language [type Language4AssetContainer] 
Language [type Language4Content] 
Language [type Language4FullTextIndex] 
Language [type Language4Metadata] 
Language [type Language4UserInterface] 
Language [type Language4Version] 
Language [type PictureparkFault] 
Language [type User]  The gui language for this user, which is stored in the user profile, e.g. "English".
Language 
Language4AssetContainer [type ArrayOfLanguage4AssetContainer] 
Language4AssetContainer 
Language4AssetContainerId [type Language4AssetContainer] 
Language4Content [type ArrayOfLanguage4Content] 
Language4Content 
language4ContentId [element CreateSession] 

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.

language4ContentId [element LoginWithSecurityToken2]  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).
Language4ContentId [type Language4Content] 
Language4ContentId [type User] 

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.

Language4FullTextIndex [type ArrayOfLanguage4FullTextIndex] 
Language4FullTextIndex 
Language4FullTextIndexId [type Language4FullTextIndex] 
Language4Metadata [type ArrayOfLanguage4Metadata] 
Language4Metadata 
Language4MetadataId [type Language4Metadata] 
Language4MetadataId [type LanguageFallback] 
Language4UserInterface [type ArrayOfLanguage4UserInterface] 
Language4UserInterface 
Language4UserInterfaceId [type Language4UserInterface] 
Language4Version [type ArrayOfLanguage4Version] 
Language4Version 
Language4VersionId [type Language4Version] 
LanguageConfiguration 
LanguageFallback [type ArrayOfLanguageFallback] 
LanguageFallback 
LanguageFallbackId [type LanguageFallback] 
LanguageFallbacks [type Language4Metadata] 
LanguageId [type AssetContainerIndex] 
LanguageId [type AssetContainerTranslation]  The language id (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..).
LanguageId [type AssetVersion] 
LanguageId [type CountryTranslation] 

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.

LanguageId [type DerivativeDefinitionTranslation] 
LanguageId [type FacetConfigurationTranslation] 
LanguageId [type FieldOptionTranslation] 
LanguageId [type FieldTranslation] 
LanguageId [type FieldValue] 
LanguageId [type KnownFieldValueString] 
LanguageId [type Language] 
LanguageId [type Language4AssetContainer] 
LanguageId [type Language4Metadata] 
LanguageId [type Language4UserInterface] 
LanguageId [type Language4Version] 
LanguageId [type UserData] 
LanguageId [type UserGroupTranslation] 
LanguageId [type UserShort] 
Languages4AssetContainers [type LanguageConfiguration] 
Languages4Contents [type LanguageConfiguration] 
Languages4FullTextIndexes [type LanguageConfiguration] 
Languages4Metadata [type LanguageConfiguration] 
Languages4UserInterfaces [type LanguageConfiguration] 
Languages4Version [type LanguageConfiguration] 
LanguageTranslation [type Language] 
LargePageImageMaxHeight [type Document] 
LargePageImageMaxWidth [type Document] 
LargePageImageResolution [type DocumentPage] 
LargePageImageUrl [type DocumentPage] 
LargerThanNumeric [type NumericBetweenOperation] 
LargerThanNumeric [type NumericLargerThanOperation] 
LargeThumbnailUrl [type PortAssetItem] 
LastActiveFacetConfigurationId [type UserData] 
LastActiveFacetConfigurationId [type UserShort] 
LastLoginDate [type UserData] 
LastLoginDate [type UserShort] 
LastName [type UserCompact] 
LastName [type UserData] 
LastName [type UserShort] 
LdapSecurityGroup [type ArrayOfLdapSecurityGroup] 
LdapSecurityGroup 
LdapSecurityGroups [type UserGroupItem] 
leaf [type XmpItem] 
limit [element GetAssetLinksById]  Number of maximally returned itens.
limit [element GetUsers]  Optional. The maximal number of rows returned. Default is unlimited.
Limit [type ExtendedAssetFilter]  Optional. The maximal number of assets returned. Default is unlimited.
LinkedAssetId [type AssetObject] 
LinkedGlobalUserId [type UserShort] 
LinkedUrl [type AssetObject] 
LinkToken [type BusinessProcessShort] 
ListViewFieldGroupId [type FacetConfigurationViewItem] 
ListViewFields [type PortAssetItem] 
LockDate [type UserData] 
LockDate [type UserShort] 
LogicalOperation [type ArrayOfLogicalOperation] 
LogicalOperation 
LogicalOperations [type AndOperation] 
LogicalOperations [type AssetContainerAndOperation] 
LogicalOperations [type AssetContainerOrOperation] 
LogicalOperations [type OrOperation] 
Login 
LoginOnlyWithClaimsIdentity [type UserData] 
LoginOnlyWithClaimsIdentity [type UserShort] 
LoginOnlyWithSecurityToken [type UserData] 
LoginOnlyWithSecurityToken [type UserShort] 
LoginResponse 
LoginResult [element LoginResponse] 
LoginStatus [type User]  LoggedIn, NotLoggedIn or LoggedInAsGuest.
LoginStatus 
LoginWithSecurityToken 
LoginWithSecurityToken2 
LoginWithSecurityToken2Response 
LoginWithSecurityToken2Result [element LoginWithSecurityToken2Response] 
LoginWithSecurityTokenResponse 
LoginWithSecurityTokenResult [element LoginWithSecurityTokenResponse] 
LogoutUrl [type FacetConfigurationViewItem] 
long 
MailingRecipientId [type DownloadOptions]  Needed only for logging purposes.
MailingUrl [type BusinessProcessShort] 
MailingUrlForDownload [type BusinessProcessShort] 
MailingUrlsForDownload [type BusinessProcessShort] 
MailingUrlsForView [type BusinessProcessShort] 
MasterVersions [type AssetItem]  See above under AssetVersions.
MasterVersions [type AssetMetadata] 

An array with all master AssetVersions for this asset.

This array contains all assets which are a parent version for this asset.

Max [type FacetValue] 
MaxTextLength [type FieldControlInfos]  Max count of chars.
MediaInfo [type ArrayOfMediaInfo] 
MediaInfo 
MediaInfos [type AssetMetadata]  A list of MediaInfos if the asset is an audio or a video.
MediaTypeCounts [type AssetItemCollection] 

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.

MediaTypeIds [type ExtendedAssetFilter] 

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}
MediumThumbnailUrl [type PortAssetItem] 
Message [type PictureparkFault] 
MetadataMapping [type Field] 

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.

MetadataParentPropertyId [type MetadataProperty] 
MetadataProperty [type ArrayOfMetadataProperty] 
MetadataProperty 
MetadataPropertyId [type MetadataProperty] 
MetadataSchema [type MetadataProperty] 
MetadataSchema 
MetadataSchemaId [type MetadataProperty] 
MetadataSchemaId [type MetadataSchema] 
Min [type FacetValue] 
Minutes [type DateTimeNowAfterOperation] 
Minutes [type DateTimeNowAfterOrEqualOperation] 
Minutes [type DateTimeNowBeforeOrEqualOperation] 
Minutes [type DateTimeNowLastOperation] 
Minutes [type DateTimeNowNextOperation] 
Minutes [type DateTimeNowOlderOperation] 
ModificationDate [type AssetContainerItem]  The modification date.
ModificationDate [type AssetVersion] 
ModificationDate [type DerivativeLock] 
ModificationDate [type ExtendedDerivative] 
ModificationDate [type RightTemplate] 
ModificationDate [type RightTemplate2AssetType] 
ModificationDate [type RightTemplate2Right] 
ModificationDate [type RightTemplate2UserGroup] 
ModificationDate [type Skin] 
ModificationDate [type UserData] 
ModificationDate [type UserShort] 
ModifiedByUserId [type AssetContainerItem]  The id of the last user who edited the container.
ModifiedByUserId [type AssetVersion] 
ModifiedByUserId [type DerivativeLock] 
ModifiedByUserId [type RightTemplate] 
ModifiedByUserId [type RightTemplate2AssetType] 
ModifiedByUserId [type RightTemplate2Right] 
ModifiedByUserId [type RightTemplate2UserGroup] 
ModifiedByUserId [type Skin] 
ModifiedByUserId [type UserData] 
ModifiedByUserId [type UserShort] 
MoveAssetContainer 
MoveAssetContainerResponse 
name [element CreateAssetLink]  The name.
name [element GetFacetConfigurationExtended]  The facet name.
Name [type AssetContainerTranslation]  The asset container name in the language defined by LanguageId.
Name [type BusinessProcessShort] 
Name [type Country] 
Name [type DerivativeDefinition] 
Name [type DerivativeDefinitionTranslation] 
Name [type FacetConfigurationRange] 
Name [type FacetConfigurationViewItem] 
Name [type Field]  The field name, e.g. AssetName, AssetDescription, FileSizeInBytes, CDF8 ..
Name [type RightTemplate] 
Name [type Skin] 
Name [type UserGroupTranslation] 
Name [type XmpItem] 
NamesOfMappedSitesWithSiteRightManage [type Skin] 
NeedsAllRights [type UserGroupItem] 
NeedsAllUserRights [type UserGroupItem] 
NewFlagDays [type FacetConfigurationViewItem] 
NotContainsString [type StringNotContainsOperation] 
NotEqualNumeric [type NumericNotEqualOperation] 
NotEqualString [type StringNotEqualOperation] 
NumericBetweenOperation 
NumericEqualOperation 
NumericLargerThanOperation 
NumericListEqualOperation 
NumericNotEqualOperation 
NumericSmallerThanOperation 
offset [element UploadChunk]  The start index of the current chunk in the source/destination file.
OffsetMinutes [type DateTimeOffset] 
onlyActive [element GetUsers]  Get only active users.
OnlyCreateOriginalDerivative [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.

OnlyCreateOriginalDerivative [type AssetUpdateOptions] 

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.

onlyExpired [element GetUsers]  Get only expired users.
onlyExpiredRenewals [element GetUsers]  Get only users with expired renewals.
onlyLocked [element GetUsers]  Get only locked users.
openAssetContainerId [element GetAssetContainers] 

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..)

Options [type Field] 

An array with all available options for this field.

Needed for ComboBox- and MultiCheckbox fields).

OrderableDerivatives [type PortAssetItem] 

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.

OriginalDerivative [type AssetMetadata] 

Original ExtendedDerivative.

The data for the original are always returned, even if there are no access rights to the original.

OriginalDerivativeModificationDate [type DerivativeLock] 
OrOperation 
OutputFileExtensionId [type DerivativeDefinition] 
OverallBitRate [type MediaInfo] 
OverlayFieldId [type FacetConfigurationViewItem] 
OverlayText [type PortAssetItem] 
OverviewFieldGroupId [type FacetConfigurationViewItem] 
OverviewFields [type PortAssetItem] 
OverviewUiElementId [type FacetConfigurationViewItem] 
OverviewUrl [type FacetConfigurationViewItem] 
PageNumber [type DocumentPage] 
ParentAsset [type AssetMetadata] 

An array with all parent AssetItems.

An asset can have more than one parent.

parentAssetContainerId [element CreateAssetContainer]  The id of the asset container where the new container is created.
parentAssetContainerId [element GetAssetContainers]  The id of the AssetContainer (category or asset class) for which the children are to be returned.
ParentAssetContainerId [type AssetContainerItem]  The id of the parent asset containert, is null for containers on the highest level.
ParentAssetId [type AssetMetadata]  The id of the parent asset.
ParentAssetId [type AssetVersion]  The id of the parent asset. Null, if this version is a master.
password [element CreateUser]  The password. Must have the minimum strength as defined for this customer.
Password [type User]  The password must be submitted for Login, but is never returned.
Permissions [type AssetContainerItem]  An array with the AssetContainerRights for the current user.
PersonalItemRight [type ArrayOfPersonalItemRight] 
PersonalItemRight 
PersonalItemRights [type Rights] 
Phone [type UserData] 
Phone [type UserShort] 
PictureparkErrorType 
PictureparkFault 
PictureparkVersion [type PublicConfiguration] 
PortAssetItem [type ArrayOfPortAssetItem] 
PortAssetItem 
PortAssetItemCollection 
PortDerivative [type ArrayOfPortDerivative] 
PortDerivative 
portName [element GetAssets2] 
PortViewField 
Position [type PortViewField] 
PositionLeftInCm [type AssetObject] 
PositionTopInCm [type AssetObject] 
PropertyName [type MetadataProperty] 
ProvideAsDownload [type DerivativeDefinition] 
ProvidedSearchFilter [type FacetResults]  Holds the asset filter that has been provided for searching
provideUniqueFileName [element DownloadExtended] 

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.

PublicAbsoluteUrl [type Derivative]  E.g. http://picturepark.vit.local/Public/1/ThumbnailSmall/1031.jpg.
PublicConfiguration 
QName 
Range [type FacetValue] 
RangeConfiguration [type FacetValue] 
Ranges [type FacetConfigurationElement] 
ReferencedAssets [type AssetMetadata]  An array with all AssetItems to which this asset refers (from Documents).
ReferringAssets [type AssetMetadata]  An array with all AssetItems which refer to this asset (from AssetObjects).
registrationState [element GetUsers]  Optional. The RegistrationState, if you wish to get only users with a certain regristration state.
RegistrationState [type UserData] 
RegistrationState 
RegistrationStateId [type UserShort] 
RelativeBasePath [type DerivativeDefinition] 
RelativeFilePath [type AssetObject] 
RemainingHits [type FacetResult] 
RemainingTerms [type FacetResult] 
RemainingTermsCount [type FacetResult] 
RemoveAssetContainer 
RemoveAssetContainerResponse 
RemoveAssets 
RemoveAssetsFromAssetContainers 
RemoveAssetsFromAssetContainersResponse 
RemoveAssetsResponse 
RemoveAssetVersions 
RemoveAssetVersionsResponse 
RemoveUsers 
RemoveUsersResponse 
RenderingActionArgumentId [type RenderingActionArgumentValue] 
RenderingActionArgumentValue [type ArrayOfRenderingActionArgumentValue] 
RenderingActionArgumentValue 
RenderingActionArgumentValueId [type RenderingActionArgumentValue] 
RenderingActionArgumentValues [type RenderingActionValue] 
RenderingActionId [type RenderingActionValue] 
RenderingActionValue [type ArrayOfRenderingActionValue] 
RenderingActionValue 
RenderingActionValueId [type RenderingActionArgumentValue] 
RenderingActionValueId [type RenderingActionValue] 
RenderingActionValues [type DerivativeDefinition] 
renderingClient [element CreateRenderingJob]  The RenderingClient.
RenderingClient 
renderingJobId [element ImportSingleAsset] 

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.

renderingJobId [element SaveDerivative] 

The rendering job id.

Call CreateRenderingJob to get a renderingJobId. This allows several updates to be pooled to one job.

renderingJobId [element UpdateOriginalDerivative] 

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.

RenderingState [type Derivative]  Technical flag concerning the rendering state.
RenderingState 
renewalState [element GetUsers]  Optional. The RenewalState, if you wish to get only users with a certain renewal state.
RenewalState [type UserData] 
RenewalState 
RenewalStateId [type UserShort] 
RenewalUntilDate [type UserData] 
RenewalUntilDate [type UserShort] 
RenewSession 
RenewSessionResponse 
RenewSessionResult [element RenewSessionResponse] 
ReplaceDelimiters [type Field]  If true, field value will be splitted and formated by its special characters. The results will be added to the full text search index.
Results [type FacetResults]  A result per field (facet)
ReturnAllLanguages [type AssetFilter]  Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage.
ReturnAllQueryAssetIds [type AssetFilter] 

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.

ReturnMediaTypeCounts [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

Rights 
RightTemplate [type ArrayOfRightTemplate] 
RightTemplate 
RightTemplate2AssetType [type ArrayOfRightTemplate2AssetType] 
RightTemplate2AssetType 
RightTemplate2AssetTypeId [type RightTemplate2AssetType] 
RightTemplate2Right [type ArrayOfRightTemplate2Right] 
RightTemplate2Right 
RightTemplate2RightId [type RightTemplate2Right] 
RightTemplate2UserGroup [type ArrayOfRightTemplate2UserGroup] 
RightTemplate2UserGroup 
RightTemplate2UserGroupId [type RightTemplate2UserGroup] 
rightTemplateId [element SaveAssetContainerRights]  The id of a right template.
rightTemplateId [element SaveAssetsRights] 

The id of the right template.

Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true).

rightTemplateId [element SaveDerivativeRights] 

The id of the right template.

Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true).

RightTemplateId [type RightTemplate] 
RightTemplateId [type RightTemplate2AssetType] 
RightTemplateId [type RightTemplate2Right] 
RightTemplateId [type RightTemplate2UserGroup] 
RightTemplateRight [type RightTemplate2UserGroup] 
RightTemplateRight 
RightTemplates [type Rights] 
RightTemplates2AssetTypes [type RightTemplate] 
RightTemplates2Rights [type RightTemplate] 
RightTemplates2UserGroups [type RightTemplate] 
RightTemplateType [type RightTemplate] 
RightTemplateType 
RootSiteUrl [type UserShort] 
RotationInDegrees [type DocumentPage] 
SaveAssetContainerRights 
SaveAssetContainerRightsResponse 
SaveAssetsRights 
SaveAssetsRightsResponse 
SaveDerivative 
SaveDerivativeResponse 
SaveDerivativeRights 
SaveDerivativeRightsResponse 
Schema [type MetadataSchema] 
SearchDesiredMetadataLanguageOnly [type ExtendedAssetFilter]  Optional. If true, a search is done only within language specific metadata. Default: false.
SearchFilter [type FacetSearchParameter] 
SearchOnlyDeletedAssets [type ExtendedAssetFilter]  Optional.
SearchOperation [type ExtendedAssetFilter] 

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 ..
}

searchParameters [element GetFacets]  A list of FacetSearchParameter.
searchString [element GetAssetContainers] 

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.

searchString [element GetUsers]  Optional. A search string, e.g. "berg". Leave empty, if you wish to get all users.
SecurityGroupDistinguishedName [type LdapSecurityGroup] 
securityToken [element LoginWithSecurityToken]  The security token, which has been returned by GetSecurityToken.
securityToken [element LoginWithSecurityToken2]  The security token, which has been returned by GetSecurityToken.
SelectedAssets [type BusinessProcessShort] 
selectedFacetValues [element GetFacets]  A list of FacetValue, can be null.
SelectionBehavior [type FacetConfigurationElement] 
SelectionBehavior [type FacetResult] 
SessionId [type CoreInfo]  A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session.
Sha1Hash [type ExtendedDerivative] 
ShareListViewFieldGroupId [type FacetConfigurationViewItem] 
ShareOverviewFieldGroupId [type FacetConfigurationViewItem] 
short 
ShortName [type DerivativeDefinitionTranslation] 
SimpleSearchString [type ExtendedAssetFilter] 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

SiteId [type UserData] 
SiteRight [type ArrayOfSiteRight] 
SiteRight 
SiteRights [type Rights] 
skin [element CreateSession] 

Optional. Available options: "SkinColor.Blue" and "SkinColor.Gray".

SkinColor? skin = SkinColor.Blue;
Skin [type FacetConfigurationViewItem] 
Skin [type User]  Available options:Gray=0, Blue=1, White=2.
Skin 
SkinColor 
SkinId [type FacetConfigurationViewItem] 
SkinId [type Skin] 
SmallerThanNumeric [type NumericBetweenOperation] 
SmallerThanNumeric [type NumericSmallerThanOperation] 
SmallPageImageMaxHeight [type Document] 
SmallPageImageMaxWidth [type Document] 
SmallPageImageResolution [type DocumentPage] 
SmallPageImageUrl [type DocumentPage] 
SmallThumbnailUrl [type PortAssetItem] 
SortChildrenAlphabetically [type AssetContainerItem] 

Flag: sort child nodes alphabetically.

If true, child nodes are sorted alphabetically and sort order numbering is ignored.

sortDirection [element GetUsers]  Optional. The SortDirection (ascending or descending), default is ascending.
SortDirection [type SortInfo] 
SortDirection 
sortField [element GetUsers]  Optional. A sortfield, e.g. "EmailAddress".
SortField [type SortInfo] 
SortInfo [type ArrayOfSortInfo] 
SortInfo 
SortInfos [type ExtendedAssetFilter] 

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 });

SortOrder [type AssetContainerItem]  The relative sort order of siblings.
SortOrder [type AssetObject] 
SortOrder [type AssetVersion] 
SortOrder [type DerivativeDefinition] 
SortOrder [type FacetConfigurationElement] 
SortOrder [type FacetConfigurationGroup] 
SortOrder [type FacetConfigurationRange] 
SortOrder [type FacetResult] 
SortOrder [type FacetValue] 
SortOrder [type FieldOption] 
SortOrder [type Language4Metadata] 
SortOrder [type Language4UserInterface] 
SortOrder [type Language4Version] 
SortOrder [type LanguageFallback] 
SortOrder [type RenderingActionValue] 
SortOrder [type RightTemplate] 
Source [type FieldValue] 
sourceAssetContainerId [element MoveAssetContainer]  The id of the source asset container.
start [element GetUsers]  Optional. The row in the query, from where on to return the users. Default is 0.
startRow [element GetAssetLinksById]  Start row.
StartRow [type ExtendedAssetFilter]  Optional. The row in the query, from where on to return the assets. Default is 0.
StartsWithString [type StringStartsWithOperation] 
stream [element UploadFile]  A file stream
string [type ArrayOfstring] 
string 
StringContainsOperation 
StringEmptyOperation 
StringEqualOperation 
StringListContainsExactOperation 
StringListContainsOperation 
StringListEqualOperation 
StringNotContainsOperation 
StringNotEmptyOperation 
StringNotEqualOperation 
StringStartsWithOperation 
StringValue [type KnownFieldValue] 
SubAssetContainers [type AssetContainerItem]  The number of child nodes (children only, not grand children etc).
subscriptionActionId [element ConfirmSubscriptionInfoReceived]  The id of the subscription action.
subscriptionActionId [element GetSubscriptionInfo]  The id of the subscription action.
substituteUserId [element RemoveUsers] 

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.

SubTitle [type PortAssetItem]  The asset's sub title in more detailed views.
SuggestionSource 
SuggestionSourceId [type FacetConfigurationViewItem] 
Sum [type FacetValue] 
TagBoxShowFullPath [type FieldControlInfos]  Should the TagBox show the full path or only the Tag (AssetContainerName).
TemporaryFileHandling [type AssetUpdateOptions] 

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

TemporaryFileHandling [type DerivativeUpdateOptions] 

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

TemporaryFileHandling 
TermsAndConditions [type FacetConfigurationViewItem] 
Title [type FacetConfigurationViewItem] 
Title [type PortAssetItem]  The asset's title which is used all over the new port (in most cases it'll be the field AssetName).
To [type FacetDateRange] 
ToNumeric [type FacetConfigurationRange] 
ToolTip [type FieldTranslation] 
TotalAssets [type AssetContainerTotalAssets] 
TotalAssets [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.

TotalAssets [type PortAssetItemCollection] 

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.

TotalCountOfSiteMappings [type Skin] 
totalLayers [element GetAssetContainers]  Number of layers (children, grand-children ..) to be returned. 1 = only the parentAssetContainerId is returned, 0 = all.
TotalTextAreaRows [type FieldControlInfos]  The numbers of rows of a textarea.
TotalUserActionHistoryInfos [type UserActionHistoryInfoCollection] 
TotalUsers [type UserCollection]  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.
traceJobId [element CreateSession] 

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.

traceJobId [element GetSecurityToken] 

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.

TraceJobId [type CoreInfo] 

Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.".

Needed for tracing purposes only.

traceJobType [element CreateTraceJob]  The TraceJobType.
TraceJobType 
TraceUsagePurpose [type PortDerivative] 
TrackUsagePurpose [type DerivativeDefinition] 
transferGuid [element UploadChunk]  The guid which has been returned by UploadFirstChunk
Translation [type Field] 

The field data in the language of the current user.

Translation.Caption contains the field name in this language.

Translations [type AssetContainerAssignmentExtended] 
Translations [type AssetContainerItem]  An array with the AssetContainerTranslations (names and descriptions) for each asset container language.
Translations [type DerivativeDefinition] 
Translations [type FacetConfigurationGroup]  Used for configuration (read / save)
Translations [type FacetConfigurationRange]  Used for configuration (read / save)
Translations [type Field]  Currently not used.
Translations [type FieldOption] 
Translations [type UserGroupItem] 
ts [type AssetContainerIndex] 
ts [type AssetContainerItem] 
ts [type AssetContainerTranslation] 
ts [type AssetObject] 
ts [type AssetVersion] 
ts [type BusinessProcessShort] 
ts [type Derivative] 
ts [type DerivativeDefinition] 
ts [type DerivativeDefinition2AssetType] 
ts [type DerivativeDefinitionTranslation] 
ts [type DerivativeLock] 
ts [type Document] 
ts [type DocumentPage] 
ts [type Field]  Time stamp.
ts [type FieldControlInfos]  Time stamp.
ts [type FieldOption] 
ts [type FieldOptionTranslation] 
ts [type FieldTranslation] 
ts [type FieldValue] 
ts [type Language] 
ts [type Language4AssetContainer] 
ts [type Language4Content] 
ts [type Language4FullTextIndex] 
ts [type Language4Metadata] 
ts [type Language4UserInterface] 
ts [type Language4Version] 
ts [type LanguageFallback] 
ts [type LdapSecurityGroup] 
ts [type MetadataProperty] 
ts [type MetadataSchema] 
ts [type RenderingActionArgumentValue] 
ts [type RenderingActionValue] 
ts [type RightTemplate] 
ts [type RightTemplate2AssetType] 
ts [type RightTemplate2Right] 
ts [type Skin] 
ts [type UserData] 
ts [type UserGroupItem] 
ts [type UserGroupTranslation] 
ts [type UserShort] 
Type [type PictureparkFault] 
UnassignedAssetsOnly [type ExtendedAssetFilter]  Optional. If true, only assets which are in no category are returned. Default: false.
unsignedByte 
unsignedInt 
unsignedLong 
unsignedShort 
UpdateAssetContainer 
UpdateAssetContainerResponse 
UpdateAssetLinks 
UpdateAssetLinksResponse 
UpdateAssetMetadata 
UpdateAssetMetadataResponse 
UpdateAssetsMetadata 
UpdateAssetsMetadataResponse 
UpdateFieldSetDefaultValue 
UpdateFieldSetDefaultValueResponse 
UpdateOriginalDerivative 
UpdateOriginalDerivativeResponse 
updateStatistic [element GetMetadata]  If true, the action is recorded in the statistics table.
UpdateUser 
UpdateUserResponse 
UploadChunk 
UploadChunkResponse 
UploadFile 
UploadFileResponse 
UploadFileResult [element UploadFileResponse] 
UploadFirstChunk 
UploadFirstChunkResponse 
UploadFirstChunkResult [element UploadFirstChunkResponse] 
URL [type Download] 
UrlEntryPoint [type HttpContextRequestInfo]  E.g. "https//customer.picturepark.com/Website/default.aspx".
UrlReferrer [type HttpContextRequestInfo]  E.g. "http://start-picturepark.vit.local/development/"
UrlThumbnailSmall [type AssetFieldValues]  The small thumbnail for preview in batch editor.
UrlThumbnailSmall [type DerivativeLock] 
UrlThumbnailSmall [type UserActionHistoryInfo] 
UsagePurpose [type DownloadOptions]  Any text, needed only for logging purposes.
Use4AssetConversion [type DerivativeDefinition] 
Use4Preview [type PortDerivative] 
UseGuid4FileName [type DerivativeDefinition] 
UseLdapAuthentication [type UserData] 
UseLdapAuthentication [type UserShort] 
UsePublicFileDirectory [type DerivativeDefinition] 
User [type CoreInfo]  Session specific User data.
User 
UserAction [type DownloadOptions]  Needed for logging purposes. Must be one of DerivativeDownload, DerivativeView or AssetReplication.
UserAction [type UserActionHistoryInfo] 
UserAction 
UserActionDate [type UserActionHistoryInfo] 
UserActionHistoryId [type UserActionHistoryInfo] 
UserActionHistoryInfo [type ArrayOfUserActionHistoryInfo] 
UserActionHistoryInfo 
UserActionHistoryInfoCollection 
UserActionHistoryInfos [type UserActionHistoryInfoCollection] 
UserAgent [type HttpContextRequestInfo]  E.g. "Mozilla/5.0 (Windows NT 6.1; rv:2.0) Gecko/20100101 Firefox/4.0".
UserCollection 
UserCompact 
userData [element CreateUser]  UserData for the new user.
userData [element GetSecurityToken]  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.
userData [element UpdateUser]  The (modified) UserData.
UserData 
UserDerivativeRights [type ArrayOfUserDerivativeRights] 
UserDerivativeRights 
UserGroup [type UserDerivativeRights] 
UserGroup [type UserGroupAssetContainerRights] 
UserGroup [type UserGroupAssetRights] 
UserGroup [type UserGroupDerivativeRights] 
UserGroup [type UserGroupItem] 
UserGroup2LdapSecurityGroupId [type LdapSecurityGroup] 
userGroupAssetContainerRights [element SaveAssetContainerRights]  The list of UserGroupAssetContainerRights which defines the rights for each usergroup in the list.
UserGroupAssetContainerRights [type ArrayOfUserGroupAssetContainerRights] 
UserGroupAssetContainerRights 
userGroupAssetRights [element SaveAssetsRights]  List<UserGroupAssetRights>
UserGroupAssetRights [type ArrayOfUserGroupAssetRights] 
UserGroupAssetRights [type AssetImportOptions] 

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

UserGroupAssetRights 
userGroupDerivativeRights [element SaveDerivativeRights]  List of datatype UserGroupDerivativeRights.
UserGroupDerivativeRights [type ArrayOfUserGroupDerivativeRights] 
UserGroupDerivativeRights [type AssetImportOptions]  Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter.
UserGroupDerivativeRights 
userGroupId [element GetUsers]  Optional. The id of a user group, if you wish to get only users from a certain group.
UserGroupId [type ClaimGroup] 
UserGroupId [type LdapSecurityGroup] 
UserGroupId [type RightTemplate2Right] 
UserGroupId [type RightTemplate2UserGroup] 
UserGroupId [type UserGroupItem] 
UserGroupId [type UserGroupTranslation] 
UserGroupIds [type UserData] 
UserGroupItem 
UserGroupRight [type ArrayOfUserGroupRight] 
UserGroupRight 
UserGroupRightId [type RightTemplate2Right] 
UserGroupRights [type Rights] 
UserGroups [type User]  Array of the ids of the assigned user groups.
UserGroups2ClaimGroupId [type ClaimGroup] 
UserGroupTranslation [type ArrayOfUserGroupTranslation] 
UserGroupTranslation 
UserGroupTranslationId [type UserGroupTranslation] 
UserHostAddress [type HttpContextRequestInfo]  The ip address of the user host.
UserHostName [type HttpContextRequestInfo]  The DNS name of the user host.
userId [element GetUserById]  The id of the user.
UserId [type DerivativeLock] 
UserId [type FieldValue] 
UserId [type User] 
UserId [type UserCompact] 
UserId [type UserData] 
UserId [type UserShort] 
userIds [element RemoveUsers]  A list of user ids.
UserRight [type ArrayOfUserRight] 
UserRight 
UserRightId [type RightTemplate2Right] 
UserRights [type Rights] 
Users [type UserCollection]  An array of UserShort.
UserShort [type ArrayOfUserShort] 
UserShort 
UseVideo4Thumbnails [type DerivativeDefinition] 
ValidationRegEx [type Field]  A regular expression used to check the input data, e.g. to enforce the input of an email address in a correct format.
Value [type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h/KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h] 
Value [type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK/KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK] 
Value [type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe/KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe] 
Value [type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe/KeyValueOfintArrayOfFieldRightuUS27HWe] 
Value [type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe/KeyValueOfintArrayOfPersonalItemRightuUS27HWe] 
Value [type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe/KeyValueOfintArrayOfSiteRightuUS27HWe] 
Value [type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe/KeyValueOfintArrayOfUserGroupRightuUS27HWe] 
Value [type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe/KeyValueOfintArrayOfWidgetRightuUS27HWe] 
Value [type ArrayOfKeyValueOfintPortViewField6jg_STziK/KeyValueOfintPortViewField6jg_STziK] 
Value [type KnownFieldValueAssetContainerAssignment] 
Value [type KnownFieldValueBoolean] 
Value [type KnownFieldValueDateTime] 
Value [type KnownFieldValueDouble] 
Value [type KnownFieldValueInteger32] 
Value [type KnownFieldValueInteger64] 
Value [type KnownFieldValueString] 
Value [type KnownFieldValueUserShort] 
Value [type RenderingActionArgumentValue] 
Value [type XmpItem] 
ValueAssetContainerAssignment [type FieldValue] 
ValueAssetContainerId [type FieldValue] 
ValueBoolean [type FieldValue] 
ValueDate [type FieldValue] 
ValueDateTime [type FieldValue] 
ValueDouble [type FieldValue] 
ValueInteger32 [type FieldValue] 
ValueInteger64 [type FieldValue] 
Values [type FacetResult] 
Values [type PortViewField] 
ValueString [type FieldOption] 
ValueString [type FieldOptionTranslation] 
ValueString [type FieldValue] 
ValueUserShort [type FieldValue] 
Version [type AssetVersion]  The name of the version, e.g. "English" or "French".
Version 
VersionOptionId [type AssetVersion] 
VersionOptionId [type PortDerivative] 
VersionTypeId [type AssetVersion] 

Versiontypes are e.g. Languages, History, Associated, Presentation etc.

They are individually configurable for each Picturepark. Language usually exists and has the id = 1.

VersionTypeId [type PortDerivative] 
VersionTypeIds [type ExtendedAssetFilter] 

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 }
VideoAudioBitrate [type DerivativeDefinition] 
VideoAudioCodecId [type DerivativeDefinition] 
VideoBitrate [type DerivativeDefinition] 
VideoBitRate [type VideoStream] 
VideoCodec [type VideoStream] 
VideoCodecId [type DerivativeDefinition] 
VideoCount [type MediaInfo] 
VideoDisplayAspectRatio [type VideoStream] 
VideoDuration [type VideoStream] 
VideoDurationInSeconds [type Derivative] 
VideoFormat [type VideoStream] 
VideoFrameCount [type VideoStream] 
VideoFrameRate [type VideoStream] 
VideoHeight [type Derivative] 
VideoHeight [type VideoStream] 
VideoLanguage [type VideoStream] 
VideoPixelAspectRatio [type VideoStream] 
VideoResolution [type VideoStream] 
VideoRotation [type VideoStream] 
VideoStream [type ArrayOfVideoStream] 
VideoStream 
VideoStreams [type MediaInfo] 
VideoStreamSize [type VideoStream] 
VideoWidth [type Derivative] 
VideoWidth [type VideoStream] 
WidgetRight [type ArrayOfWidgetRight] 
WidgetRight 
WidgetRights [type Rights] 
Width [type PortDerivative] 
WidthInCm [type AssetObject] 
WidthInCm [type DocumentPage] 
WriteXmp2File [type DerivativeDefinition] 
XmpItem [type ArrayOfXmpItem] 
XmpItem 
XmpItems [type AssetMetadata]  An array with XmpItems if the asset is an image and metadata mapping is enabled.
XmpOutOfSync [type AssetItem]  Technical flag concerning the rendering state.
XmpSyncFailed [type AssetItem]  Technical flag concerning the rendering state.
Zip [type UserData] 
Zip [type UserShort] 

Element: _Build [type Version]

Derived By

Type int

Referenced By

Element: _Major [type Version]

Derived By

Type int

Referenced By

Element: _Minor [type Version]

Derived By

Type int

Referenced By

Element: _Revision [type Version]

Derived By

Type int

Referenced By

Element: Abbreviation [type Language]

Derived By

Type string

Referenced By

Element: AbbreviationISO6392 [type Language]

Derived By

Type string

Referenced By

Element: AbsoluteCheckoutFilePath [type DerivativeLock]

Derived By

Type string

Referenced By

Element: AbsoluteImportFilePath [type AssetUpdateOptions]

Description

The uri of the import file path. Not needed if MTOM is used.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

Derived By

Type anyURI

Referenced By

Element: AbsoluteImportFilePath [type DerivativeUpdateOptions]

Description

The uri of the import file path. Not needed if MTOM is used.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

Derived By

Type anyURI

Referenced By

Element: AbsolutePath [type AssetContainerIndex]

Derived By

Type string

Referenced By

Element: AbsolutePath [type Download]

Derived By

Type string

Referenced By

Element: AbsolutePathById [type AssetContainerIndex]

Derived By

Type string

Referenced By

Element: AddAssets2AssetContainers

Derived By

Restricting anyType

Content Model

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.

Element: AddAssets2AssetContainersResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: AddAssetVersions

Derived By

Restricting anyType

Content Model

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.

Element: AddAssetVersionsResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: AdditionalSelectFields [type AssetFilter]

Description

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"};
Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Element: AdditionalText [type FieldTranslation]

Derived By

Type string

Referenced By

Element: additionalUserGroupRightsCheck [element GetUsers]

Description

Optional. Get only users in groups to which the current user has a certain UserGroupRight.

Derived By

Type UserGroupRight

Enumeration
Value  Description 
ViewUserGroup 
EditUserGroup 
DeleteUserGroup 
ViewUserGroupRights 
EditUserGroupRights 
AssignUsers 
EditUsers 
ImpersonateUserGroup 
ImpersonateUser 
Referenced By

Element: additionalUserRightsCheck [element GetUsers]

Description

Optional. Get only users with this UserRight.

Derived By

Type UserRight

Enumeration
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 
Referenced By

Element: Address [type UserData]

Derived By

Type string

Referenced By

Element: Address [type UserShort]

Derived By

Type string

Referenced By

Element: AfterDateTime [type DateTimeAfterOperation]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: AfterDateTime [type DateTimeBetweenOperation]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: AllQueryAssetIds [type AssetItemCollection]

Description

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.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: AlternativeAddress [type UserData]

Derived By

Type string

Referenced By

Element: AlternativeAddress [type UserShort]

Derived By

Type string

Referenced By

Element: Analyzed [type Field]

Description

Defines if the field gets analyzed by RavenDB

Derived By

Type boolean

Referenced By

Element: AndOperation

Derived By

Type AndOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfComparisonOperation 
LogicalOperations  ArrayOfLogicalOperation 

Element: anyType

Derived By

Type anyType

Content Model

Always empty.

Element: anyURI

Derived By

Type anyURI

Element: Applicable [type RightTemplate]

Derived By

Type boolean

Referenced By

Element: ApplicationLanguage

Derived By

Type ApplicationLanguage

Enumeration
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: AppliedAssetRightTemplateId [type AssetItem]

Description

The id of the asset right template. Is ignored, if IsAssetRightTemplateOverridden = true.

Derived By

Type int

Referenced By

Element: AppliedAssetRightTemplateId [type AssetMetadata]

Description

The id of the assigned right template.

Derived By

Type int

Referenced By

Element: AppliedAssetRightTemplateId [type PortAssetItem]

Description

The id of the asset right template.

Derived By

Type int

Referenced By

Element: AppliedAssetRightTemplateName [type PortAssetItem]

Description

The translation of the asset right template in current user language.

Derived By

Type string

Referenced By

Element: AppliedDerivativeRightTemplateId [type AssetItem]

Description

The id of the derivative right template. Is ignored, if IsDerivativeRightTemplateOverridden = true.

Derived By

Type int

Referenced By

Element: AppliedDerivativeRightTemplateId [type AssetMetadata]

Description

The id of the right template used to define the access rights for the derivative formats.

Derived By

Type int

Referenced By

Element: AppliedRightTemplateId [type AssetContainerItem]

Description

The id of the applied right template.Is ignored, if IsRightTemplateOverridden = true

Derived By

Type int

Referenced By

Element: ArrayOfAssetContainerAssignmentExtended

Derived By

Type ArrayOfAssetContainerAssignmentExtended

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerAssignmentExtended  AssetContainerAssignmentExtended 

Element: ArrayOfAssetContainerComparisonOperation

Derived By

Type ArrayOfAssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerComparisonOperation  AssetContainerComparisonOperation 

Element: ArrayOfAssetContainerIndex

Derived By

Type ArrayOfAssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerIndex  AssetContainerIndex 

Element: ArrayOfAssetContainerItem

Derived By

Type ArrayOfAssetContainerItem

Content Model

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: ArrayOfAssetContainerLogicalOperation

Derived By

Type ArrayOfAssetContainerLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerLogicalOperation  AssetContainerLogicalOperation 

Element: ArrayOfAssetContainerRight

Derived By

Type ArrayOfAssetContainerRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRight  AssetContainerRight 

Element: ArrayOfAssetContainerTotalAssets

Derived By

Type ArrayOfAssetContainerTotalAssets

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerTotalAssets  AssetContainerTotalAssets 

Element: ArrayOfAssetContainerTranslation

Derived By

Type ArrayOfAssetContainerTranslation

Content Model

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: ArrayOfAssetFieldValues

Derived By

Type ArrayOfAssetFieldValues

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetFieldValues  AssetFieldValues 

Element: ArrayOfAssetItem

Derived By

Type ArrayOfAssetItem

Content Model

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: ArrayOfAssetObject

Derived By

Type ArrayOfAssetObject

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetObject  AssetObject 

Element: ArrayOfAssetRight

Derived By

Type ArrayOfAssetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRight  AssetRight 

Element: ArrayOfAssetSelection

Derived By

Type ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 

Element: ArrayOfAssetVersion

Derived By

Type ArrayOfAssetVersion

Content Model

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: ArrayOfAudioStream

Derived By

Type ArrayOfAudioStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AudioStream  AudioStream 

Element: ArrayOfBusinessProcessLink

Derived By

Type ArrayOfBusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessLink  BusinessProcessLink 

Element: ArrayOfBusinessProcessShort

Derived By

Type ArrayOfBusinessProcessShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessShort  BusinessProcessShort 

Element: ArrayOfClaimGroup

Derived By

Type ArrayOfClaimGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ClaimGroup  ClaimGroup 

Element: ArrayOfComparisonOperation

Derived By

Type ArrayOfComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperation  ComparisonOperation 

Element: ArrayOfCountry

Derived By

Type ArrayOfCountry

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Country  Country 

Element: ArrayOfCountryTranslation

Derived By

Type ArrayOfCountryTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CountryTranslation  CountryTranslation 

Element: ArrayOfDerivative

Derived By

Type ArrayOfDerivative

Content Model

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: ArrayOfDerivativeDefinition

Derived By

Type ArrayOfDerivativeDefinition

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinition  DerivativeDefinition 

Element: ArrayOfDerivativeDefinition2AssetType

Derived By

Type ArrayOfDerivativeDefinition2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinition2AssetType  DerivativeDefinition2AssetType 

Element: ArrayOfDerivativeDefinitionRight

Derived By

Type ArrayOfDerivativeDefinitionRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRight  DerivativeDefinitionRight 

Element: ArrayOfDerivativeDefinitionRights

Derived By

Type ArrayOfDerivativeDefinitionRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  DerivativeDefinitionRights 

Element: ArrayOfDerivativeDefinitionTranslation

Derived By

Type ArrayOfDerivativeDefinitionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionTranslation  DerivativeDefinitionTranslation 

Element: ArrayOfDerivativeRight

Derived By

Type ArrayOfDerivativeRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeRight  DerivativeRight 

Element: ArrayOfDocument

Derived By

Type ArrayOfDocument

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Document  Document 

Element: ArrayOfDocumentPage

Derived By

Type ArrayOfDocumentPage

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DocumentPage  DocumentPage 

Element: ArrayOfExtendedDerivative

Derived By

Type ArrayOfExtendedDerivative

Content Model

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: ArrayOfFacetConfigurationElement

Derived By

Type ArrayOfFacetConfigurationElement

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationElement  FacetConfigurationElement 

Element: ArrayOfFacetConfigurationGroup

Derived By

Type ArrayOfFacetConfigurationGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationGroup  FacetConfigurationGroup 

Element: ArrayOfFacetConfigurationRange

Derived By

Type ArrayOfFacetConfigurationRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationRange  FacetConfigurationRange 

Element: ArrayOfFacetConfigurationTranslation

Derived By

Type ArrayOfFacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationTranslation  FacetConfigurationTranslation 

Element: ArrayOfFacetResult

Derived By

Type ArrayOfFacetResult

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetResult  FacetResult 

Element: ArrayOfFacetSearchParameter

Derived By

Type ArrayOfFacetSearchParameter

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetSearchParameter  FacetSearchParameter 

Element: ArrayOfFacetValue

Derived By

Type ArrayOfFacetValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetValue  FacetValue 

Element: ArrayOfField

Derived By

Type ArrayOfField

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Field  Field  Defines the attributes of a Field (Asset-, User- or AssetContainerField)

Element: ArrayOfFieldOption

Derived By

Type ArrayOfFieldOption

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOption  FieldOption 

Element: ArrayOfFieldOptionTranslation

Derived By

Type ArrayOfFieldOptionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOptionTranslation  FieldOptionTranslation 

Element: ArrayOfFieldRight

Derived By

Type ArrayOfFieldRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldRight  FieldRight 

Element: ArrayOfFieldTranslation

Derived By

Type ArrayOfFieldTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldTranslation  FieldTranslation 

Element: ArrayOfFieldValue

Derived By

Type ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 

Element: ArrayOffloat

Derived By

Type ArrayOffloat

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
float  float 

Element: ArrayOfint

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 

Element: ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h

Derived By

Type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h  anyType (restriction) 

Element: ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK

Derived By

Type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK  anyType (restriction) 

Element: ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe

Derived By

Type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe  anyType (restriction) 

Element: ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe

Derived By

Type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfFieldRightuUS27HWe  anyType (restriction) 

Element: ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe

Derived By

Type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfPersonalItemRightuUS27HWe  anyType (restriction) 

Element: ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe

Derived By

Type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfSiteRightuUS27HWe  anyType (restriction) 

Element: ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe

Derived By

Type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfUserGroupRightuUS27HWe  anyType (restriction) 

Element: ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe

Derived By

Type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfWidgetRightuUS27HWe  anyType (restriction) 

Element: ArrayOfKeyValueOfintPortViewField6jg_STziK

Derived By

Type ArrayOfKeyValueOfintPortViewField6jg_STziK

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintPortViewField6jg_STziK  anyType (restriction) 

Element: ArrayOfKnownFieldValue

Derived By

Type ArrayOfKnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KnownFieldValue  KnownFieldValue 

Element: ArrayOfLanguage4AssetContainer

Derived By

Type ArrayOfLanguage4AssetContainer

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4AssetContainer  Language4AssetContainer 

Element: ArrayOfLanguage4Content

Derived By

Type ArrayOfLanguage4Content

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Content  Language4Content 

Element: ArrayOfLanguage4FullTextIndex

Derived By

Type ArrayOfLanguage4FullTextIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4FullTextIndex  Language4FullTextIndex 

Element: ArrayOfLanguage4Metadata

Derived By

Type ArrayOfLanguage4Metadata

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Metadata  Language4Metadata 

Element: ArrayOfLanguage4UserInterface

Derived By

Type ArrayOfLanguage4UserInterface

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4UserInterface  Language4UserInterface 

Element: ArrayOfLanguage4Version

Derived By

Type ArrayOfLanguage4Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Version  Language4Version 

Element: ArrayOfLanguageFallback

Derived By

Type ArrayOfLanguageFallback

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LanguageFallback  LanguageFallback 

Element: ArrayOfLdapSecurityGroup

Derived By

Type ArrayOfLdapSecurityGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LdapSecurityGroup  LdapSecurityGroup 

Element: ArrayOfLogicalOperation

Derived By

Type ArrayOfLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LogicalOperation  LogicalOperation 

Element: ArrayOfMediaInfo

Derived By

Type ArrayOfMediaInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
MediaInfo  MediaInfo 

Element: ArrayOfMetadataProperty

Derived By

Type ArrayOfMetadataProperty

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
MetadataProperty  MetadataProperty 

Element: ArrayOfPersonalItemRight

Derived By

Type ArrayOfPersonalItemRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
PersonalItemRight  PersonalItemRight 

Element: ArrayOfPortAssetItem

Derived By

Type ArrayOfPortAssetItem

Content Model

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: ArrayOfPortDerivative

Derived By

Type ArrayOfPortDerivative

Content Model

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.

Element: ArrayOfRenderingActionArgumentValue

Derived By

Type ArrayOfRenderingActionArgumentValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionArgumentValue  RenderingActionArgumentValue 

Element: ArrayOfRenderingActionValue

Derived By

Type ArrayOfRenderingActionValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionValue  RenderingActionValue 

Element: ArrayOfRightTemplate

Derived By

Type ArrayOfRightTemplate

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate  RightTemplate 

Element: ArrayOfRightTemplate2AssetType

Derived By

Type ArrayOfRightTemplate2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2AssetType  RightTemplate2AssetType 

Element: ArrayOfRightTemplate2Right

Derived By

Type ArrayOfRightTemplate2Right

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2Right  RightTemplate2Right 

Element: ArrayOfRightTemplate2UserGroup

Derived By

Type ArrayOfRightTemplate2UserGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2UserGroup  RightTemplate2UserGroup 

Element: ArrayOfSiteRight

Derived By

Type ArrayOfSiteRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SiteRight  SiteRight 

Element: ArrayOfSortInfo

Derived By

Type ArrayOfSortInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SortInfo  SortInfo 

Element: ArrayOfstring

Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 

Element: ArrayOfUserActionHistoryInfo

Derived By

Type ArrayOfUserActionHistoryInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserActionHistoryInfo  UserActionHistoryInfo 

Element: ArrayOfUserDerivativeRights

Derived By

Type ArrayOfUserDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserDerivativeRights  UserDerivativeRights 

Element: ArrayOfUserGroupAssetContainerRights

Derived By

Type ArrayOfUserGroupAssetContainerRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetContainerRights  UserGroupAssetContainerRights 

Element: ArrayOfUserGroupAssetRights

Derived By

Type ArrayOfUserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetRights  UserGroupAssetRights 

Element: ArrayOfUserGroupDerivativeRights

Derived By

Type ArrayOfUserGroupDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupDerivativeRights  UserGroupDerivativeRights 

Element: ArrayOfUserGroupRight

Derived By

Type ArrayOfUserGroupRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupRight  UserGroupRight 

Element: ArrayOfUserGroupTranslation

Derived By

Type ArrayOfUserGroupTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupTranslation  UserGroupTranslation 

Element: ArrayOfUserRight

Derived By

Type ArrayOfUserRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserRight  UserRight 

Element: ArrayOfUserShort

Derived By

Type ArrayOfUserShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserShort  UserShort 

Element: ArrayOfVideoStream

Derived By

Type ArrayOfVideoStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
VideoStream  VideoStream 

Element: ArrayOfWidgetRight

Derived By

Type ArrayOfWidgetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
WidgetRight  WidgetRight 

Element: ArrayOfXmpItem

Derived By

Type ArrayOfXmpItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
XmpItem  XmpItem 

Element: aspNetSessionId [element CreateSession]

Description

Optional. The aspNetSessionId (if known), which enables the system to retrieve a lost session, e.g. in case of a browser reload.

Derived By

Type string

Referenced By

Element: Asset [type AssetVersion]

Derived By

Type AssetItem

Content Model

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.
Referenced By

Element: AssetContainerAndOperation

Derived By

Type AssetContainerAndOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfAssetContainerComparisonOperation 
LogicalOperations  ArrayOfAssetContainerLogicalOperation 

Element: AssetContainerAssignment

Derived By

Type AssetContainerAssignment

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
AssetId  int 
FieldId  int 

Element: AssetContainerAssignmentExtended [type ArrayOfAssetContainerAssignmentExtended]

Derived By

Type AssetContainerAssignmentExtended

Content Model

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 
Referenced By

Element: AssetContainerAssignmentExtended

Derived By

Type AssetContainerAssignmentExtended

Content Model

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 

Element: AssetContainerAssignments [type AssetMetadata]

Description

An array with all AssetContainerAssignmentExtendeds for this asset.

An asset can be assigned to many asset containers.

Derived By

Type ArrayOfAssetContainerAssignmentExtended

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerAssignmentExtended  AssetContainerAssignmentExtended 
Referenced By

Element: AssetContainerComparisonOperation [type ArrayOfAssetContainerComparisonOperation]

Derived By

Type AssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 
Referenced By

Element: AssetContainerComparisonOperation

Derived By

Type AssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 

Element: AssetContainerExcludeFieldOperation

Derived By

Type AssetContainerExcludeFieldOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AssetContainerId  int 
IncludeSubAssetContainers  boolean 

Element: AssetContainerExcludeOperation

Derived By

Type AssetContainerExcludeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 

Element: assetContainerId [element GetAssetContainerRights]

Description

The id of the asset container.

Derived By

Type int

Referenced By

Element: assetContainerId [element GetFieldSetIdByFieldName]

Description

The asset container ID.

Derived By

Type int

Referenced By

Element: assetContainerId [element RemoveAssetContainer]

Description

The id of the asset container.

The deletion of an asset container includes the deletion of all sub containers!

Derived By

Type int

Referenced By

Element: assetContainerId [element SaveAssetContainerRights]

Description

The id of the asset container.

Derived By

Type int

Referenced By

Element: assetContainerId [element UpdateAssetContainer]

Description

The id of the asset container.

Derived By

Type int

Referenced By

Element: assetContainerId [element UpdateFieldSetDefaultValue]

Description

The asset container ID.

Derived By

Type int

Referenced By

Element: AssetContainerId [type AssetContainerAssignment]

Derived By

Type int

Referenced By

Element: AssetContainerId [type AssetContainerComparisonOperation]

Derived By

Type int

Referenced By

Element: AssetContainerId [type AssetContainerExcludeFieldOperation]

Derived By

Type int

Referenced By

Element: AssetContainerId [type AssetContainerIncludeFieldOperation]

Derived By

Type int

Referenced By

Element: AssetContainerId [type AssetContainerItem]

Description

The id of the asset container.

Derived By

Type int

Referenced By

Element: AssetContainerId [type AssetContainerTotalAssets]

Derived By

Type int

Referenced By

Element: AssetContainerId [type AssetContainerTranslation]

Derived By

Type int

Referenced By

Element: AssetContainerId [type FacetValue]

Derived By

Type int

Referenced By

Element: AssetContainerId [type UserActionHistoryInfo]

Derived By

Type int

Referenced By

Element: assetContainerIds [element AddAssets2AssetContainers]

Description

Array of asset container ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetContainerIds [element GetTotalAssets]

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetContainerIds [element RemoveAssetsFromAssetContainers]

Description

List of asset container ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: AssetContainerIds [type AssetImportOptions]

Description

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.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: AssetContainerIncludeFieldOperation

Derived By

Type AssetContainerIncludeFieldOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AssetContainerId  int 
IncludeSubAssetContainers  boolean 

Element: AssetContainerIncludeOperation

Derived By

Type AssetContainerIncludeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
IncludeSubAssetContainers  boolean 

Element: AssetContainerIndex [type ArrayOfAssetContainerIndex]

Derived By

Type AssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AbsolutePathById  string 
AssetContainerIndexId  int 
LanguageId  int 
ts  base64Binary 
Referenced By

Element: AssetContainerIndex

Derived By

Type AssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AbsolutePathById  string 
AssetContainerIndexId  int 
LanguageId  int 
ts  base64Binary 

Element: AssetContainerIndexId [type AssetContainerIndex]

Derived By

Type int

Referenced By

Element: AssetContainerItem [type ArrayOfAssetContainerItem]

Derived By

Type AssetContainerItem

Content Model

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 
Referenced By

Element: AssetContainerItem

Derived By

Type AssetContainerItem

Content Model

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]

Derived By

Type AssetContainerLogicalOperation

Content Model

Always empty.

Referenced By

Element: AssetContainerLogicalOperation

Derived By

Type AssetContainerLogicalOperation

Content Model

Always empty.

Element: AssetContainerName [type AssetContainerItem]

Description

The asset container name depends on the parameter desiredAssetContainerLanguage in GetAssetContainers.

Derived By

Type string

Referenced By

Element: AssetContainerOrOperation

Derived By

Type AssetContainerOrOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfAssetContainerComparisonOperation 
LogicalOperations  ArrayOfAssetContainerLogicalOperation 

Element: AssetContainerRight [type ArrayOfAssetContainerRight]

Derived By

Type AssetContainerRight

Enumeration
Value  Description 
List 
ViewContent 
Rename 
Delete 
AssignAssets 
CreateSubContainer 
Move 
ReorderContainer 
EditAssetContainerRights 
ViewAssetContainerRights 
Referenced By

Element: AssetContainerRight

Derived By

Type AssetContainerRight

Enumeration
Value  Description 
List 
ViewContent 
Rename 
Delete 
AssignAssets 
CreateSubContainer 
Move 
ReorderContainer 
EditAssetContainerRights 
ViewAssetContainerRights 

Element: AssetContainerRightId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: AssetContainerRights [type UserGroupAssetContainerRights]

Derived By

Type ArrayOfAssetContainerRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRight  AssetContainerRight 
Referenced By

Element: AssetContainerSearchOperation [type ExtendedAssetFilter]

Description

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 ..
}

Derived By

Type AssetContainerLogicalOperation

Content Model

Always empty.

Referenced By

Element: AssetContainerTotalAssets [type ArrayOfAssetContainerTotalAssets]

Derived By

Type AssetContainerTotalAssets

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
TotalAssets  int 
Referenced By

Element: AssetContainerTotalAssets

Derived By

Type AssetContainerTotalAssets

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerId  int 
TotalAssets  int 

Element: AssetContainerTranslation [type ArrayOfAssetContainerTranslation]

Derived By

Type AssetContainerTranslation

Content Model

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 
Referenced By

Element: AssetContainerTranslation

Derived By

Type AssetContainerTranslation

Content Model

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 

Element: AssetContainerTranslationId [type AssetContainerTranslation]

Derived By

Type int

Referenced By

Element: assetContainerTranslations [element CreateAssetContainer]

Description

A list of AssetContainerTranslations with the language specific asset container names and descriptions.

Derived By

Type ArrayOfAssetContainerTranslation

Content Model

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.
Referenced By

Element: assetContainerTranslations [element UpdateAssetContainer]

Description

A list of AssetContainerTranslations with the language specific asset container names and descriptions.

Derived By

Type ArrayOfAssetContainerTranslation

Content Model

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.
Referenced By

Element: assetContainerType [element GetAssetContainers]

Description

Optional. Either Category or AssetClass.

AssetContainerType? assetContainerType = AssetContainerType.AssetClass;
Derived By

Type AssetContainerType

Enumeration
Value  Description 
Category 
AssetClass 
Referenced By

Element: AssetContainerType [type AssetContainerAssignmentExtended]

Derived By

Type AssetContainerType

Enumeration
Value  Description 
Category 
AssetClass 
Referenced By

Element: AssetContainerType [type AssetContainerItem]

Description

The asset container type, either Category or AssetClass.

Derived By

Type AssetContainerType

Enumeration
Value  Description 
Category 
AssetClass 
Referenced By

Element: AssetContainerType [type Field]

Description

The asset container type, either Category or AssetClass.

This property is needed for asset classes.

Derived By

Type AssetContainerType

Enumeration
Value  Description 
Category 
AssetClass 
Referenced By

Element: AssetContainerType

Derived By

Type AssetContainerType

Enumeration
Value  Description 
Category 
AssetClass 

Element: assetFieldValues [element UpdateAssetsMetadata]

Description

The list of AssetFieldValues to be updated.

Derived By

Type ArrayOfAssetFieldValues

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetFieldValues  AssetFieldValues 
Referenced By

Element: AssetFieldValues [type ArrayOfAssetFieldValues]

Derived By

Type AssetFieldValues

Content Model

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.
Referenced By

Element: AssetFieldValues

Derived By

Type AssetFieldValues

Content Model

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: assetFieldValues2Remove [element UpdateAssetsMetadata]

Description

The list of AssetFieldValues to be removed.

Derived By

Type ArrayOfAssetFieldValues

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetFieldValues  AssetFieldValues 
Referenced By

Element: assetFilter [element GetAssets2]

Description

An asset filter.

Derived By

Type ExtendedAssetFilter

Content Model

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:
.
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 ..
}

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:
.
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 ..
}

SimpleSearchString  string 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

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>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });

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 }
Referenced By

Element: assetFilter [element GetAssetsByIds]

Description

The assetFilter allows the definition of some additional parameters.

Derived By

Type AssetFilter

Content Model

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.

Referenced By

Element: assetFilter [element GetAssetVersions]

Description

An asset filter, may be empty.

Derived By

Type AssetFilter

Content Model

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.

Referenced By

Element: AssetFilter

Derived By

Type AssetFilter

Content Model

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: assetId [element DeleteDerivative]

Description

The asset id.

Derived By

Type int

Referenced By

Element: assetId [element GetAssetRights]

Description

The asset id.

Derived By

Type int

Referenced By

Element: assetId [element GetAssetVersions]

Description

The asset id.

Derived By

Type int

Referenced By

Element: assetId [element GetDerivativeRights]

Description

The asset id.

Derived By

Type int

Referenced By

Element: assetId [element GetMetadata]

Description

The asset id.

Derived By

Type int

Referenced By

Element: assetId [element UpdateAssetMetadata]

Description

The asset id

Derived By

Type int

Referenced By

Element: AssetId [type AssetContainerAssignment]

Derived By

Type int

Referenced By

Element: AssetId [type AssetFieldValues]

Description

The asset id.

Derived By

Type int

Referenced By

Element: AssetId [type AssetItem]

Description

The asset id.

Derived By

Type int

Referenced By

Element: AssetId [type AssetObject]

Derived By

Type int

Referenced By

Element: AssetId [type AssetSelection]

Derived By

Type int

Referenced By

Element: AssetId [type AssetUpdateOptions]

Description

The asset id.

Derived By

Type int

Referenced By

Element: AssetId [type BusinessProcessLink]

Derived By

Type int

Referenced By

Element: AssetId [type Derivative]

Derived By

Type int

Referenced By

Element: AssetId [type DerivativeLock]

Derived By

Type int

Referenced By

Element: AssetId [type DerivativeUpdateOptions]

Description

The asset id.

Derived By

Type int

Referenced By

Element: AssetId [type FieldValue]

Derived By

Type int

Referenced By

Element: AssetId [type PortAssetItem]

Description

The asset id.

Derived By

Type int

Referenced By

Element: AssetId [type PortDerivative]

Derived By

Type int

Referenced By

Element: AssetId [type UserActionHistoryInfo]

Derived By

Type int

Referenced By

Element: assetIds [element AddAssets2AssetContainers]

Description

Array of asset ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetIds [element GetAssetsByIds]

Description

The int array of asset ids to be returned.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetIds [element GetAssetsMetadata]

Description

A list of asset ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetIds [element RemoveAssets]

Description

An array of asset ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetIds [element RemoveAssetsFromAssetContainers]

Description

List of asset ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetIds [element SaveAssetsRights]

Description

List of asset ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetIds [element SaveDerivativeRights]

Description

List of asset ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: assetImportOptions [element ImportSingleAsset]

Description

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.

Derived By

Type AssetImportOptions

Content Model

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).


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},
.  ..
};

FileName  string  The file name with extension, needed only for an upload by MTOM.
ImportGuid  guid 

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,

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.


ImportUrl = "http://picturepark.com/images/image1234.jpg"

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.


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

UserGroupDerivativeRights  ArrayOfUserGroupDerivativeRights  Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter.
Referenced By

Element: AssetImportOptions

Derived By

Type AssetImportOptions

Content Model

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).


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},
.  ..
};

FileName  string  The file name with extension, needed only for an upload by MTOM.
ImportGuid  guid 

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,

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.


ImportUrl = "http://picturepark.com/images/image1234.jpg"

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.


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

UserGroupDerivativeRights  ArrayOfUserGroupDerivativeRights  Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter.

Element: AssetItem [type ArrayOfAssetItem]

Derived By

Type AssetItem

Content Model

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.
Referenced By

Element: AssetItem

Derived By

Type AssetItem

Content Model

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: AssetItemCollection

Derived By

Type AssetItemCollection

Content Model

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: assetLinks [element UpdateAssetLinks]

Description

An array of BusinessProcessShort.

Derived By

Type ArrayOfBusinessProcessShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessShort  BusinessProcessShort 
Referenced By

Element: AssetMetadata

Derived By

Type AssetMetadata

Content Model

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: AssetObject [type ArrayOfAssetObject]

Derived By

Type AssetObject

Content Model

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 
Referenced By

Element: AssetObject

Derived By

Type AssetObject

Content Model

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: AssetObjectId [type AssetObject]

Derived By

Type int

Referenced By

Element: AssetObjects [type DocumentPage]

Derived By

Type ArrayOfAssetObject

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetObject  AssetObject 
Referenced By

Element: AssetObjectType [type AssetObject]

Derived By

Type AssetObjectType

Enumeration
Value  Description 
LinkedAsset 
LinkedUrl 
Rectangle 
Text 
Arrow 
Referenced By

Element: AssetObjectType

Derived By

Type AssetObjectType

Enumeration
Value  Description 
LinkedAsset 
LinkedUrl 
Rectangle 
Text 
Arrow 

Element: AssetRight [type ArrayOfAssetRight]

Derived By

Type AssetRight

Enumeration
Value  Description 
List 
ViewMetadata 
EditMetadata 
Delete 
ManageDerivatives 
ViewRights 
EditRights 
EditContainerAssignments 
ViewVersions 
EditVersions 
ViewStatistics 
ViewJournal 
ViewEmbeddedMetadata 
Referenced By

Element: AssetRight

Derived By

Type AssetRight

Enumeration
Value  Description 
List 
ViewMetadata 
EditMetadata 
Delete 
ManageDerivatives 
ViewRights 
EditRights 
EditContainerAssignments 
ViewVersions 
EditVersions 
ViewStatistics 
ViewJournal 
ViewEmbeddedMetadata 

Element: AssetRightId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: AssetRights [type AssetItem]

Description

An array with all AssetRights for the current user.

Derived By

Type ArrayOfAssetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRight  AssetRight 
Referenced By

Element: AssetRights [type AssetMetadata]

Description

array with all AssetRights for the current user.

Derived By

Type ArrayOfAssetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRight  AssetRight 
Referenced By

Element: AssetRights [type UserGroupAssetRights]

Derived By

Type ArrayOfAssetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRight  AssetRight 
Referenced By

Element: AssetRightTemplateId [type AssetImportOptions]

Description

The id of an AssetRightTemplate.

Derived By

Type int

Referenced By

Element: Assets [type AssetItemCollection]

Description

An array of AssetItem.

Derived By

Type ArrayOfAssetItem

Content Model

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.
Referenced By

Element: Assets [type PortAssetItemCollection]

Description

An array of AssetItem.

Derived By

Type ArrayOfPortAssetItem

Content Model

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
Referenced By

Element: assetSelection [element Download]

Description

A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds.

Derived By

Type ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 
Referenced By

Element: assetSelection [element DownloadExtended]

Description

A list of AssetSelection objects, which consists of AssetIds and DerivativeDefinitionIds.

Derived By

Type ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 
Referenced By

Element: assetSelection [element GetDerivatives]

Description

A list of AssetSelections.

Derived By

Type ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 
Referenced By

Element: AssetSelection [type ArrayOfAssetSelection]

Derived By

Type AssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
DerivativeDefinitionId  int 
Referenced By

Element: AssetSelection

Derived By

Type AssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
DerivativeDefinitionId  int 

Element: assetSelections [element CreateAssetLink]

Description

A list of asset selections.

Derived By

Type ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 
Referenced By

Element: AssetType [type RightTemplate2AssetType]

Derived By

Type AssetType

Enumeration
Value  Description 
Unknown 
Bitmap 
VectorGraphic 
RawImage 
InterchangeDocument 
WordProcessingDocument 
TextDocument 
DesktopPublishingDocument 
Presentation 
Spreadsheet 
Archive 
Audio 
Video 
Font 
Multimedia 
Application 
SourceCode 
Database 
Cad 
Model3d 
Referenced By

Element: AssetType

Derived By

Type AssetType

Enumeration
Value  Description 
Unknown 
Bitmap 
VectorGraphic 
RawImage 
InterchangeDocument 
WordProcessingDocument 
TextDocument 
DesktopPublishingDocument 
Presentation 
Spreadsheet 
Archive 
Audio 
Video 
Font 
Multimedia 
Application 
SourceCode 
Database 
Cad 
Model3d 

Element: AssetTypeId [type AssetItem]

Description

In Picturepark, assets are categorized into AssetTypes according to their file extensions.

Derived By

Type AssetType

Enumeration
Value  Description 
Unknown 
Bitmap 
VectorGraphic 
RawImage 
InterchangeDocument 
WordProcessingDocument 
TextDocument 
DesktopPublishingDocument 
Presentation 
Spreadsheet 
Archive 
Audio 
Video 
Font 
Multimedia 
Application 
SourceCode 
Database 
Cad 
Model3d 
Referenced By

Element: AssetTypeId [type AssetMetadata]

Description

Bitmap, VectorGraphic, TextDocument, Audio, Video ..

Derived By

Type AssetType

Enumeration
Value  Description 
Unknown 
Bitmap 
VectorGraphic 
RawImage 
InterchangeDocument 
WordProcessingDocument 
TextDocument 
DesktopPublishingDocument 
Presentation 
Spreadsheet 
Archive 
Audio 
Video 
Font 
Multimedia 
Application 
SourceCode 
Database 
Cad 
Model3d 
Referenced By

Element: AssetTypeId [type DerivativeDefinition2AssetType]

Derived By

Type int

Referenced By

Element: AssetTypeId [type PortAssetItem]

Derived By

Type AssetType

Enumeration
Value  Description 
Unknown 
Bitmap 
VectorGraphic 
RawImage 
InterchangeDocument 
WordProcessingDocument 
TextDocument 
DesktopPublishingDocument 
Presentation 
Spreadsheet 
Archive 
Audio 
Video 
Font 
Multimedia 
Application 
SourceCode 
Database 
Cad 
Model3d 
Referenced By

Element: AssetTypeId [type RenderingActionValue]

Derived By

Type int

Referenced By

Element: AssetTypeIds [type ExtendedAssetFilter]

Description

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}
Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: AssetTypeIds [type Field]

Description

An array with the ids of asset types assigned to this field. Currently not used.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: AssetTypeIds [type RightTemplate]

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: AssetTypeTranslation [type PortAssetItem]

Derived By

Type string

Referenced By

Element: assetUpdateOptions [element UpdateOriginalDerivative]

Description

Complex data type containing multiple update parameters.

Derived By

Type AssetUpdateOptions

Content Model

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.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

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.


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,
. ..
};

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.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Referenced By

Element: AssetUpdateOptions

Derived By

Type AssetUpdateOptions

Content Model

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.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

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.


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,
. ..
};

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.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Element: AssetVersion [type ArrayOfAssetVersion]

Derived By

Type AssetVersion

Content Model

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 
Referenced By

Element: AssetVersion

Derived By

Type AssetVersion

Content Model

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: AssetVersionId [type AssetVersion]

Derived By

Type int

Referenced By

Element: assetVersions [element AddAssetVersions]

Description

A list of AssetVersions.

There are currently two types of assetversions: languages and slides.

Derived By

Type ArrayOfAssetVersion

Content Model

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).

Referenced By

Element: assetVersions [element RemoveAssetVersions]

Description

A list of AssetVersions.

Derived By

Type ArrayOfAssetVersion

Content Model

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).

Referenced By

Element: AssetVersions [type AssetImportOptions]

Description

Optional. List of asset versions.

Derived By

Type ArrayOfAssetVersion

Content Model

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).

Referenced By

Element: AssetVersions [type AssetItem]

Description

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.

Derived By

Type ArrayOfAssetVersion

Content Model

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).

Referenced By

Element: AssetVersions [type AssetMetadata]

Description

An array with all AssetVersions for this asset.

This array contains all asset versions which have this asset as a parent.

Derived By

Type ArrayOfAssetVersion

Content Model

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).

Referenced By

Element: Assigned [type RightTemplate]

Derived By

Type boolean

Referenced By

Element: AudioBitRate [type AudioStream]

Derived By

Type int

Referenced By

Element: AudioBitrate [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: AudioBitRateMode [type AudioStream]

Derived By

Type BitrateMode

Enumeration
Value  Description 
Variable 
Constant 
Referenced By

Element: AudioChannelPositions [type AudioStream]

Derived By

Type string

Referenced By

Element: AudioChannels [type AudioStream]

Derived By

Type int

Referenced By

Element: AudioCodec [type AudioStream]

Derived By

Type string

Referenced By

Element: AudioCount [type MediaInfo]

Derived By

Type int

Referenced By

Element: AudioDuration [type AudioStream]

Derived By

Type duration

Restrictions
Referenced By

Element: AudioFormat [type AudioStream]

Derived By

Type string

Referenced By

Element: AudioLanguage [type AudioStream]

Derived By

Type string

Referenced By

Element: AudioQuality [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: AudioResolution [type AudioStream]

Derived By

Type int

Referenced By

Element: AudioSamplingFrequency [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: AudioSamplingRate [type AudioStream]

Derived By

Type int

Referenced By

Element: AudioStream [type ArrayOfAudioStream]

Derived By

Type AudioStream

Content Model

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 
Referenced By

Element: AudioStream

Derived By

Type AudioStream

Content Model

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: AudioStreams [type MediaInfo]

Derived By

Type ArrayOfAudioStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AudioStream  AudioStream 
Referenced By

Element: AudioStreamSize [type AudioStream]

Derived By

Type long

Referenced By

Element: AudioUse4Preview [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: authenticationUser [element GetSecurityToken]

Description

The email address of the user, who serves to authenticate the connection.

Derived By

Type string

Referenced By

Element: authenticationUserPassword [element GetSecurityToken]

Description

The password of that user.

Derived By

Type string

Referenced By

Element: Available4UserInterface [type Language]

Derived By

Type boolean

Referenced By

Element: AvailableDerivativeDefinitions [type AssetItem]

Description

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.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: AvailableUntilDate [type Download]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: Average [type FacetValue]

Derived By

Type double

Referenced By

Element: AvPresetId [type DerivativeDefinition]

Derived By

Type guid

Restrictions
Referenced By

Element: base64Binary

Derived By

Type base64Binary

Element: BaseAssetContainerId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: BaseAssetContainerId [type Field]

Description

Needed for control type TagBox and defines root of the tagbox.

Derived By

Type int

Referenced By

Element: batchGuid [element ConfirmSubscriptionInfoReceived]

Description

The guid received from GetSubscriptionInfo

Derived By

Type string

Referenced By

Element: BatchGuid [type UserActionHistoryInfoCollection]

Derived By

Type string

Referenced By

Element: BeforeDateTime [type DateTimeBeforeOperation]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: BeforeDateTime [type DateTimeBetweenOperation]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: BitrateMode

Derived By

Type BitrateMode

Enumeration
Value  Description 
Variable 
Constant 

Element: boolean

Derived By

Type boolean

Element: Boost [type Field]

Description

Defines the boost factor for Fulltext search

Derived By

Type float

Referenced By

Element: buffer [element UploadChunk]

Description

The buffer containing the chunk

Derived By

Type base64Binary

Referenced By

Element: buffer [element UploadFirstChunk]

Description

The buffer containing the first chunk.

Derived By

Type base64Binary

Referenced By

Element: businessProcessId [element GetMetadata]

Description

Optional. Not needed by integrators.

Derived By

Type int

Referenced By

Element: BusinessProcessId [type AssetFilter]

Description

Optional. Not needed for integrators.

Derived By

Type int

Referenced By

Element: BusinessProcessId [type BusinessProcessShort]

Derived By

Type int

Referenced By

Element: BusinessProcessId [type DownloadOptions]

Description

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.

Derived By

Type int

Referenced By

Element: businessProcessIds [element DeleteAssetLinks]

Description

A list of the businessprocess ids to be deleted.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: businessProcessIds [element GetAssetLinksById]

Description

A list of businessprocess ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: BusinessProcessLink [type ArrayOfBusinessProcessLink]

Derived By

Type BusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
BusinessProcessUrl  anyURI 
DerivativeDefinitionId  int 
Referenced By

Element: BusinessProcessLink

Derived By

Type BusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetId  int 
BusinessProcessUrl  anyURI 
DerivativeDefinitionId  int 

Element: BusinessProcessShort [type ArrayOfBusinessProcessShort]

Derived By

Type BusinessProcessShort

Content Model

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 
Referenced By

Element: BusinessProcessShort

Derived By

Type BusinessProcessShort

Content Model

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: businessProcessToken [element GetMetadata]

Description

Optional. Not needed by integrators.

Derived By

Type string

Referenced By

Element: BusinessProcessToken [type AssetFilter]

Description

Optional. Not needed for integrators.

Derived By

Type string

Referenced By

Element: BusinessProcessToken [type DownloadOptions]

Description

Token for a business process, must be given in combination with a BusinessProcessId.

Derived By

Type string

Referenced By

Element: BusinessProcessType [type BusinessProcessShort]

Derived By

Type BusinessProcessType

Enumeration
Value  Description 
AssetMailing 
AssetReview 
AssetLink 
AssetPublishing 
Referenced By

Element: BusinessProcessType

Derived By

Type BusinessProcessType

Enumeration
Value  Description 
AssetMailing 
AssetReview 
AssetLink 
AssetPublishing 

Element: BusinessProcessUrl [type BusinessProcessLink]

Derived By

Type anyURI

Referenced By

Element: byte

Derived By

Type byte

Element: CanBeInternalContact [type UserData]

Derived By

Type boolean

Referenced By

Element: CanBeInternalContact [type UserShort]

Derived By

Type boolean

Referenced By

Element: CanChangeOwnProfile [type UserData]

Derived By

Type boolean

Referenced By

Element: CanChangeOwnProfile [type UserShort]

Derived By

Type boolean

Referenced By

Element: CanManage [type Skin]

Derived By

Type boolean

Referenced By

Element: Caption [type FacetConfigurationGroup]

Description

Used in UI set to user language4content's caption

Derived By

Type string

Referenced By

Element: Caption [type FacetConfigurationRange]

Description

Used in UI set to user language4content's caption

Derived By

Type string

Referenced By

Element: Caption [type FacetConfigurationTranslation]

Derived By

Type string

Referenced By

Element: Caption [type FacetResult]

Derived By

Type string

Referenced By

Element: Caption [type FieldTranslation]

Derived By

Type string

Referenced By

Element: Caption [type MetadataProperty]

Derived By

Type string

Referenced By

Element: Caption [type MetadataSchema]

Derived By

Type string

Referenced By

Element: Caption [type PortViewField]

Derived By

Type string

Referenced By

Element: CaptionsOfUncollapsedFacetGroups [type FacetSearchParameter]

Description

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.

Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Element: CatalogLanguageId [type Language4FullTextIndex]

Derived By

Type int

Referenced By

Element: CatalogLanguageSqlName [type Language]

Derived By

Type string

Referenced By

Element: char

Derived By

Type char

Element: CheckoutReason [type DerivativeLock]

Derived By

Type string

Referenced By

Element: Children [type AssetContainerItem]

Description

An array with child AssetContainerItems.

Derived By

Type ArrayOfAssetContainerItem

Content Model

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.
Referenced By

Element: children [type XmpItem]

Derived By

Type ArrayOfXmpItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
XmpItem  XmpItem 
Referenced By

Element: City [type UserData]

Derived By

Type string

Referenced By

Element: City [type UserShort]

Derived By

Type string

Referenced By

Element: ClaimGroup [type ArrayOfClaimGroup]

Derived By

Type ClaimGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GroupSid  string 
IdentityProviderId  int 
UserGroupId  int 
UserGroups2ClaimGroupId  int 
Referenced By

Element: ClaimGroup

Derived By

Type ClaimGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GroupSid  string 
IdentityProviderId  int 
UserGroupId  int 
UserGroups2ClaimGroupId  int 

Element: ClaimGroups [type UserGroupItem]

Derived By

Type ArrayOfClaimGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ClaimGroup  ClaimGroup 
Referenced By

Element: ClientComputerName [type DerivativeLock]

Derived By

Type string

Referenced By

Element: ClientFileModificationDate [type DerivativeLock]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: clientGuid [element CreateSession]

Description

The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.

Derived By

Type string

Referenced By

Element: clientGuid [element GetSecurityToken]

Description

The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.

Derived By

Type string

Referenced By

Element: clientGuid [element LoginWithSecurityToken]

Description

The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.

Derived By

Type string

Referenced By

Element: clientGuid [element LoginWithSecurityToken2]

Description

The clientGuid must be provided by VIT or VIT partners, who will create the guid by registering the client with the server.

Derived By

Type string

Referenced By

Element: ClientId [type CoreInfo]

Description

The client id.

Derived By

Type int

Referenced By

Element: Code [type Country]

Derived By

Type string

Referenced By

Element: Codec [type MediaInfo]

Derived By

Type string

Referenced By

Element: Comment [type UserData]

Derived By

Type string

Referenced By

Element: Comment [type UserShort]

Derived By

Type string

Referenced By

Element: CommentId [type AssetObject]

Derived By

Type int

Referenced By

Element: Company [type UserData]

Derived By

Type string

Referenced By

Element: Company [type UserShort]

Derived By

Type string

Referenced By

Element: ComparisonOperation [type ArrayOfComparisonOperation]

Derived By

Type ComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Referenced By

Element: ComparisonOperation [type FacetValue]

Derived By

Type ComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Referenced By

Element: ComparisonOperation

Derived By

Type ComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 

Element: ComparisonOperations [type AndOperation]

Derived By

Type ArrayOfComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperation  ComparisonOperation 
Referenced By

Element: ComparisonOperations [type AssetContainerAndOperation]

Derived By

Type ArrayOfAssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerComparisonOperation  AssetContainerComparisonOperation 
Referenced By

Element: ComparisonOperations [type AssetContainerOrOperation]

Derived By

Type ArrayOfAssetContainerComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerComparisonOperation  AssetContainerComparisonOperation 
Referenced By

Element: ComparisonOperations [type OrOperation]

Derived By

Type ArrayOfComparisonOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperation  ComparisonOperation 
Referenced By

Element: ComparisonOperationType [type FacetValue]

Derived By

Type ComparisonOperationType

Enumeration
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 
Referenced By

Element: ComparisonOperationType

Derived By

Type ComparisonOperationType

Enumeration
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: ConfirmSubscriptionInfoReceived

Derived By

Restricting anyType

Content Model

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

Element: ConfirmSubscriptionInfoReceivedResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: ContainsExactStringList [type StringListContainsExactOperation]

Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Element: ContainsString [type StringContainsOperation]

Derived By

Type string

Referenced By

Element: ContainsStringList [type StringListContainsOperation]

Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Element: ContentLanguageId [type Language4Content]

Derived By

Type int

Referenced By

Element: ControlType [type Field]

Description

ComboBox, DateField, Checkbox ..

Derived By

Type ControlType

Enumeration
Value  Description 
ComboBox 
DateField 
DateTimeField 
Checkbox 
MultiCheckbox 
RadioButton 
TextField 
TextArea 
Label 
NumberField 
Password 
InternalContactEmailField 
ComboBox4Users 
TagBox 
Referenced By

Element: ControlType

Derived By

Type ControlType

Enumeration
Value  Description 
ComboBox 
DateField 
DateTimeField 
Checkbox 
MultiCheckbox 
RadioButton 
TextField 
TextArea 
Label 
NumberField 
Password 
InternalContactEmailField 
ComboBox4Users 
TagBox 

Element: CopyLanguageId [type Language4AssetContainer]

Derived By

Type int

Referenced By

Element: Copyright [type PortAssetItem]

Derived By

Type string

Referenced By

Element: coreInfo [element AddAssets2AssetContainers]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element AddAssetVersions]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element ConfirmSubscriptionInfoReceived]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element CreateAssetContainer]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element CreateAssetLink]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element CreateRenderingJob]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element CreateTraceJob]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element CreateUser]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element DeleteAssetLinks]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element DeleteDerivative]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element Download]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element DownloadExtended]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssetContainerRights]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssetContainers]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssetFields]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssetLinksById]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssetRights]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssets]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssets2]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssetsByIds]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssetsMetadata]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetAssetVersions]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetConfiguration]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetConfigurationModificationDate]

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetDerivativeRights]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetDerivatives]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetFacetConfigurationExtended]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetFacets]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetFieldSetIdByFieldName]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetLanguageConfiguration]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetMetadata]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetRights]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetSubscriptionInfo]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetTotalAssets]

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetUserById]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element GetUsers]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element ImportSingleAsset]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element IsValid]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element Login]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element LoginWithSecurityToken]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element LoginWithSecurityToken2]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element MoveAssetContainer]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element RemoveAssetContainer]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element RemoveAssets]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element RemoveAssetsFromAssetContainers]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element RemoveAssetVersions]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element RemoveUsers]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element RenewSession]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element SaveAssetContainerRights]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element SaveAssetsRights]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element SaveDerivative]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element SaveDerivativeRights]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UpdateAssetContainer]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UpdateAssetLinks]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UpdateAssetMetadata]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UpdateAssetsMetadata]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UpdateFieldSetDefaultValue]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UpdateOriginalDerivative]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UpdateUser]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UploadChunk]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: coreInfo [element UploadFirstChunk]

Description

The CoreInfo object which has been returned by CreateSession.

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: CoreInfo

Derived By

Type CoreInfo

Content Model

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: Count [type FacetValue]

Derived By

Type int

Referenced By

Element: Countries [type PublicConfiguration]

Derived By

Type ArrayOfCountry

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Country  Country 
Referenced By

Element: Country [type ArrayOfCountry]

Derived By

Type Country

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Code  string 
CountryId  int 
Name  string 
Referenced By

Element: Country [type UserData]

Derived By

Type Country

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Code  string 
CountryId  int 
Name  string 
Referenced By

Element: Country

Derived By

Type Country

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Code  string 
CountryId  int 
Name  string 

Element: CountryId [type Country]

Derived By

Type int

Referenced By

Element: CountryId [type CountryTranslation]

Description

The id of the country.

Derived By

Type int

Referenced By

Element: CountryId [type UserData]

Derived By

Type int

Referenced By

Element: CountryId [type UserShort]

Derived By

Type int

Referenced By

Element: CountryName [type CountryTranslation]

Description

The name of the country in german(1), english(2) or french(3).

E.g. "Deutschland", "Germany", "Allemagne".

Derived By

Type string

Referenced By

Element: CountryTranslation [type ArrayOfCountryTranslation]

Derived By

Type CountryTranslation

Content Model

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.

Referenced By

Element: CountryTranslation

Derived By

Type CountryTranslation

Content Model

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.

Element: CountryTranslationId [type CountryTranslation]

Derived By

Type int

Referenced By

Element: CountryTranslations [type UserShort]

Derived By

Type ArrayOfCountryTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CountryTranslation  CountryTranslation 
Referenced By

Element: CreateAssetContainer

Derived By

Restricting anyType

Content Model

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.

Element: CreateAssetContainerResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CreateAssetContainerResult  int 

Element: CreateAssetContainerResult [element CreateAssetContainerResponse]

Derived By

Type int

Referenced By

Element: CreateAssetLink

Derived By

Restricting anyType

Content Model

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.

Element: CreateAssetLinkResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CreateAssetLinkResult  BusinessProcessShort 

Element: CreateAssetLinkResult [element CreateAssetLinkResponse]

Derived By

Type BusinessProcessShort

Content Model

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 
Referenced By

Element: CreatedByUserId [type AssetContainerItem]

Description

The id of the user who created the container.

Derived By

Type int

Referenced By

Element: CreatedByUserId [type AssetVersion]

Derived By

Type int

Referenced By

Element: CreatedByUserId [type RightTemplate]

Derived By

Type int

Referenced By

Element: CreatedByUserId [type RightTemplate2AssetType]

Derived By

Type int

Referenced By

Element: CreatedByUserId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: CreatedByUserId [type RightTemplate2UserGroup]

Derived By

Type int

Referenced By

Element: CreatedByUserId [type Skin]

Derived By

Type int

Referenced By

Element: CreatedByUserId [type UserData]

Derived By

Type int

Referenced By

Element: CreatedByUserId [type UserShort]

Derived By

Type int

Referenced By

Element: CreateHistoricVersion [type AssetUpdateOptions]

Description

Optional. If true, the old asset is not overwritten, but kept as a historic version. Default is false.

Derived By

Type boolean

Referenced By

Element: CreateRenderingJob

Derived By

Restricting anyType

Content Model

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.

Element: CreateRenderingJobResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CreateRenderingJobResult  int 

Element: CreateRenderingJobResult [element CreateRenderingJobResponse]

Derived By

Type int

Referenced By

Element: CreateSession

Derived By

Restricting anyType

Content Model

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.

Element: CreateSessionResponse

Derived By

Restricting anyType

Content Model

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.

Element: CreateSessionResult [element CreateSessionResponse]

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: createSingleDownload4MultipleFiles [element DownloadExtended]

Description

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.

Derived By

Type boolean

Referenced By

Element: CreateTraceJob

Derived By

Restricting anyType

Content Model

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.

Element: CreateTraceJobResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CreateTraceJobResult  int 

Element: CreateTraceJobResult [element CreateTraceJobResponse]

Derived By

Type int

Referenced By

Element: CreateUser

Derived By

Restricting anyType

Content Model

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.

Element: CreateUserResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CreateUserResult  int 

Element: CreateUserResult [element CreateUserResponse]

Derived By

Type int

Referenced By

Element: CreateZip4SingleFile [type DownloadOptions]

Description

If false and the download contains only one file, then the file is not zipped.

Derived By

Type boolean

Referenced By

Element: CreationDate [type AssetContainerItem]

Description

The creation date.

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type AssetVersion]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type DerivativeLock]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type ExtendedDerivative]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type PortAssetItem]

Derived By

Type string

Referenced By

Element: CreationDate [type RightTemplate]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type RightTemplate2AssetType]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type RightTemplate2Right]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type RightTemplate2UserGroup]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type Skin]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type UserData]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CreationDate [type UserShort]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: CssSource [type Skin]

Derived By

Type string

Referenced By

Element: customerId [element CreateSession]

Description

The id of the customer (picturepark), e.g. 123.

Derived By

Type int

Referenced By

Element: customerId [element GetContentLanguages]

Description

The customer id.

Derived By

Type int

Referenced By

Element: customerId [element GetSecurityToken]

Description

The id of the customer (picturepark), e.g. 27.

Derived By

Type int

Referenced By

Element: CustomerId [type CoreInfo]

Description

The id of the customer (Picturepark), which must be submitted when creating a session.

For Picturepark server solutions, this id is usually 1.

Derived By

Type int

Referenced By

Element: CustomerName [type CoreInfo]

Description

E.g. "Media database Walchwil". Currently not used, always null.

Derived By

Type string

Referenced By

Element: DataType [type Field]

Description

Integer32, String, Date, Boolean ..

Derived By

Type DataType

Enumeration
Value  Description 
Integer32 
Integer64 
String 
Date 
DateTime 
Boolean 
Double 
AlphaHandling 
BlurType 
FlipType 
NullableInteger32 
Float 
UserShort 
NullableDouble 
Color 
AssetContainerAssignment 
Referenced By

Element: DataType [type MetadataProperty]

Derived By

Type DataType

Enumeration
Value  Description 
Integer32 
Integer64 
String 
Date 
DateTime 
Boolean 
Double 
AlphaHandling 
BlurType 
FlipType 
NullableInteger32 
Float 
UserShort 
NullableDouble 
Color 
AssetContainerAssignment 
Referenced By

Element: DataType

Derived By

Type DataType

Enumeration
Value  Description 
Integer32 
Integer64 
String 
Date 
DateTime 
Boolean 
Double 
AlphaHandling 
BlurType 
FlipType 
NullableInteger32 
Float 
UserShort 
NullableDouble 
Color 
AssetContainerAssignment 

Element: DataTypeId [type MetadataProperty]

Derived By

Type int

Referenced By

Element: DateRange [type FacetConfigurationRange]

Derived By

Type FacetDateRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
From  string 
To  string 
Referenced By

Element: DateTime [type DateTimeOffset]

Derived By

Type dateTime

Referenced By

Element: dateTime

Derived By

Type dateTime

Element: DateTimeAfterOperation

Derived By

Type DateTimeAfterOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AfterDateTime  DateTimeOffset 

Element: DateTimeBeforeOperation

Derived By

Type DateTimeBeforeOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
BeforeDateTime  DateTimeOffset 

Element: DateTimeBetweenOperation

Derived By

Type DateTimeBetweenOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
AfterDateTime  DateTimeOffset 
BeforeDateTime  DateTimeOffset 

Element: DateTimeEqualOperation

Derived By

Type DateTimeEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualDateTime  DateTimeOffset 

Element: DateTimeNowAfterOperation

Derived By

Type DateTimeNowAfterOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 

Element: DateTimeNowAfterOrEqualOperation

Derived By

Type DateTimeNowAfterOrEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 

Element: DateTimeNowBeforeOrEqualOperation

Derived By

Type DateTimeNowBeforeOrEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 

Element: DateTimeNowLastOperation

Derived By

Type DateTimeNowLastOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 

Element: DateTimeNowNextOperation

Derived By

Type DateTimeNowNextOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 

Element: DateTimeNowOlderOperation

Derived By

Type DateTimeNowOlderOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
Minutes  int 

Element: DateTimeOffset

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 

Element: decimal

Derived By

Type decimal

Element: DefaultGridColumnWidth [type Field]

Description

The default field column width for the asset browser grid view.

Derived By

Type int

Referenced By

Element: DefaultLanguage4AssetContainerId [type Language4Content]

Derived By

Type int

Referenced By

Element: DefaultLanguage4ContentId [type Language4UserInterface]

Derived By

Type int

Referenced By

Element: DefaultLanguage4MetadataId [type Language4Content]

Derived By

Type int

Referenced By

Element: defaultValues [element UpdateFieldSetDefaultValue]

Description

The new default value.

Derived By

Type ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Element: DeleteAssetLinks

Derived By

Restricting anyType

Content Model

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.

Element: DeleteAssetLinksResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: Deleted [type AssetVersion]

Derived By

Type boolean

Referenced By

Element: Deleted [type DerivativeLock]

Derived By

Type boolean

Referenced By

Element: Deleted [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: Deleted [type RightTemplate]

Derived By

Type boolean

Referenced By

Element: Deleted [type RightTemplate2AssetType]

Derived By

Type boolean

Referenced By

Element: Deleted [type RightTemplate2Right]

Derived By

Type boolean

Referenced By

Element: Deleted [type RightTemplate2UserGroup]

Derived By

Type boolean

Referenced By

Element: Deleted [type Skin]

Derived By

Type boolean

Referenced By

Element: Deleted [type UserShort]

Derived By

Type boolean

Referenced By

Element: deleteDependentAssets [element RemoveAssets]

Description

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).

Derived By

Type boolean

Referenced By

Element: DeleteDependentAssets [type AssetUpdateOptions]

Description

Optional. If true, dependent assets like versions are deleted. Default is false.

Derived By

Type boolean

Referenced By

Element: DeleteDerivative

Derived By

Restricting anyType

Content Model

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.

Element: DeleteDerivativeResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: Department [type UserData]

Derived By

Type string

Referenced By

Element: Department [type UserShort]

Derived By

Type string

Referenced By

Element: Derivative [type ArrayOfDerivative]

Derived By

Type Derivative

Content Model

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 
Referenced By

Element: Derivative

Derived By

Type Derivative

Content Model

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: DerivativeDefinition [type ArrayOfDerivativeDefinition]

Derived By

Type DerivativeDefinition

Content Model

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 
Referenced By

Element: DerivativeDefinition

Derived By

Type DerivativeDefinition

Content Model

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 

Element: DerivativeDefinition2AssetType [type ArrayOfDerivativeDefinition2AssetType]

Derived By

Type DerivativeDefinition2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetTypeId  int 
DerivativeDefinition2AssetTypeId  int 
DerivativeDefinitionId  int 
ts  base64Binary 
Referenced By

Element: DerivativeDefinition2AssetType

Derived By

Type DerivativeDefinition2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetTypeId  int 
DerivativeDefinition2AssetTypeId  int 
DerivativeDefinitionId  int 
ts  base64Binary 

Element: DerivativeDefinition2AssetTypeId [type DerivativeDefinition2AssetType]

Derived By

Type int

Referenced By

Element: DerivativeDefinition2AssetTypes [type DerivativeDefinition]

Derived By

Type ArrayOfDerivativeDefinition2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinition2AssetType  DerivativeDefinition2AssetType 
Referenced By

Element: derivativeDefinitionId [element DeleteDerivative]

Description

The derivative definition id.

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type AssetObject]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type AssetSelection]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type BusinessProcessLink]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type Derivative]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type DerivativeDefinition2AssetType]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type DerivativeDefinitionRights]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type DerivativeDefinitionTranslation]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type DerivativeLock]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type DerivativeUpdateOptions]

Description

The deriviative definition id.

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type MediaInfo]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type PortDerivative]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type RenderingActionValue]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionId [type UserActionHistoryInfo]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionRight [type ArrayOfDerivativeDefinitionRight]

Derived By

Type DerivativeDefinitionRight

Enumeration
Value  Description 
CanBeOrdered 
Referenced By

Element: DerivativeDefinitionRight

Derived By

Type DerivativeDefinitionRight

Enumeration
Value  Description 
CanBeOrdered 

Element: DerivativeDefinitionRightId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: DerivativeDefinitionRights [type ArrayOfDerivativeDefinitionRights]

Derived By

Type DerivativeDefinitionRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionId  int 
DerivativeRights  ArrayOfDerivativeRight 
Referenced By

Element: DerivativeDefinitionRights [type Rights]

Derived By

Type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe  anyType (restriction) 
Referenced By

Element: DerivativeDefinitionRights [type UserDerivativeRights]

Derived By

Type ArrayOfDerivativeDefinitionRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  DerivativeDefinitionRights 
Referenced By

Element: DerivativeDefinitionRights

Derived By

Type DerivativeDefinitionRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionId  int 
DerivativeRights  ArrayOfDerivativeRight 

Element: DerivativeDefinitions [type PublicConfiguration]

Derived By

Type ArrayOfDerivativeDefinition

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinition  DerivativeDefinition 
Referenced By

Element: DerivativeDefinitionTranslation [type ArrayOfDerivativeDefinitionTranslation]

Derived By

Type DerivativeDefinitionTranslation

Content Model

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 
Referenced By

Element: DerivativeDefinitionTranslation [type PortDerivative]

Derived By

Type string

Referenced By

Element: DerivativeDefinitionTranslation

Derived By

Type DerivativeDefinitionTranslation

Content Model

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 

Element: DerivativeDefinitionTranslationId [type DerivativeDefinitionTranslation]

Derived By

Type int

Referenced By

Element: DerivativeId [type Derivative]

Derived By

Type int

Referenced By

Element: DerivativeId [type DerivativeLock]

Derived By

Type int

Referenced By

Element: DerivativeId [type PortDerivative]

Derived By

Type int

Referenced By

Element: DerivativeLock [type AssetMetadata]

Description

DerivativeLock. If not null this asset is locked.

Derived By

Type DerivativeLock

Content Model

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 
Referenced By

Element: DerivativeLock

Derived By

Type DerivativeLock

Content Model

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: DerivativeLockId [type DerivativeLock]

Derived By

Type int

Referenced By

Element: DerivativeModificationDate [type DerivativeLock]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: DerivativeModifiedByUser [type DerivativeLock]

Derived By

Type UserCompact

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
EmailAddress  string 
FirstName  string 
LastName  string 
UserId  int 
Referenced By

Element: DerivativeRight [type ArrayOfDerivativeRight]

Derived By

Type DerivativeRight

Enumeration
Value  Description 
Download 
Referenced By

Element: DerivativeRight

Derived By

Type DerivativeRight

Enumeration
Value  Description 
Download 

Element: DerivativeRightId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: DerivativeRights [type DerivativeDefinitionRights]

Derived By

Type ArrayOfDerivativeRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeRight  DerivativeRight 
Referenced By

Element: DerivativeRights [type UserGroupDerivativeRights]

Derived By

Type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h  anyType (restriction) 
Referenced By

Element: DerivativeRightTemplateId [type AssetImportOptions]

Description

The id of a DerivativeRightTemplate.

Derived By

Type int

Referenced By

Element: Derivatives [type AssetItem]

Description

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.

Derived By

Type ArrayOfDerivative

Content Model

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.
Referenced By

Element: Derivatives [type AssetMetadata]

Description

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.

Derived By

Type ArrayOfExtendedDerivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ExtendedDerivative  ExtendedDerivative  An extended derivative provides more detailed information than the usual derivative.
Referenced By

Element: DerivativeType [type DerivativeDefinition]

Derived By

Type DerivativeType

Enumeration
Value  Description 
Original 
Static 
Dynamic 
ThumbnailSmall 
ThumbnailMedium 
ThumbnailLarge 
Custom 
Referenced By

Element: DerivativeType

Derived By

Type DerivativeType

Enumeration
Value  Description 
Original 
Static 
Dynamic 
ThumbnailSmall 
ThumbnailMedium 
ThumbnailLarge 
Custom 

Element: derivativeUpdateOptions [element SaveDerivative]

Description

Complex data type containing multiple update parameters.

Derived By

Type DerivativeUpdateOptions

Content Model

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.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

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.


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,
};

TemporaryFileHandling  TemporaryFileHandling 

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Referenced By

Element: DerivativeUpdateOptions

Derived By

Type DerivativeUpdateOptions

Content Model

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.


Uri uri = new Uri("http://www.picturepark.com/test/xxx.jpg");

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.


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,
};

TemporaryFileHandling  TemporaryFileHandling 

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Element: description [element CreateAssetLink]

Description

The description.

Derived By

Type string

Referenced By

Element: Description [type AssetContainerTranslation]

Description

The asset container description in the language defined by LanguageId.

Derived By

Type string

Referenced By

Element: Description [type AssetVersion]

Derived By

Type string

Referenced By

Element: Description [type BusinessProcessShort]

Derived By

Type string

Referenced By

Element: Description [type DerivativeDefinitionTranslation]

Derived By

Type string

Referenced By

Element: Description [type PortAssetItem]

Description

The asset's further description (in most cases it'll be the field AssetDescription).

Derived By

Type string

Referenced By

Element: Description [type RightTemplate]

Derived By

Type string

Referenced By

Element: desiredAssetContainerLanguage [element GetAssetContainers]

Description

Optional. The language (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..).

ApplicationLanguage? desiredAssetContainerLanguage = ApplicationLanguage.English;
Derived By

Type ApplicationLanguage

Enumeration
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 
Referenced By

Element: DesiredMetadataLanguage [type AssetFilter]

Description

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
Derived By

Type ApplicationLanguage

Enumeration
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 
Referenced By

Element: destinationAssetContainerId [element MoveAssetContainer]

Description

The id of the new parent asset container.

Derived By

Type int

Referenced By

Element: DisplayName [type User]

Description

First name plus last name

Derived By

Type string

Referenced By

Element: distinct [element GetSubscriptionInfo]

Description

Flag: return distinct values only.

Derived By

Type boolean

Referenced By

Element: Document [type ArrayOfDocument]

Derived By

Type Document

Content Model

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 
Referenced By

Element: Document

Derived By

Type Document

Content Model

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: DocumentId [type Document]

Derived By

Type int

Referenced By

Element: DocumentId [type DocumentPage]

Derived By

Type int

Referenced By

Element: DocumentPage [type ArrayOfDocumentPage]

Derived By

Type DocumentPage

Content Model

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 
Referenced By

Element: DocumentPage

Derived By

Type DocumentPage

Content Model

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: DocumentPageId [type AssetObject]

Derived By

Type int

Referenced By

Element: DocumentPageId [type DocumentPage]

Derived By

Type int

Referenced By

Element: DocumentPages [type Document]

Derived By

Type ArrayOfDocumentPage

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DocumentPage  DocumentPage 
Referenced By

Element: Documents [type AssetMetadata]

Description

An array with all assigned Documents.

Derived By

Type ArrayOfDocument

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Document  Document 
Referenced By

Element: double

Derived By

Type double

Element: Download

Derived By

Type Download

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AvailableUntilDate  DateTimeOffset 
DownloadFileName  string 
DownloadToken  string 
FileSize  long 
URL  string 

Element: Download

Derived By

Restricting anyType

Content Model

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.

Element: DownloadableDerivatives [type PortAssetItem]

Description

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.

Derived By

Type ArrayOfPortDerivative

Content Model

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.
Referenced By

Element: DownloadExtended

Derived By

Restricting anyType

Content Model

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.

Element: DownloadExtendedResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DownloadExtendedResult  ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK 

Element: DownloadExtendedResult [element DownloadExtendedResponse]

Derived By

Type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK  anyType (restriction) 
Referenced By

Element: DownloadFileName [type Download]

Derived By

Type string

Referenced By

Element: downloadOptions [element Download]

Description

Defines the download options.

Derived By

Type DownloadOptions

Content Model

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.
Referenced By

Element: downloadOptions [element DownloadExtended]

Description

Defines the download options.

Derived By

Type DownloadOptions

Content Model

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.
Referenced By

Element: DownloadOptions

Derived By

Type DownloadOptions

Content Model

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: DownloadResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DownloadResult  Download 

Element: DownloadResult [element DownloadResponse]

Derived By

Type Download

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AvailableUntilDate  DateTimeOffset 
DownloadFileName  string 
DownloadToken  string 
FileSize  long 
URL  string 
Referenced By

Element: DownloadToken [type Download]

Derived By

Type string

Referenced By

Element: duration

Derived By

Type duration

Restrictions

Element: DurationInSeconds [type MediaInfo]

Derived By

Type duration

Restrictions
Referenced By

Element: Editable [type RightTemplate]

Derived By

Type boolean

Referenced By

Element: Elements [type FacetConfigurationJson]

Derived By

Type ArrayOfFacetConfigurationElement

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationElement  FacetConfigurationElement 
Referenced By

Element: Email [type User]

Derived By

Type string

Referenced By

Element: emailAddress [element GetSecurityToken]

Description

The email address of the (PAS) user, who will later log in from the publisher with the security token

Derived By

Type string

Referenced By

Element: EmailAddress [type UserCompact]

Derived By

Type string

Referenced By

Element: EmailAddress [type UserData]

Derived By

Type string

Referenced By

Element: EmailAddress [type UserShort]

Derived By

Type string

Referenced By

Element: EnglishName [type Language]

Derived By

Type string

Referenced By

Element: EpsHeightInPoints [type ExtendedDerivative]

Derived By

Type double

Referenced By

Element: EpsIsRasterized [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: EpsWidthInPoints [type ExtendedDerivative]

Derived By

Type double

Referenced By

Element: EqualDateTime [type DateTimeEqualOperation]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: EqualNumeric [type NumericEqualOperation]

Derived By

Type float

Referenced By

Element: EqualNumericList [type NumericListEqualOperation]

Derived By

Type ArrayOffloat

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
float  float 
Referenced By

Element: EqualString [type StringEqualOperation]

Derived By

Type string

Referenced By

Element: EqualStringList [type StringListEqualOperation]

Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Element: ErrorCode [type PictureparkFault]

Derived By

Type int

Referenced By

Element: exceptedAssetContainerIds [element SaveAssetContainerRights]

Description

A list of sub containers to be excluded (if IncludeSubAssetContainers is true )

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: ExclusivityGroupId [type AssetContainerAssignmentExtended]

Derived By

Type int

Referenced By

Element: ExclusivityGroupId [type AssetContainerItem]

Description

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.

Derived By

Type int

Referenced By

Element: expanded [type XmpItem]

Derived By

Type boolean

Referenced By

Element: expirationDate [element CreateAssetLink]

Description

The expiry date.

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ExpirationDate [type BusinessProcessShort]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ExpirationDate [type UserData]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ExpirationDate [type UserShort]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: extendedAssetFilter [element GetAssets]

Description

The extendedAssetFilter allows the definition of many additional parameters.

Derived By

Type ExtendedAssetFilter

Content Model

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:
.
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 ..
}

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:
.
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 ..
}

SimpleSearchString  string 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

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>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });

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 }
Referenced By

Element: ExtendedAssetFilter

Derived By

Type ExtendedAssetFilter

Content Model

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:
.
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 ..
}

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:
.
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 ..
}

SimpleSearchString  string 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

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>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });

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: ExtendedDerivative [type ArrayOfExtendedDerivative]

Derived By

Type ExtendedDerivative

Content Model

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 
CreationDate  DateTimeOffset 
Deleted  boolean 
EpsHeightInPoints  double 
EpsIsRasterized  boolean 
EpsWidthInPoints  double 
ImageBitsPerChannel  int 
ImageBitsPerPixel  int 
ImageChannels  string 
ImageColorProfile  string 
ImageColorSpaceId  int 
ImageHasAdobeResourceData  boolean 
ImageHasAlpha  boolean 
ImageHasExifData  boolean 
ImageHasIptcData  boolean 
ImageHasXmpData  boolean 
ImageHeightInCm  double 
ImageHeightInInch  double 
ImageHorizontalResolution  double 
ImageIsExtended  boolean 
ImageIsIndexed  boolean 
ImagePixelFormat  string 
ImageTotalFrames  int 
ImageTotalUnspecifiedTiffExtraChannels  int 
ImageUncompressedSizeInBytes  long 
ImageVerticalResolution  double 
ImageWidthInCm  double 
ImageWidthInInch  double 
ModificationDate  DateTimeOffset 
Sha1Hash  string 
Referenced By

Element: ExtendedDerivative

Derived By

Type ExtendedDerivative

Content Model

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 
CreationDate  DateTimeOffset 
Deleted  boolean 
EpsHeightInPoints  double 
EpsIsRasterized  boolean 
EpsWidthInPoints  double 
ImageBitsPerChannel  int 
ImageBitsPerPixel  int 
ImageChannels  string 
ImageColorProfile  string 
ImageColorSpaceId  int 
ImageHasAdobeResourceData  boolean 
ImageHasAlpha  boolean 
ImageHasExifData  boolean 
ImageHasIptcData  boolean 
ImageHasXmpData  boolean 
ImageHeightInCm  double 
ImageHeightInInch  double 
ImageHorizontalResolution  double 
ImageIsExtended  boolean 
ImageIsIndexed  boolean 
ImagePixelFormat  string 
ImageTotalFrames  int 
ImageTotalUnspecifiedTiffExtraChannels  int 
ImageUncompressedSizeInBytes  long 
ImageVerticalResolution  double 
ImageWidthInCm  double 
ImageWidthInInch  double 
ModificationDate  DateTimeOffset 
Sha1Hash  string 

Element: FacetConfigurationElement [type ArrayOfFacetConfigurationElement]

Derived By

Type FacetConfigurationElement

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
IsInitiallyOpen  boolean 
Ranges  ArrayOfFacetConfigurationRange 
SelectionBehavior  FacetInnerSelectionBehavior 
SortOrder  int 
Referenced By

Element: FacetConfigurationElement

Derived By

Type FacetConfigurationElement

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
IsInitiallyOpen  boolean 
Ranges  ArrayOfFacetConfigurationRange 
SelectionBehavior  FacetInnerSelectionBehavior 
SortOrder  int 

Element: FacetConfigurationExtended

Derived By

Type FacetConfigurationExtended

Content Model

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

Element: FacetConfigurationGroup [type ArrayOfFacetConfigurationGroup]

Derived By

Type FacetConfigurationGroup

Content Model

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)
Referenced By

Element: FacetConfigurationGroup

Derived By

Type FacetConfigurationGroup

Content Model

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)

Element: FacetConfigurationId [type BusinessProcessShort]

Derived By

Type int

Referenced By

Element: FacetConfigurationId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: FacetConfigurationId [type FacetSearchParameter]

Derived By

Type int

Referenced By

Element: FacetConfigurationJson [type FacetConfigurationViewItem]

Derived By

Type FacetConfigurationJson

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Elements  ArrayOfFacetConfigurationElement 
Groups  ArrayOfFacetConfigurationGroup 
Referenced By

Element: FacetConfigurationJson

Derived By

Type FacetConfigurationJson

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Elements  ArrayOfFacetConfigurationElement 
Groups  ArrayOfFacetConfigurationGroup 

Element: FacetConfigurationRange [type ArrayOfFacetConfigurationRange]

Derived By

Type FacetConfigurationRange

Content Model

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)
Referenced By

Element: FacetConfigurationRange

Derived By

Type FacetConfigurationRange

Content Model

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)

Element: FacetConfigurationTranslation [type ArrayOfFacetConfigurationTranslation]

Derived By

Type FacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
LanguageId  int 
Referenced By

Element: FacetConfigurationTranslation

Derived By

Type FacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
LanguageId  int 

Element: FacetConfigurationViewItem

Derived By

Type FacetConfigurationViewItem

Content Model

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: FacetDateRange

Derived By

Type FacetDateRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
From  string 
To  string 

Element: FacetInnerSelectionBehavior

Derived By

Type FacetInnerSelectionBehavior

Enumeration
Value  Description 
Or 
And 
ExclusiveOr 

Element: FacetResult [type ArrayOfFacetResult]

Derived By

Type FacetResult

Content Model

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 
Referenced By

Element: FacetResult

Derived By

Type FacetResult

Content Model

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: FacetResults

Derived By

Type FacetResults

Content Model

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: FacetSearchParameter [type ArrayOfFacetSearchParameter]

Derived By

Type FacetSearchParameter

Content Model

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
Referenced By

Element: FacetSearchParameter

Derived By

Type FacetSearchParameter

Content Model

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

Element: FacetValue [type ArrayOfFacetValue]

Derived By

Type FacetValue

Content Model

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 
Referenced By

Element: FacetValue

Derived By

Type FacetValue

Content Model

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: FallbackLanguage [type LanguageFallback]

Derived By

Type string

Referenced By

Element: FallbackLanguageId [type LanguageFallback]

Derived By

Type int

Referenced By

Element: Field [type ArrayOfField]

Derived By

Type Field

Content Model

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.
Referenced By

Element: Field

Derived By

Type Field

Content Model

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: FieldControlInfoId [type FieldControlInfos]

Description

The id of the field control info.

Derived By

Type int

Referenced By

Element: FieldControlInfos [type Field]

Description

Control Infos.

Derived By

Type FieldControlInfos

Content Model

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.
Referenced By

Element: FieldControlInfos

Derived By

Type FieldControlInfos

Content Model

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: FieldId [type AssetContainerAssignment]

Derived By

Type int

Referenced By

Element: FieldId [type FacetConfigurationElement]

Derived By

Type int

Referenced By

Element: FieldId [type FacetResult]

Description

Serves as identifier for the UI

Derived By

Type int

Referenced By

Element: FieldId [type FacetValue]

Derived By

Type int

Referenced By

Element: FieldId [type Field]

Description

The id of the field.

Derived By

Type int

Referenced By

Element: FieldId [type FieldControlInfos]

Description

The id of the field.

Derived By

Type int

Referenced By

Element: FieldId [type FieldOption]

Derived By

Type int

Referenced By

Element: FieldId [type FieldTranslation]

Derived By

Type int

Referenced By

Element: FieldId [type FieldValue]

Derived By

Type int

Referenced By

Element: FieldId [type KnownFieldValue]

Derived By

Type int

Referenced By

Element: fieldIds [element GetAssetsMetadata]

Description

A list of field ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldIds [type FacetConfigurationExtended]

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldIds [type FacetConfigurationGroup]

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldIdsOfFacets [type FacetSearchParameter]

Description

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

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldIdsOfUncollapsedFacets [type FacetSearchParameter]

Description

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.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldLookupEntity [type Field]

Description

The name of the table to which the field belongs: FieldValues, Assets, Derivatives ..

Derived By

Type FieldLookupEntity

Enumeration
Value  Description 
FieldValues 
Assets 
Derivatives 
Users 
Orders 
ClientOnly 
Assets2AssetContainers 
VideoStreams 
AudioStreams 
Referenced By

Element: FieldLookupEntity

Derived By

Type FieldLookupEntity

Enumeration
Value  Description 
FieldValues 
Assets 
Derivatives 
Users 
Orders 
ClientOnly 
Assets2AssetContainers 
VideoStreams 
AudioStreams 

Element: FieldLookupEntityId [type Field]

Description

The id of the FieldLookupEntity (see there).

Derived By

Type int

Referenced By

Element: fieldName [element GetFieldSetIdByFieldName]

Description

The field name (case sensitive!).

Derived By

Type string

Referenced By

Element: FieldName [type ComparisonOperation]

Derived By

Type string

Referenced By

Element: FieldName [type FacetValue]

Derived By

Type string

Referenced By

Element: FieldOption [type ArrayOfFieldOption]

Derived By

Type FieldOption

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
SortOrder  int 
Translations  ArrayOfFieldOptionTranslation 
ValueString  string 
ts  base64Binary 
Referenced By

Element: FieldOption

Derived By

Type FieldOption

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
SortOrder  int 
Translations  ArrayOfFieldOptionTranslation 
ValueString  string 
ts  base64Binary 

Element: FieldOptionId [type FieldOption]

Derived By

Type int

Referenced By

Element: FieldOptionId [type FieldOptionTranslation]

Derived By

Type int

Referenced By

Element: FieldOptionId [type FieldValue]

Derived By

Type int

Referenced By

Element: FieldOptionId [type KnownFieldValue]

Derived By

Type int

Referenced By

Element: FieldOptionsLookupEntity [type Field]

Description

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.

Derived By

Type FieldOptionsLookupEntity

Enumeration
Value  Description 
Languages4UserInterfaces 
Countries 
Users 
AssetRightTemplates 
DerivativeRightTemplates 
Sites 
Referenced By

Element: FieldOptionsLookupEntity

Derived By

Type FieldOptionsLookupEntity

Enumeration
Value  Description 
Languages4UserInterfaces 
Countries 
Users 
AssetRightTemplates 
DerivativeRightTemplates 
Sites 

Element: FieldOptionsLookupEntityId [type Field]

Description

The id of the FieldOptionsLookupEntityId (see there).

Derived By

Type int

Referenced By

Element: FieldOptionTranslation [type ArrayOfFieldOptionTranslation]

Derived By

Type FieldOptionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOptionId  int 
FieldOptionTranslationId  int 
LanguageId  int 
ValueString  string 
ts  base64Binary 
Referenced By

Element: FieldOptionTranslation

Derived By

Type FieldOptionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOptionId  int 
FieldOptionTranslationId  int 
LanguageId  int 
ValueString  string 
ts  base64Binary 

Element: FieldOptionTranslationId [type FieldOptionTranslation]

Derived By

Type int

Referenced By

Element: FieldRight [type ArrayOfFieldRight]

Derived By

Type FieldRight

Enumeration
Value  Description 
ViewFieldValues 
EditFieldValues 
EditFieldOptions 
Referenced By

Element: FieldRight

Derived By

Type FieldRight

Enumeration
Value  Description 
ViewFieldValues 
EditFieldValues 
EditFieldOptions 

Element: FieldRightId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: FieldRights [type Rights]

Derived By

Type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfFieldRightuUS27HWe  anyType (restriction) 
Referenced By

Element: fieldSetId [element UpdateFieldSetDefaultValue]

Description

The field set ID to apply the new default value to. It can be obtained by calling GetFieldSetIdByFieldName

Derived By

Type int

Referenced By

Element: FieldSetIds [type AssetContainerAssignmentExtended]

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldSetIds [type AssetContainerItem]

Description

A list of assigned field set ids.

FieldSetIds define which fields are assigned to an asset container. Needed for AssetClasses.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldSetIds [type AssetFieldValues]

Description

The fieldSetIds for this asset.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldSetIds [type AssetItem]

Description

A list of assigned field set ids.

FieldSetIds define which fields are assigned to an asset. Needed for AssetClasses.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: FieldTranslation [type ArrayOfFieldTranslation]

Derived By

Type FieldTranslation

Content Model

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 
Referenced By

Element: FieldTranslation

Derived By

Type FieldTranslation

Content Model

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: FieldTranslationId [type FieldTranslation]

Derived By

Type int

Referenced By

Element: FieldType [type Field]

Description

AssetField, UserField or AssetContainerField.

Derived By

Type FieldType

Enumeration
Value  Description 
AssetField 
UserField 
AssetContainerField 
Referenced By

Element: FieldType

Derived By

Type FieldType

Enumeration
Value  Description 
AssetField 
UserField 
AssetContainerField 

Element: FieldValue [type ArrayOfFieldValue]

Derived By

Type FieldValue

Content Model

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 
Referenced By

Element: FieldValue

Derived By

Type FieldValue

Content Model

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: FieldValueId [type FieldValue]

Derived By

Type int

Referenced By

Element: fieldValues [element UpdateAssetMetadata]

Description

A list of FieldValues.

Derived By

Type ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Element: FieldValues [type AssetFieldValues]

Description

Array of field values for this asset.

Derived By

Type ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Element: FieldValues [type AssetImportOptions]

Description

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},
.  ..
};

Derived By

Type ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Element: FieldValues [type AssetItem]

Description

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.

Derived By

Type ArrayOfKnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KnownFieldValue  KnownFieldValue 
Referenced By

Element: FieldValues [type AssetMetadata]

Description

An array with all FieldValues for this asset.

Derived By

Type ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Element: FieldValues [type DerivativeLock]

Derived By

Type ArrayOfKnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KnownFieldValue  KnownFieldValue 
Referenced By

Element: FieldValues [type UserData]

Derived By

Type ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Element: FieldValues [type UserShort]

Derived By

Type ArrayOfKnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KnownFieldValue  KnownFieldValue 
Referenced By

Element: fieldValues2Remove [element UpdateAssetMetadata]

Description

A list of field values to be deleted.

Derived By

Type ArrayOfFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldValue  FieldValue 
Referenced By

Element: FieldValueSource

Derived By

Type FieldValueSource

Enumeration
Value  Description 
FieldValues 
Assets 
Derivatives 
VideoStreams 
AudioStreams 
AssetClass 
XmpMetadata 

Element: FileExtension [type PortAssetItem]

Derived By

Type string

Referenced By

Element: FileExtensionId [type Derivative]

Derived By

Type int

Referenced By

Element: FileName [type AssetImportOptions]

Description

The file name with extension, needed only for an upload by MTOM.

Derived By

Type string

Referenced By

Element: FileName [type AssetUpdateOptions]

Description

The file name, which must have an extension. Needed only for an upload by MTOM.

Derived By

Type string

Referenced By

Element: FileName [type Derivative]

Description

E.g. "Matterhorn1.jpg".

Derived By

Type string

Referenced By

Element: FileName [type DerivativeUpdateOptions]

Description

The file name, which must have an extension. Needed only for an upload by MTOM.

Derived By

Type string

Referenced By

Element: FileSize [type Download]

Derived By

Type long

Referenced By

Element: FileSize [type PortAssetItem]

Derived By

Type string

Referenced By

Element: FileSize [type PortDerivative]

Derived By

Type string

Referenced By

Element: FileSizeInBytes [type Derivative]

Derived By

Type long

Referenced By

Element: FirstName [type UserCompact]

Derived By

Type string

Referenced By

Element: FirstName [type UserData]

Derived By

Type string

Referenced By

Element: FirstName [type UserShort]

Derived By

Type string

Referenced By

Element: float [type ArrayOffloat]

Derived By

Type float

Referenced By

Element: float

Derived By

Type float

Element: Format [type MediaInfo]

Derived By

Type string

Referenced By

Element: From [type FacetDateRange]

Derived By

Type string

Referenced By

Element: FromNumeric [type FacetConfigurationRange]

Derived By

Type float

Referenced By

Element: GetAssetContainerRights

Derived By

Restricting anyType

Content Model

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.

Element: GetAssetContainerRightsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetContainerRightsResult  ArrayOfUserGroupAssetContainerRights 

Element: GetAssetContainerRightsResult [element GetAssetContainerRightsResponse]

Derived By

Type ArrayOfUserGroupAssetContainerRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetContainerRights  UserGroupAssetContainerRights 
Referenced By

Element: GetAssetContainers

Derived By

Restricting anyType

Content Model

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;

Element: GetAssetContainersResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetContainersResult  ArrayOfAssetContainerItem 

Element: GetAssetContainersResult [element GetAssetContainersResponse]

Derived By

Type ArrayOfAssetContainerItem

Content Model

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.
Referenced By

Element: GetAssetFields

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.

Element: GetAssetFieldsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetFieldsResult  ArrayOfField 

Element: GetAssetFieldsResult [element GetAssetFieldsResponse]

Derived By

Type ArrayOfField

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Field  Field  Defines the attributes of a Field (Asset-, User- or AssetContainerField)
Referenced By

Element: GetAssetLinksById

Derived By

Restricting anyType

Content Model

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.

Element: GetAssetLinksByIdResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetLinksByIdResult  ArrayOfBusinessProcessShort 

Element: GetAssetLinksByIdResult [element GetAssetLinksByIdResponse]

Derived By

Type ArrayOfBusinessProcessShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessShort  BusinessProcessShort 
Referenced By

Element: GetAssetRights

Derived By

Restricting anyType

Content Model

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.

Element: GetAssetRightsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetRightsResult  ArrayOfUserGroupAssetRights 

Element: GetAssetRightsResult [element GetAssetRightsResponse]

Derived By

Type ArrayOfUserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetRights  UserGroupAssetRights 
Referenced By

Element: GetAssets

Derived By

Restricting anyType

Content Model

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.

Element: GetAssets2

Derived By

Restricting anyType

Content Model

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 

Element: GetAssets2Response

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssets2Result  PortAssetItemCollection 

Element: GetAssets2Result [element GetAssets2Response]

Derived By

Type PortAssetItemCollection

Content Model

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.

Referenced By

Element: GetAssetsByIds

Derived By

Restricting anyType

Content Model

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.

Element: GetAssetsByIdsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetsByIdsResult  AssetItemCollection 

Element: GetAssetsByIdsResult [element GetAssetsByIdsResponse]

Derived By

Type AssetItemCollection

Content Model

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.

Referenced By

Element: GetAssetsMetadata

Derived By

Restricting anyType

Content Model

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.

Element: GetAssetsMetadataResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetsMetadataResult  ArrayOfAssetFieldValues 

Element: GetAssetsMetadataResult [element GetAssetsMetadataResponse]

Derived By

Type ArrayOfAssetFieldValues

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetFieldValues  AssetFieldValues 
Referenced By

Element: GetAssetsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetsResult  AssetItemCollection 

Element: GetAssetsResult [element GetAssetsResponse]

Derived By

Type AssetItemCollection

Content Model

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.

Referenced By

Element: GetAssetVersions

Derived By

Restricting anyType

Content Model

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.

Element: GetAssetVersionsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetAssetVersionsResult  ArrayOfAssetVersion 

Element: GetAssetVersionsResult [element GetAssetVersionsResponse]

Derived By

Type ArrayOfAssetVersion

Content Model

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).

Referenced By

Element: GetConfiguration

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.

Element: GetConfigurationModificationDate

Derived By

Restricting anyType

Content Model

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.

Element: GetConfigurationModificationDateResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetConfigurationModificationDateResult  DateTimeOffset 

Element: GetConfigurationModificationDateResult [element GetConfigurationModificationDateResponse]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: GetConfigurationResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetConfigurationResult  PublicConfiguration 

Element: GetConfigurationResult [element GetConfigurationResponse]

Derived By

Type PublicConfiguration

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Countries  ArrayOfCountry 
DerivativeDefinitions  ArrayOfDerivativeDefinition 
PictureparkVersion  Version 
Referenced By

Element: GetContentLanguages

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
customerId  int  The customer id.

Element: GetContentLanguagesResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetContentLanguagesResult  ArrayOfLanguage4Content 

Element: GetContentLanguagesResult [element GetContentLanguagesResponse]

Derived By

Type ArrayOfLanguage4Content

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Content  Language4Content 
Referenced By

Element: GetDerivativeRights

Derived By

Restricting anyType

Content Model

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.

Element: GetDerivativeRightsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetDerivativeRightsResult  ArrayOfUserDerivativeRights 

Element: GetDerivativeRightsResult [element GetDerivativeRightsResponse]

Derived By

Type ArrayOfUserDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserDerivativeRights  UserDerivativeRights 
Referenced By

Element: GetDerivatives

Derived By

Restricting anyType

Content Model

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.

Element: GetDerivativesResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetDerivativesResult  ArrayOfExtendedDerivative 

Element: GetDerivativesResult [element GetDerivativesResponse]

Derived By

Type ArrayOfExtendedDerivative

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ExtendedDerivative  ExtendedDerivative  An extended derivative provides more detailed information than the usual derivative.
Referenced By

Element: GetFacetConfigurationExtended

Derived By

Restricting anyType

Content Model

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.

Element: GetFacetConfigurationExtendedResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetFacetConfigurationExtendedResult  FacetConfigurationExtended 

Element: GetFacetConfigurationExtendedResult [element GetFacetConfigurationExtendedResponse]

Derived By

Type FacetConfigurationExtended

Content Model

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
Referenced By

Element: GetFacets

Derived By

Restricting anyType

Content Model

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.

Element: GetFacetsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetFacetsResult  FacetResults 

Element: GetFacetsResult [element GetFacetsResponse]

Derived By

Type FacetResults

Content Model

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)
Referenced By

Element: GetFieldSetIdByFieldName

Derived By

Restricting anyType

Content Model

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!).

Element: GetFieldSetIdByFieldNameResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetFieldSetIdByFieldNameResult  int 

Element: GetFieldSetIdByFieldNameResult [element GetFieldSetIdByFieldNameResponse]

Derived By

Type int

Referenced By

Element: GetLanguageConfiguration

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.

Element: GetLanguageConfigurationResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetLanguageConfigurationResult  LanguageConfiguration 

Element: GetLanguageConfigurationResult [element GetLanguageConfigurationResponse]

Derived By

Type LanguageConfiguration

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Languages4AssetContainers  ArrayOfLanguage4AssetContainer 
Languages4Contents  ArrayOfLanguage4Content 
Languages4FullTextIndexes  ArrayOfLanguage4FullTextIndex 
Languages4Metadata  ArrayOfLanguage4Metadata 
Languages4UserInterfaces  ArrayOfLanguage4UserInterface 
Languages4Version  ArrayOfLanguage4Version 
Referenced By

Element: GetMetadata

Derived By

Restricting anyType

Content Model

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.

Element: GetMetadataResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetMetadataResult  AssetMetadata  Represents the metadata of an asset.

Element: GetMetadataResult [element GetMetadataResponse]

Derived By

Type AssetMetadata

Content Model

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.
Referenced By

Element: GetRights

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.

Element: GetRightsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetRightsResult  Rights 

Element: GetRightsResult [element GetRightsResponse]

Derived By

Type Rights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe 
FieldRights  ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe 
HasPPMCRights  boolean 
PersonalItemRights  ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe 
RightTemplates  ArrayOfRightTemplate 
SiteRights  ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe 
UserGroupRights  ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe 
UserRights  ArrayOfUserRight 
WidgetRights  ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe 
Referenced By

Element: GetSecurityToken

Derived By

Restricting anyType

Content Model

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.

Element: GetSecurityTokenResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetSecurityTokenResult  string 

Element: GetSecurityTokenResult [element GetSecurityTokenResponse]

Derived By

Type string

Referenced By

Element: GetSubscriptionInfo

Derived By

Restricting anyType

Content Model

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.

Element: GetSubscriptionInfoResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetSubscriptionInfoResult  UserActionHistoryInfoCollection 

Element: GetSubscriptionInfoResult [element GetSubscriptionInfoResponse]

Derived By

Type UserActionHistoryInfoCollection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BatchGuid  string 
TotalUserActionHistoryInfos  int 
UserActionHistoryInfos  ArrayOfUserActionHistoryInfo 
Referenced By

Element: GetTotalAssets

Derived By

Restricting anyType

Content Model

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 

Element: GetTotalAssetsResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetTotalAssetsResult  ArrayOfAssetContainerTotalAssets 

Element: GetTotalAssetsResult [element GetTotalAssetsResponse]

Derived By

Type ArrayOfAssetContainerTotalAssets

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerTotalAssets  AssetContainerTotalAssets 
Referenced By

Element: GetUserById

Derived By

Restricting anyType

Content Model

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.

Element: GetUserByIdResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetUserByIdResult  UserData 

Element: GetUserByIdResult [element GetUserByIdResponse]

Derived By

Type UserData

Content Model

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 
Country  Country 
CountryId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Department  string 
EmailAddress  string 
ExpirationDate  DateTimeOffset 
FieldValues  ArrayOfFieldValue 
FirstName  string 
Guid4PasswordReset  string 
HasTermsAccepted  boolean 
Impersonation  Impersonation 
InternalContactUserId  int 
IsGuest  boolean 
IsSupport  boolean 
IsSupportContact  boolean 
IsUpdaterServiceUser  boolean 
LanguageId  int 
LastActiveFacetConfigurationId  int 
LastLoginDate  DateTimeOffset 
LastName  string 
LockDate  DateTimeOffset 
LoginOnlyWithClaimsIdentity  boolean 
LoginOnlyWithSecurityToken  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Phone  string 
RegistrationState  RegistrationState 
RenewalState  RenewalState 
RenewalUntilDate  DateTimeOffset 
SiteId  int 
UseLdapAuthentication  boolean 
UserGroupIds  ArrayOfint 
UserId  int 
Zip  string 
ts  base64Binary 
Referenced By

Element: GetUsers

Derived By

Restricting anyType

Content Model

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.

Element: GetUsersResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
GetUsersResult  UserCollection 

Element: GetUsersResult [element GetUsersResponse]

Derived By

Type UserCollection

Content Model

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.
Referenced By

Element: GlobalUser [type CoreInfo]

Description

Session specific User data.

Derived By

Type User

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DisplayName  string  First name plus last name
Email  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 
Referenced By

Element: Group [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: Group [type FacetResult]

Derived By

Type ArrayOfFacetResult

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetResult  FacetResult 
Referenced By

Element: Groups [type FacetConfigurationJson]

Derived By

Type ArrayOfFacetConfigurationGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationGroup  FacetConfigurationGroup 
Referenced By

Element: GroupSid [type ClaimGroup]

Derived By

Type string

Referenced By

Element: guid

Derived By

Type guid

Restrictions

Element: Guid4PasswordReset [type UserData]

Derived By

Type string

Referenced By

Element: Guid4PasswordReset [type UserShort]

Derived By

Type string

Referenced By

Element: HasPPMCRights [type Rights]

Derived By

Type boolean

Referenced By

Element: HasTermsAccepted [type UserData]

Derived By

Type boolean

Referenced By

Element: Height [type PortDerivative]

Derived By

Type int

Referenced By

Element: HeightInCm [type AssetObject]

Derived By

Type double

Referenced By

Element: HeightInCm [type DocumentPage]

Derived By

Type double

Referenced By

Element: HideBackendLink [type FacetConfigurationViewItem]

Derived By

Type boolean

Referenced By

Element: HistoricVersionDescription [type AssetUpdateOptions]

Description

Optional. Same logic as HistoricVersionName.

Derived By

Type string

Referenced By

Element: HistoricVersionDescription4Master [type AssetUpdateOptions]

Description

Optional. Same logic as HistoricVersionName4Master.

Derived By

Type string

Referenced By

Element: HistoricVersionName [type AssetUpdateOptions]

Description

Optional. The name of the newly created historic version (if param CreateHistoricVersion = true).

Derived By

Type string

Referenced By

Element: HistoricVersionName4Master [type AssetUpdateOptions]

Description

Optional. The historic version name of the newly uploaded asset (if param CreateHistoricVersion = true).

Derived By

Type string

Referenced By

Element: Hits [type FacetValue]

Derived By

Type int

Referenced By

Element: HtmlSource [type Skin]

Derived By

Type string

Referenced By

Element: httpContextRequestInfo [element CreateSession]

Description

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.

Derived By

Type HttpContextRequestInfo

Content Model

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.
Referenced By

Element: HttpContextRequestInfo

Derived By

Type HttpContextRequestInfo

Content Model

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: IconId [type AssetContainerAssignmentExtended]

Derived By

Type int

Referenced By

Element: IconId [type AssetContainerItem]

Description

The id of the icon used for the display of the asset container.

Derived By

Type int

Referenced By

Element: IconId [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: IdentityProviderId [type ClaimGroup]

Derived By

Type int

Referenced By

Element: IetfLanguageTag [type Language]

Derived By

Type string

Referenced By

Element: ImageBitsPerChannel [type ExtendedDerivative]

Derived By

Type int

Referenced By

Element: ImageBitsPerPixel [type ExtendedDerivative]

Derived By

Type int

Referenced By

Element: ImageChannels [type ExtendedDerivative]

Derived By

Type string

Referenced By

Element: ImageColorProfile [type ExtendedDerivative]

Derived By

Type string

Referenced By

Element: ImageColorProfileId [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: ImageColorSpaceId [type ExtendedDerivative]

Derived By

Type int

Referenced By

Element: ImageColorTransformationIntentId [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: ImageEncodingOptionId [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: ImageHasAdobeResourceData [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: ImageHasAlpha [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: ImageHasExifData [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: ImageHasIptcData [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: ImageHasXmpData [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: ImageHeight [type Derivative]

Derived By

Type int

Referenced By

Element: ImageHeightInCm [type ExtendedDerivative]

Derived By

Type double

Referenced By

Element: ImageHeightInInch [type ExtendedDerivative]

Derived By

Type double

Referenced By

Element: ImageHorizontalResolution [type ExtendedDerivative]

Derived By

Type double

Referenced By

Element: ImageIsExtended [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: ImageIsIndexed [type ExtendedDerivative]

Derived By

Type boolean

Referenced By

Element: ImageKeepClippingPath [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: ImagePixelFormat [type ExtendedDerivative]

Derived By

Type string

Referenced By

Element: ImageResolution [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: ImageTotalFrames [type ExtendedDerivative]

Derived By

Type int

Referenced By

Element: ImageTotalUnspecifiedTiffExtraChannels [type ExtendedDerivative]

Derived By

Type int

Referenced By

Element: ImageUncompressedSizeInBytes [type ExtendedDerivative]

Derived By

Type long

Referenced By

Element: ImageVerticalResolution [type ExtendedDerivative]

Derived By

Type double

Referenced By

Element: ImageWidth [type Derivative]

Derived By

Type int

Referenced By

Element: ImageWidthInCm [type ExtendedDerivative]

Derived By

Type double

Referenced By

Element: ImageWidthInInch [type ExtendedDerivative]

Derived By

Type double

Referenced By

Element: ImpersonatedEmailAddress [type Impersonation]

Derived By

Type string

Referenced By

Element: Impersonation [type UserData]

Derived By

Type Impersonation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ImpersonatedEmailAddress  string 
ImpersonationId  int 
Referenced By

Element: Impersonation

Derived By

Type Impersonation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ImpersonatedEmailAddress  string 
ImpersonationId  int 

Element: ImpersonationId [type Impersonation]

Derived By

Type int

Referenced By

Element: ImportGuid [type AssetImportOptions]

Description

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,

Derived By

Type guid

Restrictions
Referenced By

Element: ImportGuid [type AssetUpdateOptions]

Description

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,
. ..
};

Derived By

Type guid

Restrictions
Referenced By

Element: ImportGuid [type DerivativeUpdateOptions]

Description

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,
};

Derived By

Type guid

Restrictions
Referenced By

Element: ImportRelativeFilePath [type AssetImportOptions]

Description

Needed only for batch import, which is not available for public webservices.

Derived By

Type string

Referenced By

Element: ImportSingleAsset

Derived By

Restricting anyType

Content Model

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.

Element: ImportSingleAssetResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ImportSingleAssetResult  int 

Element: ImportSingleAssetResult [element ImportSingleAssetResponse]

Derived By

Type int

Referenced By

Element: ImportUrl [type AssetImportOptions]

Description

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"

Derived By

Type string

Referenced By

Element: IncludeInAssetIndexFullTexts [type Field]

Description

If true, this field is searched in case of a full text search.

Derived By

Type boolean

Referenced By

Element: IncludeInCustomDBIndex [type Field]

Description

If true, this field is searched in case of a full text index.

Derived By

Type boolean

Referenced By

Element: IncludeMax [type NumericBetweenOperation]

Description

Include upper boundarie's value in result. Lucene syntax only!

Derived By

Type boolean

Referenced By

Element: IncludeMax [type NumericSmallerThanOperation]

Description

Include upper boundarie's value in result. Lucene syntax only!

Derived By

Type boolean

Referenced By

Element: IncludeMin [type NumericBetweenOperation]

Description

Include lower boundarie's value in result. Lucene syntax only!

Derived By

Type boolean

Referenced By

Element: IncludeMin [type NumericLargerThanOperation]

Description

Include lower boundarie's value in result. Lucene syntax only!

Derived By

Type boolean

Referenced By

Element: IncludeSubAssetContainers [type AssetContainerComparisonOperation]

Derived By

Type boolean

Referenced By

Element: IncludeSubAssetContainers [type AssetContainerExcludeFieldOperation]

Derived By

Type boolean

Referenced By

Element: IncludeSubAssetContainers [type AssetContainerIncludeFieldOperation]

Derived By

Type boolean

Referenced By

Element: Indexes [type AssetContainerAssignmentExtended]

Derived By

Type ArrayOfAssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerIndex  AssetContainerIndex 
Referenced By

Element: Indexes [type AssetContainerItem]

Description

An array with the indexes for each asset container language (contains the language specific absolute paths, e.g. "animals\pets\dogs\")

Derived By

Type ArrayOfAssetContainerIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerIndex  AssetContainerIndex 
Referenced By

Element: InitialAssetFilter [type FacetConfigurationExtended]

Derived By

Type ExtendedAssetFilter

Content Model

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:
.
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 ..
}

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:
.
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 ..
}

SimpleSearchString  string 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

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>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });

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 }
Referenced By

Element: insertBeforeAssetContainerId [element MoveAssetContainer]

Description

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.

Derived By

Type int

Referenced By

Element: int [type ArrayOfint]

Derived By

Type int

Referenced By

Element: int

Derived By

Type int

Element: InternalContactUserId [type UserData]

Derived By

Type int

Referenced By

Element: InternalContactUserId [type UserShort]

Derived By

Type int

Referenced By

Element: IsArray [type MetadataProperty]

Derived By

Type boolean

Referenced By

Element: isAssetRightTemplateOverridden [element SaveAssetsRights]

Description

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.

Derived By

Type boolean

Referenced By

Element: IsAssetRightTemplateOverridden [type AssetImportOptions]

Description

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.

Derived By

Type boolean

Referenced By

Element: IsAssetRightTemplateOverridden [type AssetItem]

Description

If true, the applied asset right template is ignored and the rights particularly assigned to this asset are applied.

Derived By

Type boolean

Referenced By

Element: IsAssetRightTemplateOverridden [type AssetMetadata]

Description

If true, there are more specific access rights defined for this asset and the settings of the AppliedAssetRightTemplateId are ignored.

Derived By

Type boolean

Referenced By

Element: IsDefault [type FacetConfigurationViewItem]

Derived By

Type boolean

Referenced By

Element: IsDefault [type Language4UserInterface]

Derived By

Type boolean

Referenced By

Element: IsDefault [type RightTemplate]

Derived By

Type boolean

Referenced By

Element: IsDefault [type UserGroupItem]

Derived By

Type boolean

Referenced By

Element: IsDefaultLanguage4Content [type Language4Content]

Derived By

Type boolean

Referenced By

Element: isDerivativeRightTemplateOverridden [element SaveDerivativeRights]

Description

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.

Derived By

Type boolean

Referenced By

Element: IsDerivativeRightTemplateOverridden [type AssetImportOptions]

Description

Optional. If true, the assigned DerivativeRightTemplateId is ignored and rights specifically assigned to this derivative are applied. Default is false.

Derived By

Type boolean

Referenced By

Element: IsDerivativeRightTemplateOverridden [type AssetItem]

Description

If true, the applied derivative right template is ignored and the rights particularly assigned to the derivatives are applied.

Derived By

Type boolean

Referenced By

Element: IsDerivativeRightTemplateOverridden [type AssetMetadata]

Description

Same logic as with IsAssetRightTemplateOverridden.

Derived By

Type boolean

Referenced By

Element: IsFavorite [type Language4Version]

Derived By

Type boolean

Referenced By

Element: IsFullWidth [type PortViewField]

Derived By

Type boolean

Referenced By

Element: IsGuest [type UserData]

Derived By

Type boolean

Referenced By

Element: IsGuest [type UserShort]

Derived By

Type boolean

Referenced By

Element: IsGuestGroup [type UserGroupItem]

Derived By

Type boolean

Referenced By

Element: IsInitiallyOpen [type FacetConfigurationElement]

Derived By

Type boolean

Referenced By

Element: IsInitiallyOpen [type FacetConfigurationGroup]

Derived By

Type boolean

Referenced By

Element: IsInitiallyOpen [type FacetResult]

Derived By

Type boolean

Referenced By

Element: IsLanguageSpecific [type Field]

Description

Language specific fields like AssetName and AssetDescription may have different values depending on the language.

Derived By

Type boolean

Referenced By

Element: IsMappable [type MetadataProperty]

Derived By

Type boolean

Referenced By

Element: IsNeutralCulture [type Language]

Derived By

Type boolean

Referenced By

Element: IsOpen [type FacetResult]

Derived By

Type boolean

Referenced By

Element: IsReadOnly [type Field]

Description

A read only field can be updated only by the system, not by a user.

Derived By

Type boolean

Referenced By

Element: IsRequired [type Field]

Description

If true, this field cannot be empty or null.

Derived By

Type boolean

Referenced By

Element: IsRequired [type Language4Metadata]

Derived By

Type boolean

Referenced By

Element: isRightTemplateOverridden [element SaveAssetContainerRights]

Description

If true, the right template is not used.

Derived By

Type boolean

Referenced By

Element: IsRightTemplateOverridden [type AssetContainerItem]

Description

If true, the applied right template is ignored and the rights particularly assigned to this asset container are applied.

Derived By

Type boolean

Referenced By

Element: IsSelected [type FacetValue]

Derived By

Type boolean

Referenced By

Element: IsSupport [type UserData]

Derived By

Type boolean

Referenced By

Element: IsSupportContact [type UserData]

Derived By

Type boolean

Referenced By

Element: IsSupportContact [type UserShort]

Derived By

Type boolean

Referenced By

Element: IsSystemField [type Field]

Description

A system field like Sha1Hash or Fulltext is needed for programming purposes and not visible for a user.

Derived By

Type boolean

Referenced By

Element: IsUpdaterServiceUser [type UserData]

Derived By

Type boolean

Referenced By

Element: IsUpdaterServiceUser [type UserShort]

Derived By

Type boolean

Referenced By

Element: IsValid

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.

Element: IsValidResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
IsValidResult  boolean 

Element: IsValidResult [element IsValidResponse]

Derived By

Type boolean

Referenced By

Element: JsonSerializedSvgAttributes [type AssetObject]

Derived By

Type string

Referenced By

Element: KeepAssetId4NewFileOnHistorize [type AssetUpdateOptions]

Description

If true, the new file inherits the asset id of the old.

Derived By

Type boolean

Referenced By

Element: KeepOriginalFileName [type DownloadOptions]

Description

If false the original filename is taken and the configured download filename rules are ignored.

Derived By

Type boolean

Referenced By

Element: Key [type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h/KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h]

Derived By

Type DerivativeDefinition

Content Model

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 
Referenced By

Element: Key [type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK/KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK]

Derived By

Type Download

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AbsolutePath  string 
AvailableUntilDate  DateTimeOffset 
DownloadFileName  string 
DownloadToken  string 
FileSize  long 
URL  string 
Referenced By

Element: Key [type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe/KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe]

Derived By

Type int

Referenced By

Element: Key [type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe/KeyValueOfintArrayOfFieldRightuUS27HWe]

Derived By

Type int

Referenced By

Element: Key [type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe/KeyValueOfintArrayOfPersonalItemRightuUS27HWe]

Derived By

Type int

Referenced By

Element: Key [type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe/KeyValueOfintArrayOfSiteRightuUS27HWe]

Derived By

Type int

Referenced By

Element: Key [type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe/KeyValueOfintArrayOfUserGroupRightuUS27HWe]

Derived By

Type int

Referenced By

Element: Key [type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe/KeyValueOfintArrayOfWidgetRightuUS27HWe]

Derived By

Type int

Referenced By

Element: Key [type ArrayOfKeyValueOfintPortViewField6jg_STziK/KeyValueOfintPortViewField6jg_STziK]

Derived By

Type int

Referenced By

Element: KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h [type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  DerivativeDefinition 
Value  ArrayOfDerivativeRight 
Referenced By

Element: KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK [type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  Download 
Value  ArrayOfAssetSelection 
Referenced By

Element: KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  int 
Value  ArrayOfDerivativeDefinitionRight 
Referenced By

Element: KeyValueOfintArrayOfFieldRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  int 
Value  ArrayOfFieldRight 
Referenced By

Element: KeyValueOfintArrayOfPersonalItemRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  int 
Value  ArrayOfPersonalItemRight 
Referenced By

Element: KeyValueOfintArrayOfSiteRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  int 
Value  ArrayOfSiteRight 
Referenced By

Element: KeyValueOfintArrayOfUserGroupRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  int 
Value  ArrayOfUserGroupRight 
Referenced By

Element: KeyValueOfintArrayOfWidgetRightuUS27HWe [type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  int 
Value  ArrayOfWidgetRight 
Referenced By

Element: KeyValueOfintPortViewField6jg_STziK [type ArrayOfKeyValueOfintPortViewField6jg_STziK]

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Key  int 
Value  PortViewField 
Referenced By

Element: KnownFieldValue [type ArrayOfKnownFieldValue]

Derived By

Type KnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Referenced By

Element: KnownFieldValue

Derived By

Type KnownFieldValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 

Element: KnownFieldValueAssetContainerAssignment

Derived By

Type KnownFieldValueAssetContainerAssignment

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  AssetContainerAssignmentExtended 

Element: KnownFieldValueBoolean

Derived By

Type KnownFieldValueBoolean

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  boolean 

Element: KnownFieldValueDateTime

Derived By

Type KnownFieldValueDateTime

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  DateTimeOffset 

Element: KnownFieldValueDouble

Derived By

Type KnownFieldValueDouble

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  double 

Element: KnownFieldValueInteger32

Derived By

Type KnownFieldValueInteger32

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  int 

Element: KnownFieldValueInteger64

Derived By

Type KnownFieldValueInteger64

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  long 

Element: KnownFieldValueString

Derived By

Type KnownFieldValueString

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
LanguageId  int 
Value  string 

Element: KnownFieldValueUserShort

Derived By

Type KnownFieldValueUserShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldId  int 
FieldOptionId  int 
StringValue  string 
Value  UserShort 

Element: language [element CreateSession]

Description

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.

Derived By

Type ApplicationLanguage

Enumeration
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 
Referenced By

Element: Language [type Language4AssetContainer]

Derived By

Type Language

Content Model

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 
Referenced By

Element: Language [type Language4Content]

Derived By

Type Language

Content Model

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 
Referenced By

Element: Language [type Language4FullTextIndex]

Derived By

Type Language

Content Model

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 
Referenced By

Element: Language [type Language4Metadata]

Derived By

Type Language

Content Model

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 
Referenced By

Element: Language [type Language4UserInterface]

Derived By

Type Language

Content Model

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 
Referenced By

Element: Language [type Language4Version]

Derived By

Type Language

Content Model

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 
Referenced By

Element: Language [type PictureparkFault]

Derived By

Type ApplicationLanguage

Enumeration
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 
Referenced By

Element: Language [type User]

Description

The gui language for this user, which is stored in the user profile, e.g. "English".

Derived By

Type ApplicationLanguage

Enumeration
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 
Referenced By

Element: Language

Derived By

Type Language

Content Model

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: Language4AssetContainer [type ArrayOfLanguage4AssetContainer]

Derived By

Type Language4AssetContainer

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CopyLanguageId  int 
Language  Language 
Language4AssetContainerId  int 
LanguageId  int 
ts  base64Binary 
Referenced By

Element: Language4AssetContainer

Derived By

Type Language4AssetContainer

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CopyLanguageId  int 
Language  Language 
Language4AssetContainerId  int 
LanguageId  int 
ts  base64Binary 

Element: Language4AssetContainerId [type Language4AssetContainer]

Derived By

Type int

Referenced By

Element: Language4Content [type ArrayOfLanguage4Content]

Derived By

Type Language4Content

Content Model

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 
Referenced By

Element: Language4Content

Derived By

Type Language4Content

Content Model

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: language4ContentId [element CreateSession]

Description

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.

Derived By

Type int

Referenced By

Element: language4ContentId [element LoginWithSecurityToken2]

Description

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).

Derived By

Type int

Referenced By

Element: Language4ContentId [type Language4Content]

Derived By

Type int

Referenced By

Element: Language4ContentId [type User]

Description

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.

Derived By

Type int

Referenced By

Element: Language4FullTextIndex [type ArrayOfLanguage4FullTextIndex]

Derived By

Type Language4FullTextIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CatalogLanguageId  int 
Language  Language 
Language4FullTextIndexId  int 
ts  base64Binary 
Referenced By

Element: Language4FullTextIndex

Derived By

Type Language4FullTextIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
CatalogLanguageId  int 
Language  Language 
Language4FullTextIndexId  int 
ts  base64Binary 

Element: Language4FullTextIndexId [type Language4FullTextIndex]

Derived By

Type int

Referenced By

Element: Language4Metadata [type ArrayOfLanguage4Metadata]

Derived By

Type Language4Metadata

Content Model

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 
Referenced By

Element: Language4Metadata

Derived By

Type Language4Metadata

Content Model

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: Language4MetadataId [type Language4Metadata]

Derived By

Type int

Referenced By

Element: Language4MetadataId [type LanguageFallback]

Derived By

Type int

Referenced By

Element: Language4UserInterface [type ArrayOfLanguage4UserInterface]

Derived By

Type Language4UserInterface

Content Model

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 
Referenced By

Element: Language4UserInterface

Derived By

Type Language4UserInterface

Content Model

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 

Element: Language4UserInterfaceId [type Language4UserInterface]

Derived By

Type int

Referenced By

Element: Language4Version [type ArrayOfLanguage4Version]

Derived By

Type Language4Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
IsFavorite  boolean 
Language  Language 
Language4VersionId  int 
LanguageId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Element: Language4Version

Derived By

Type Language4Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
IsFavorite  boolean 
Language  Language 
Language4VersionId  int 
LanguageId  int 
SortOrder  int 
ts  base64Binary 

Element: Language4VersionId [type Language4Version]

Derived By

Type int

Referenced By

Element: LanguageConfiguration

Derived By

Type LanguageConfiguration

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Languages4AssetContainers  ArrayOfLanguage4AssetContainer 
Languages4Contents  ArrayOfLanguage4Content 
Languages4FullTextIndexes  ArrayOfLanguage4FullTextIndex 
Languages4Metadata  ArrayOfLanguage4Metadata 
Languages4UserInterfaces  ArrayOfLanguage4UserInterface 
Languages4Version  ArrayOfLanguage4Version 

Element: LanguageFallback [type ArrayOfLanguageFallback]

Derived By

Type LanguageFallback

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FallbackLanguage  string 
FallbackLanguageId  int 
Language4MetadataId  int 
LanguageFallbackId  int 
SortOrder  int 
ts  base64Binary 
Referenced By

Element: LanguageFallback

Derived By

Type LanguageFallback

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FallbackLanguage  string 
FallbackLanguageId  int 
Language4MetadataId  int 
LanguageFallbackId  int 
SortOrder  int 
ts  base64Binary 

Element: LanguageFallbackId [type LanguageFallback]

Derived By

Type int

Referenced By

Element: LanguageFallbacks [type Language4Metadata]

Derived By

Type ArrayOfLanguageFallback

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LanguageFallback  LanguageFallback 
Referenced By

Element: LanguageId [type AssetContainerIndex]

Derived By

Type int

Referenced By

Element: LanguageId [type AssetContainerTranslation]

Description

The language id (1=german, 2=english, 3=french, 75=spanish, 140=italian, ..).

Derived By

Type int

Referenced By

Element: LanguageId [type AssetVersion]

Derived By

Type int

Referenced By

Element: LanguageId [type CountryTranslation]

Description

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.

Derived By

Type int

Referenced By

Element: LanguageId [type DerivativeDefinitionTranslation]

Derived By

Type int

Referenced By

Element: LanguageId [type FacetConfigurationTranslation]

Derived By

Type int

Referenced By

Element: LanguageId [type FieldOptionTranslation]

Derived By

Type int

Referenced By

Element: LanguageId [type FieldTranslation]

Derived By

Type int

Referenced By

Element: LanguageId [type FieldValue]

Derived By

Type int

Referenced By

Element: LanguageId [type KnownFieldValueString]

Derived By

Type int

Referenced By

Element: LanguageId [type Language]

Derived By

Type int

Referenced By

Element: LanguageId [type Language4AssetContainer]

Derived By

Type int

Referenced By

Element: LanguageId [type Language4Metadata]

Derived By

Type int

Referenced By

Element: LanguageId [type Language4UserInterface]

Derived By

Type int

Referenced By

Element: LanguageId [type Language4Version]

Derived By

Type int

Referenced By

Element: LanguageId [type UserData]

Derived By

Type int

Referenced By

Element: LanguageId [type UserGroupTranslation]

Derived By

Type int

Referenced By

Element: LanguageId [type UserShort]

Derived By

Type int

Referenced By

Element: Languages4AssetContainers [type LanguageConfiguration]

Derived By

Type ArrayOfLanguage4AssetContainer

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4AssetContainer  Language4AssetContainer 
Referenced By

Element: Languages4Contents [type LanguageConfiguration]

Derived By

Type ArrayOfLanguage4Content

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Content  Language4Content 
Referenced By

Element: Languages4FullTextIndexes [type LanguageConfiguration]

Derived By

Type ArrayOfLanguage4FullTextIndex

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4FullTextIndex  Language4FullTextIndex 
Referenced By

Element: Languages4Metadata [type LanguageConfiguration]

Derived By

Type ArrayOfLanguage4Metadata

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Metadata  Language4Metadata 
Referenced By

Element: Languages4UserInterfaces [type LanguageConfiguration]

Derived By

Type ArrayOfLanguage4UserInterface

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4UserInterface  Language4UserInterface 
Referenced By

Element: Languages4Version [type LanguageConfiguration]

Derived By

Type ArrayOfLanguage4Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Language4Version  Language4Version 
Referenced By

Element: LanguageTranslation [type Language]

Derived By

Type string

Referenced By

Element: LargePageImageMaxHeight [type Document]

Derived By

Type int

Referenced By

Element: LargePageImageMaxWidth [type Document]

Derived By

Type int

Referenced By

Element: LargePageImageResolution [type DocumentPage]

Derived By

Type double

Referenced By

Element: LargePageImageUrl [type DocumentPage]

Derived By

Type string

Referenced By

Element: LargerThanNumeric [type NumericBetweenOperation]

Derived By

Type float

Referenced By

Element: LargerThanNumeric [type NumericLargerThanOperation]

Derived By

Type float

Referenced By

Element: LargeThumbnailUrl [type PortAssetItem]

Derived By

Type string

Referenced By

Element: LastActiveFacetConfigurationId [type UserData]

Derived By

Type int

Referenced By

Element: LastActiveFacetConfigurationId [type UserShort]

Derived By

Type int

Referenced By

Element: LastLoginDate [type UserData]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: LastLoginDate [type UserShort]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: LastName [type UserCompact]

Derived By

Type string

Referenced By

Element: LastName [type UserData]

Derived By

Type string

Referenced By

Element: LastName [type UserShort]

Derived By

Type string

Referenced By

Element: LdapSecurityGroup [type ArrayOfLdapSecurityGroup]

Derived By

Type LdapSecurityGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SecurityGroupDistinguishedName  string 
UserGroup2LdapSecurityGroupId  int 
UserGroupId  int 
ts  base64Binary 
Referenced By

Element: LdapSecurityGroup

Derived By

Type LdapSecurityGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SecurityGroupDistinguishedName  string 
UserGroup2LdapSecurityGroupId  int 
UserGroupId  int 
ts  base64Binary 

Element: LdapSecurityGroups [type UserGroupItem]

Derived By

Type ArrayOfLdapSecurityGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LdapSecurityGroup  LdapSecurityGroup 
Referenced By

Element: leaf [type XmpItem]

Derived By

Type boolean

Referenced By

Element: limit [element GetAssetLinksById]

Description

Number of maximally returned itens.

Derived By

Type int

Referenced By

Element: limit [element GetUsers]

Description

Optional. The maximal number of rows returned. Default is unlimited.

Derived By

Type int

Referenced By

Element: Limit [type ExtendedAssetFilter]

Description

Optional. The maximal number of assets returned. Default is unlimited.

Derived By

Type int

Referenced By

Element: LinkedAssetId [type AssetObject]

Derived By

Type int

Referenced By

Element: LinkedGlobalUserId [type UserShort]

Derived By

Type int

Referenced By

Element: LinkedUrl [type AssetObject]

Derived By

Type string

Referenced By

Element: LinkToken [type BusinessProcessShort]

Derived By

Type string

Referenced By

Element: ListViewFieldGroupId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: ListViewFields [type PortAssetItem]

Derived By

Type ArrayOfKeyValueOfintPortViewField6jg_STziK

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintPortViewField6jg_STziK  anyType (restriction) 
Referenced By

Element: LockDate [type UserData]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: LockDate [type UserShort]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: LogicalOperation [type ArrayOfLogicalOperation]

Derived By

Type LogicalOperation

Content Model

Always empty.

Referenced By

Element: LogicalOperation

Derived By

Type LogicalOperation

Content Model

Always empty.

Element: LogicalOperations [type AndOperation]

Derived By

Type ArrayOfLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LogicalOperation  LogicalOperation 
Referenced By

Element: LogicalOperations [type AssetContainerAndOperation]

Derived By

Type ArrayOfAssetContainerLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerLogicalOperation  AssetContainerLogicalOperation 
Referenced By

Element: LogicalOperations [type AssetContainerOrOperation]

Derived By

Type ArrayOfAssetContainerLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerLogicalOperation  AssetContainerLogicalOperation 
Referenced By

Element: LogicalOperations [type OrOperation]

Derived By

Type ArrayOfLogicalOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LogicalOperation  LogicalOperation 
Referenced By

Element: Login

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.

Element: LoginOnlyWithClaimsIdentity [type UserData]

Derived By

Type boolean

Referenced By

Element: LoginOnlyWithClaimsIdentity [type UserShort]

Derived By

Type boolean

Referenced By

Element: LoginOnlyWithSecurityToken [type UserData]

Derived By

Type boolean

Referenced By

Element: LoginOnlyWithSecurityToken [type UserShort]

Derived By

Type boolean

Referenced By

Element: LoginResponse

Derived By

Restricting anyType

Content Model

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.

Element: LoginResult [element LoginResponse]

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: LoginStatus [type User]

Description

LoggedIn, NotLoggedIn or LoggedInAsGuest.

Derived By

Type LoginStatus

Enumeration
Value  Description 
NotLoggedIn 
LoggedInAsGuest 
LoggedIn 
Referenced By

Element: LoginStatus

Derived By

Type LoginStatus

Enumeration
Value  Description 
NotLoggedIn 
LoggedInAsGuest 
LoggedIn 

Element: LoginWithSecurityToken

Derived By

Restricting anyType

Content Model

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.

Element: LoginWithSecurityToken2

Derived By

Restricting anyType

Content Model

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).

Element: LoginWithSecurityToken2Response

Derived By

Restricting anyType

Content Model

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.

Element: LoginWithSecurityToken2Result [element LoginWithSecurityToken2Response]

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: LoginWithSecurityTokenResponse

Derived By

Restricting anyType

Content Model

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.

Element: LoginWithSecurityTokenResult [element LoginWithSecurityTokenResponse]

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: LogoutUrl [type FacetConfigurationViewItem]

Derived By

Type string

Referenced By

Element: long

Derived By

Type long

Element: MailingRecipientId [type DownloadOptions]

Description

Needed only for logging purposes.

Derived By

Type int

Referenced By

Element: MailingUrl [type BusinessProcessShort]

Derived By

Type anyURI

Referenced By

Element: MailingUrlForDownload [type BusinessProcessShort]

Derived By

Type anyURI

Referenced By

Element: MailingUrlsForDownload [type BusinessProcessShort]

Derived By

Type ArrayOfBusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessLink  BusinessProcessLink 
Referenced By

Element: MailingUrlsForView [type BusinessProcessShort]

Derived By

Type ArrayOfBusinessProcessLink

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BusinessProcessLink  BusinessProcessLink 
Referenced By

Element: MasterVersions [type AssetItem]

Description

See above under AssetVersions.

Derived By

Type ArrayOfAssetVersion

Content Model

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).

Referenced By

Element: MasterVersions [type AssetMetadata]

Description

An array with all master AssetVersions for this asset.

This array contains all assets which are a parent version for this asset.

Derived By

Type ArrayOfAssetVersion

Content Model

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).

Referenced By

Element: Max [type FacetValue]

Derived By

Type double

Referenced By

Element: MaxTextLength [type FieldControlInfos]

Description

Max count of chars.

Derived By

Type int

Referenced By

Element: MediaInfo [type ArrayOfMediaInfo]

Derived By

Type MediaInfo

Content Model

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 
Referenced By

Element: MediaInfo

Derived By

Type MediaInfo

Content Model

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: MediaInfos [type AssetMetadata]

Description

A list of MediaInfos if the asset is an audio or a video.

Derived By

Type ArrayOfMediaInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
MediaInfo  MediaInfo 
Referenced By

Element: MediaTypeCounts [type AssetItemCollection]

Description

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.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: MediaTypeIds [type ExtendedAssetFilter]

Description

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}
Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: MediumThumbnailUrl [type PortAssetItem]

Derived By

Type string

Referenced By

Element: Message [type PictureparkFault]

Derived By

Type string

Referenced By

Element: MetadataMapping [type Field]

Description

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.

Derived By

Type ArrayOfMetadataProperty

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
MetadataProperty  MetadataProperty 
Referenced By

Element: MetadataParentPropertyId [type MetadataProperty]

Derived By

Type int

Referenced By

Element: MetadataProperty [type ArrayOfMetadataProperty]

Derived By

Type MetadataProperty

Content Model

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 
Referenced By

Element: MetadataProperty

Derived By

Type MetadataProperty

Content Model

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: MetadataPropertyId [type MetadataProperty]

Derived By

Type int

Referenced By

Element: MetadataSchema [type MetadataProperty]

Derived By

Type MetadataSchema

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
MetadataSchemaId  int 
Schema  string 
ts  base64Binary 
Referenced By

Element: MetadataSchema

Derived By

Type MetadataSchema

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
MetadataSchemaId  int 
Schema  string 
ts  base64Binary 

Element: MetadataSchemaId [type MetadataProperty]

Derived By

Type int

Referenced By

Element: MetadataSchemaId [type MetadataSchema]

Derived By

Type int

Referenced By

Element: Min [type FacetValue]

Derived By

Type double

Referenced By

Element: Minutes [type DateTimeNowAfterOperation]

Derived By

Type int

Referenced By

Element: Minutes [type DateTimeNowAfterOrEqualOperation]

Derived By

Type int

Referenced By

Element: Minutes [type DateTimeNowBeforeOrEqualOperation]

Derived By

Type int

Referenced By

Element: Minutes [type DateTimeNowLastOperation]

Derived By

Type int

Referenced By

Element: Minutes [type DateTimeNowNextOperation]

Derived By

Type int

Referenced By

Element: Minutes [type DateTimeNowOlderOperation]

Derived By

Type int

Referenced By

Element: ModificationDate [type AssetContainerItem]

Description

The modification date.

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type AssetVersion]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type DerivativeLock]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type ExtendedDerivative]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type RightTemplate]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type RightTemplate2AssetType]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type RightTemplate2Right]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type RightTemplate2UserGroup]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type Skin]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type UserData]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModificationDate [type UserShort]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ModifiedByUserId [type AssetContainerItem]

Description

The id of the last user who edited the container.

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type AssetVersion]

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type DerivativeLock]

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type RightTemplate]

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type RightTemplate2AssetType]

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type RightTemplate2UserGroup]

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type Skin]

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type UserData]

Derived By

Type int

Referenced By

Element: ModifiedByUserId [type UserShort]

Derived By

Type int

Referenced By

Element: MoveAssetContainer

Derived By

Restricting anyType

Content Model

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.

Element: MoveAssetContainerResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: name [element CreateAssetLink]

Description

The name.

Derived By

Type string

Referenced By

Element: name [element GetFacetConfigurationExtended]

Description

The facet name.

Derived By

Type string

Referenced By

Element: Name [type AssetContainerTranslation]

Description

The asset container name in the language defined by LanguageId.

Derived By

Type string

Referenced By

Element: Name [type BusinessProcessShort]

Derived By

Type string

Referenced By

Element: Name [type Country]

Derived By

Type string

Referenced By

Element: Name [type DerivativeDefinition]

Derived By

Type string

Referenced By

Element: Name [type DerivativeDefinitionTranslation]

Derived By

Type string

Referenced By

Element: Name [type FacetConfigurationRange]

Derived By

Type string

Referenced By

Element: Name [type FacetConfigurationViewItem]

Derived By

Type string

Referenced By

Element: Name [type Field]

Description

The field name, e.g. AssetName, AssetDescription, FileSizeInBytes, CDF8 ..

Derived By

Type string

Referenced By

Element: Name [type RightTemplate]

Derived By

Type string

Referenced By

Element: Name [type Skin]

Derived By

Type string

Referenced By

Element: Name [type UserGroupTranslation]

Derived By

Type string

Referenced By

Element: Name [type XmpItem]

Derived By

Type string

Referenced By

Element: NamesOfMappedSitesWithSiteRightManage [type Skin]

Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Element: NeedsAllRights [type UserGroupItem]

Derived By

Type boolean

Referenced By

Element: NeedsAllUserRights [type UserGroupItem]

Derived By

Type boolean

Referenced By

Element: NewFlagDays [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: NotContainsString [type StringNotContainsOperation]

Derived By

Type string

Referenced By

Element: NotEqualNumeric [type NumericNotEqualOperation]

Derived By

Type float

Referenced By

Element: NotEqualString [type StringNotEqualOperation]

Derived By

Type string

Referenced By

Element: NumericBetweenOperation

Derived By

Type NumericBetweenOperation

Content Model

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: NumericEqualOperation

Derived By

Type NumericEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualNumeric  float 

Element: NumericLargerThanOperation

Derived By

Type NumericLargerThanOperation

Content Model

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: NumericListEqualOperation

Derived By

Type NumericListEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualNumericList  ArrayOffloat 

Element: NumericNotEqualOperation

Derived By

Type NumericNotEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotEqualNumeric  float 

Element: NumericSmallerThanOperation

Derived By

Type NumericSmallerThanOperation

Content Model

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: offset [element UploadChunk]

Description

The start index of the current chunk in the source/destination file.

Derived By

Type long

Referenced By

Element: OffsetMinutes [type DateTimeOffset]

Derived By

Type short

Referenced By

Element: onlyActive [element GetUsers]

Description

Get only active users.

Derived By

Type boolean

Referenced By

Element: OnlyCreateOriginalDerivative [type AssetImportOptions]

Description

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.

Derived By

Type boolean

Referenced By

Element: OnlyCreateOriginalDerivative [type AssetUpdateOptions]

Description

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.

Derived By

Type boolean

Referenced By

Element: onlyExpired [element GetUsers]

Description

Get only expired users.

Derived By

Type boolean

Referenced By

Element: onlyExpiredRenewals [element GetUsers]

Description

Get only users with expired renewals.

Derived By

Type boolean

Referenced By

Element: onlyLocked [element GetUsers]

Description

Get only locked users.

Derived By

Type boolean

Referenced By

Element: openAssetContainerId [element GetAssetContainers]

Description

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..)

Derived By

Type int

Referenced By

Element: Options [type Field]

Description

An array with all available options for this field.

Needed for ComboBox- and MultiCheckbox fields).

Derived By

Type ArrayOfFieldOption

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOption  FieldOption 
Referenced By

Element: OrderableDerivatives [type PortAssetItem]

Description

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.

Derived By

Type ArrayOfPortDerivative

Content Model

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.
Referenced By

Element: OriginalDerivative [type AssetMetadata]

Description

Original ExtendedDerivative.

The data for the original are always returned, even if there are no access rights to the original.

Derived By

Type ExtendedDerivative

Content Model

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 
CreationDate  DateTimeOffset 
Deleted  boolean 
EpsHeightInPoints  double 
EpsIsRasterized  boolean 
EpsWidthInPoints  double 
ImageBitsPerChannel  int 
ImageBitsPerPixel  int 
ImageChannels  string 
ImageColorProfile  string 
ImageColorSpaceId  int 
ImageHasAdobeResourceData  boolean 
ImageHasAlpha  boolean 
ImageHasExifData  boolean 
ImageHasIptcData  boolean 
ImageHasXmpData  boolean 
ImageHeightInCm  double 
ImageHeightInInch  double 
ImageHorizontalResolution  double 
ImageIsExtended  boolean 
ImageIsIndexed  boolean 
ImagePixelFormat  string 
ImageTotalFrames  int 
ImageTotalUnspecifiedTiffExtraChannels  int 
ImageUncompressedSizeInBytes  long 
ImageVerticalResolution  double 
ImageWidthInCm  double 
ImageWidthInInch  double 
ModificationDate  DateTimeOffset 
Sha1Hash  string 
Referenced By

Element: OriginalDerivativeModificationDate [type DerivativeLock]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: OrOperation

Derived By

Type OrOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
ComparisonOperations  ArrayOfComparisonOperation 
LogicalOperations  ArrayOfLogicalOperation 

Element: OutputFileExtensionId [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: OverallBitRate [type MediaInfo]

Derived By

Type int

Referenced By

Element: OverlayFieldId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: OverlayText [type PortAssetItem]

Derived By

Type string

Referenced By

Element: OverviewFieldGroupId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: OverviewFields [type PortAssetItem]

Derived By

Type ArrayOfKeyValueOfintPortViewField6jg_STziK

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintPortViewField6jg_STziK  anyType (restriction) 
Referenced By

Element: OverviewUiElementId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: OverviewUrl [type FacetConfigurationViewItem]

Derived By

Type string

Referenced By

Element: PageNumber [type DocumentPage]

Derived By

Type int

Referenced By

Element: ParentAsset [type AssetMetadata]

Description

An array with all parent AssetItems.

An asset can have more than one parent.

Derived By

Type ArrayOfAssetItem

Content Model

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.
Referenced By

Element: parentAssetContainerId [element CreateAssetContainer]

Description

The id of the asset container where the new container is created.

Derived By

Type int

Referenced By

Element: parentAssetContainerId [element GetAssetContainers]

Description

The id of the AssetContainer (category or asset class) for which the children are to be returned.

Derived By

Type int

Referenced By

Element: ParentAssetContainerId [type AssetContainerItem]

Description

The id of the parent asset containert, is null for containers on the highest level.

Derived By

Type int

Referenced By

Element: ParentAssetId [type AssetMetadata]

Description

The id of the parent asset.

Derived By

Type int

Referenced By

Element: ParentAssetId [type AssetVersion]

Description

The id of the parent asset. Null, if this version is a master.

Derived By

Type int

Referenced By

Element: password [element CreateUser]

Description

The password. Must have the minimum strength as defined for this customer.

Derived By

Type string

Referenced By

Element: Password [type User]

Description

The password must be submitted for Login, but is never returned.

Derived By

Type string

Referenced By

Element: Permissions [type AssetContainerItem]

Description

An array with the AssetContainerRights for the current user.

Derived By

Type ArrayOfAssetContainerRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRight  AssetContainerRight 
Referenced By

Element: PersonalItemRight [type ArrayOfPersonalItemRight]

Derived By

Type PersonalItemRight

Enumeration
Value  Description 
View 
Edit 
Referenced By

Element: PersonalItemRight

Derived By

Type PersonalItemRight

Enumeration
Value  Description 
View 
Edit 

Element: PersonalItemRights [type Rights]

Derived By

Type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfPersonalItemRightuUS27HWe  anyType (restriction) 
Referenced By

Element: Phone [type UserData]

Derived By

Type string

Referenced By

Element: Phone [type UserShort]

Derived By

Type string

Referenced By

Element: PictureparkErrorType

Derived By

Type PictureparkErrorType

Enumeration
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: PictureparkFault

Derived By

Type PictureparkFault

Content Model

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: PictureparkVersion [type PublicConfiguration]

Derived By

Type Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
_Build  int 
_Major  int 
_Minor  int 
_Revision  int 
Referenced By

Element: PortAssetItem [type ArrayOfPortAssetItem]

Derived By

Type PortAssetItem

Content Model

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).
Referenced By

Element: PortAssetItem

Derived By

Type PortAssetItem

Content Model

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: PortAssetItemCollection

Derived By

Type PortAssetItemCollection

Content Model

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: PortDerivative [type ArrayOfPortDerivative]

Derived By

Type PortDerivative

Content Model

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 
Referenced By

Element: PortDerivative

Derived By

Type PortDerivative

Content Model

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: portName [element GetAssets2]

Derived By

Type string

Referenced By

Element: PortViewField

Derived By

Type PortViewField

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
IsFullWidth  boolean 
Position  int 
Values  ArrayOfstring 

Element: Position [type PortViewField]

Derived By

Type int

Referenced By

Element: PositionLeftInCm [type AssetObject]

Derived By

Type double

Referenced By

Element: PositionTopInCm [type AssetObject]

Derived By

Type double

Referenced By

Element: PropertyName [type MetadataProperty]

Derived By

Type string

Referenced By

Element: ProvideAsDownload [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: ProvidedSearchFilter [type FacetResults]

Description

Holds the asset filter that has been provided for searching

Derived By

Type ExtendedAssetFilter

Content Model

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:
.
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 ..
}

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:
.
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 ..
}

SimpleSearchString  string 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

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>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });

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 }
Referenced By

Element: provideUniqueFileName [element DownloadExtended]

Description

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.

Derived By

Type boolean

Referenced By

Element: PublicAbsoluteUrl [type Derivative]

Description

E.g. http://picturepark.vit.local/Public/1/ThumbnailSmall/1031.jpg.

Derived By

Type string

Referenced By

Element: PublicConfiguration

Derived By

Type PublicConfiguration

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Countries  ArrayOfCountry 
DerivativeDefinitions  ArrayOfDerivativeDefinition 
PictureparkVersion  Version 

Element: QName

Derived By

Type QName

Element: Range [type FacetValue]

Derived By

Type string

Referenced By

Element: RangeConfiguration [type FacetValue]

Derived By

Type FacetConfigurationRange

Content Model

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)
Referenced By

Element: Ranges [type FacetConfigurationElement]

Derived By

Type ArrayOfFacetConfigurationRange

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationRange  FacetConfigurationRange 
Referenced By

Element: ReferencedAssets [type AssetMetadata]

Description

An array with all AssetItems to which this asset refers (from Documents).

Derived By

Type ArrayOfAssetItem

Content Model

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.
Referenced By

Element: ReferringAssets [type AssetMetadata]

Description

An array with all AssetItems which refer to this asset (from AssetObjects).

Derived By

Type ArrayOfAssetItem

Content Model

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.
Referenced By

Element: registrationState [element GetUsers]

Description

Optional. The RegistrationState, if you wish to get only users with a certain regristration state.

Derived By

Type RegistrationState

Enumeration
Value  Description 
Waiting4EmailAuthentication 
Waiting4ConfirmationByAdmin 
Waiting4ConfirmationByContact 
RejectedByAdmin 
RejectedByContact 
Referenced By

Element: RegistrationState [type UserData]

Derived By

Type RegistrationState

Enumeration
Value  Description 
Waiting4EmailAuthentication 
Waiting4ConfirmationByAdmin 
Waiting4ConfirmationByContact 
RejectedByAdmin 
RejectedByContact 
Referenced By

Element: RegistrationState

Derived By

Type RegistrationState

Enumeration
Value  Description 
Waiting4EmailAuthentication 
Waiting4ConfirmationByAdmin 
Waiting4ConfirmationByContact 
RejectedByAdmin 
RejectedByContact 

Element: RegistrationStateId [type UserShort]

Derived By

Type RegistrationState

Enumeration
Value  Description 
Waiting4EmailAuthentication 
Waiting4ConfirmationByAdmin 
Waiting4ConfirmationByContact 
RejectedByAdmin 
RejectedByContact 
Referenced By

Element: RelativeBasePath [type DerivativeDefinition]

Derived By

Type string

Referenced By

Element: RelativeFilePath [type AssetObject]

Derived By

Type string

Referenced By

Element: RemainingHits [type FacetResult]

Derived By

Type int

Referenced By

Element: RemainingTerms [type FacetResult]

Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Element: RemainingTermsCount [type FacetResult]

Derived By

Type int

Referenced By

Element: RemoveAssetContainer

Derived By

Restricting anyType

Content Model

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!

Element: RemoveAssetContainerResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: RemoveAssets

Derived By

Restricting anyType

Content Model

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).

Element: RemoveAssetsFromAssetContainers

Derived By

Restricting anyType

Content Model

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.

Element: RemoveAssetsFromAssetContainersResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: RemoveAssetsResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: RemoveAssetVersions

Derived By

Restricting anyType

Content Model

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.

Element: RemoveAssetVersionsResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: RemoveUsers

Derived By

Restricting anyType

Content Model

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.

Element: RemoveUsersResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: RenderingActionArgumentId [type RenderingActionArgumentValue]

Derived By

Type int

Referenced By

Element: RenderingActionArgumentValue [type ArrayOfRenderingActionArgumentValue]

Derived By

Type RenderingActionArgumentValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionArgumentId  int 
RenderingActionArgumentValueId  int 
RenderingActionValueId  int 
Value  string 
ts  base64Binary 
Referenced By

Element: RenderingActionArgumentValue

Derived By

Type RenderingActionArgumentValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionArgumentId  int 
RenderingActionArgumentValueId  int 
RenderingActionValueId  int 
Value  string 
ts  base64Binary 

Element: RenderingActionArgumentValueId [type RenderingActionArgumentValue]

Derived By

Type int

Referenced By

Element: RenderingActionArgumentValues [type RenderingActionValue]

Derived By

Type ArrayOfRenderingActionArgumentValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionArgumentValue  RenderingActionArgumentValue 
Referenced By

Element: RenderingActionId [type RenderingActionValue]

Derived By

Type int

Referenced By

Element: RenderingActionValue [type ArrayOfRenderingActionValue]

Derived By

Type RenderingActionValue

Content Model

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 
Referenced By

Element: RenderingActionValue

Derived By

Type RenderingActionValue

Content Model

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 

Element: RenderingActionValueId [type RenderingActionArgumentValue]

Derived By

Type int

Referenced By

Element: RenderingActionValueId [type RenderingActionValue]

Derived By

Type int

Referenced By

Element: RenderingActionValues [type DerivativeDefinition]

Derived By

Type ArrayOfRenderingActionValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RenderingActionValue  RenderingActionValue 
Referenced By

Element: renderingClient [element CreateRenderingJob]

Description

The RenderingClient.

Derived By

Type RenderingClient

Enumeration
Value  Description 
Import 
Update 
Repair 
Editor 
Referenced By

Element: RenderingClient

Derived By

Type RenderingClient

Enumeration
Value  Description 
Import 
Update 
Repair 
Editor 

Element: renderingJobId [element ImportSingleAsset]

Description

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.

Derived By

Type int

Referenced By

Element: renderingJobId [element SaveDerivative]

Description

The rendering job id.

Call CreateRenderingJob to get a renderingJobId. This allows several updates to be pooled to one job.

Derived By

Type int

Referenced By

Element: renderingJobId [element UpdateOriginalDerivative]

Description

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.

Derived By

Type int

Referenced By

Element: RenderingState [type Derivative]

Description

Technical flag concerning the rendering state.

Derived By

Type RenderingState

Enumeration
Value  Description 
Pending 
Completed 
Failed 
Referenced By

Element: RenderingState

Derived By

Type RenderingState

Enumeration
Value  Description 
Pending 
Completed 
Failed 

Element: renewalState [element GetUsers]

Description

Optional. The RenewalState, if you wish to get only users with a certain renewal state.

Derived By

Type RenewalState

Enumeration
Value  Description 
Waiting4RenewalByAdmin 
Waiting4RenewalByContact 
RejectedByAdmin 
RejectedByContact 
Referenced By

Element: RenewalState [type UserData]

Derived By

Type RenewalState

Enumeration
Value  Description 
Waiting4RenewalByAdmin 
Waiting4RenewalByContact 
RejectedByAdmin 
RejectedByContact 
Referenced By

Element: RenewalState

Derived By

Type RenewalState

Enumeration
Value  Description 
Waiting4RenewalByAdmin 
Waiting4RenewalByContact 
RejectedByAdmin 
RejectedByContact 

Element: RenewalStateId [type UserShort]

Derived By

Type RenewalState

Enumeration
Value  Description 
Waiting4RenewalByAdmin 
Waiting4RenewalByContact 
RejectedByAdmin 
RejectedByContact 
Referenced By

Element: RenewalUntilDate [type UserData]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: RenewalUntilDate [type UserShort]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: RenewSession

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
coreInfo  CoreInfo  The CoreInfo object which has been returned by CreateSession.

Element: RenewSessionResponse

Derived By

Restricting anyType

Content Model

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.

Element: RenewSessionResult [element RenewSessionResponse]

Derived By

Type CoreInfo

Content Model

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.
Referenced By

Element: ReplaceDelimiters [type Field]

Description

If true, field value will be splitted and formated by its special characters. The results will be added to the full text search index.

Derived By

Type boolean

Referenced By

Element: Results [type FacetResults]

Description

A result per field (facet)

Derived By

Type ArrayOfFacetResult

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetResult  FacetResult 
Referenced By

Element: ReturnAllLanguages [type AssetFilter]

Description

Optional. If set to true, all languages of passed fields will be returned. Otherwise only desiredMetadataLanguage.

Derived By

Type boolean

Referenced By

Element: ReturnAllQueryAssetIds [type AssetFilter]

Description

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.

Derived By

Type boolean

Referenced By

Element: ReturnMediaTypeCounts [type ExtendedAssetFilter]

Description

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

Derived By

Type boolean

Referenced By

Element: Rights

Derived By

Type Rights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe 
FieldRights  ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe 
HasPPMCRights  boolean 
PersonalItemRights  ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe 
RightTemplates  ArrayOfRightTemplate 
SiteRights  ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe 
UserGroupRights  ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe 
UserRights  ArrayOfUserRight 
WidgetRights  ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe 

Element: RightTemplate [type ArrayOfRightTemplate]

Derived By

Type RightTemplate

Content Model

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 
Referenced By

Element: RightTemplate

Derived By

Type RightTemplate

Content Model

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: RightTemplate2AssetType [type ArrayOfRightTemplate2AssetType]

Derived By

Type RightTemplate2AssetType

Content Model

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 
Referenced By

Element: RightTemplate2AssetType

Derived By

Type RightTemplate2AssetType

Content Model

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 

Element: RightTemplate2AssetTypeId [type RightTemplate2AssetType]

Derived By

Type int

Referenced By

Element: RightTemplate2Right [type ArrayOfRightTemplate2Right]

Derived By

Type RightTemplate2Right

Content Model

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 
Referenced By

Element: RightTemplate2Right

Derived By

Type RightTemplate2Right

Content Model

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 

Element: RightTemplate2RightId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: RightTemplate2UserGroup [type ArrayOfRightTemplate2UserGroup]

Derived By

Type RightTemplate2UserGroup

Content Model

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 
Referenced By

Element: RightTemplate2UserGroup

Derived By

Type RightTemplate2UserGroup

Content Model

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 

Element: RightTemplate2UserGroupId [type RightTemplate2UserGroup]

Derived By

Type int

Referenced By

Element: rightTemplateId [element SaveAssetContainerRights]

Description

The id of a right template.

Derived By

Type int

Referenced By

Element: rightTemplateId [element SaveAssetsRights]

Description

The id of the right template.

Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true).

Derived By

Type int

Referenced By

Element: rightTemplateId [element SaveDerivativeRights]

Description

The id of the right template.

Must be submitted even when not applied (isDerivativeRightTemplateOverridden = true).

Derived By

Type int

Referenced By

Element: RightTemplateId [type RightTemplate]

Derived By

Type int

Referenced By

Element: RightTemplateId [type RightTemplate2AssetType]

Derived By

Type int

Referenced By

Element: RightTemplateId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: RightTemplateId [type RightTemplate2UserGroup]

Derived By

Type int

Referenced By

Element: RightTemplateRight [type RightTemplate2UserGroup]

Derived By

Type RightTemplateRight

Enumeration
Value  Description 
View 
Edit 
Apply 
Referenced By

Element: RightTemplateRight

Derived By

Type RightTemplateRight

Enumeration
Value  Description 
View 
Edit 
Apply 

Element: RightTemplates [type Rights]

Derived By

Type ArrayOfRightTemplate

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate  RightTemplate 
Referenced By

Element: RightTemplates2AssetTypes [type RightTemplate]

Derived By

Type ArrayOfRightTemplate2AssetType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2AssetType  RightTemplate2AssetType 
Referenced By

Element: RightTemplates2Rights [type RightTemplate]

Derived By

Type ArrayOfRightTemplate2Right

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2Right  RightTemplate2Right 
Referenced By

Element: RightTemplates2UserGroups [type RightTemplate]

Derived By

Type ArrayOfRightTemplate2UserGroup

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
RightTemplate2UserGroup  RightTemplate2UserGroup 
Referenced By

Element: RightTemplateType [type RightTemplate]

Derived By

Type RightTemplateType

Enumeration
Value  Description 
AssetContainer 
Asset 
DerivativeDefinition 
Referenced By

Element: RightTemplateType

Derived By

Type RightTemplateType

Enumeration
Value  Description 
AssetContainer 
Asset 
DerivativeDefinition 

Element: RootSiteUrl [type UserShort]

Derived By

Type string

Referenced By

Element: RotationInDegrees [type DocumentPage]

Derived By

Type int

Referenced By

Element: SaveAssetContainerRights

Derived By

Restricting anyType

Content Model

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 )

Element: SaveAssetContainerRightsResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: SaveAssetsRights

Derived By

Restricting anyType

Content Model

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>

Element: SaveAssetsRightsResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: SaveDerivative

Derived By

Restricting anyType

Content Model

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.

Element: SaveDerivativeResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: SaveDerivativeRights

Derived By

Restricting anyType

Content Model

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.

Element: SaveDerivativeRightsResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: Schema [type MetadataSchema]

Derived By

Type string

Referenced By

Element: SearchDesiredMetadataLanguageOnly [type ExtendedAssetFilter]

Description

Optional. If true, a search is done only within language specific metadata. Default: false.

Derived By

Type boolean

Referenced By

Element: SearchFilter [type FacetSearchParameter]

Derived By

Type ExtendedAssetFilter

Content Model

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:
.
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 ..
}

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:
.
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 ..
}

SimpleSearchString  string 

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

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>();
sortInfos.Add(new SortInfo() { SortField = "AssetName", SortDirection = SortDirection.Asc });
sortInfos.Add(new SortInfo() { SortField = "AssetId", SortDirection = SortDirection.Desc });

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 }
Referenced By

Element: SearchOnlyDeletedAssets [type ExtendedAssetFilter]

Description

Optional.

Derived By

Type boolean

Referenced By

Element: SearchOperation [type ExtendedAssetFilter]

Description

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 ..
}

Derived By

Type LogicalOperation

Content Model

Always empty.

Referenced By

Element: searchParameters [element GetFacets]

Description

A list of FacetSearchParameter.

Derived By

Type ArrayOfFacetSearchParameter

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetSearchParameter  FacetSearchParameter 
Referenced By

Element: searchString [element GetAssetContainers]

Description

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.

Derived By

Type string

Referenced By

Element: searchString [element GetUsers]

Description

Optional. A search string, e.g. "berg". Leave empty, if you wish to get all users.

Derived By

Type string

Referenced By

Element: SecurityGroupDistinguishedName [type LdapSecurityGroup]

Derived By

Type string

Referenced By

Element: securityToken [element LoginWithSecurityToken]

Description

The security token, which has been returned by GetSecurityToken.

Derived By

Type string

Referenced By

Element: securityToken [element LoginWithSecurityToken2]

Description

The security token, which has been returned by GetSecurityToken.

Derived By

Type string

Referenced By

Element: SelectedAssets [type BusinessProcessShort]

Derived By

Type ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 
Referenced By

Element: selectedFacetValues [element GetFacets]

Description

A list of FacetValue, can be null.

Derived By

Type ArrayOfFacetValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetValue  FacetValue 
Referenced By

Element: SelectionBehavior [type FacetConfigurationElement]

Derived By

Type FacetInnerSelectionBehavior

Enumeration
Value  Description 
Or 
And 
ExclusiveOr 
Referenced By

Element: SelectionBehavior [type FacetResult]

Derived By

Type FacetInnerSelectionBehavior

Enumeration
Value  Description 
Or 
And 
ExclusiveOr 
Referenced By

Element: SessionId [type CoreInfo]

Description

A guid, e.g. "02191bb8-0a67-4933-85e7-ab416fe74e95", needed to keep track of a session.

Derived By

Type string

Referenced By

Element: Sha1Hash [type ExtendedDerivative]

Derived By

Type string

Referenced By

Element: ShareListViewFieldGroupId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: ShareOverviewFieldGroupId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: short

Derived By

Type short

Element: ShortName [type DerivativeDefinitionTranslation]

Derived By

Type string

Referenced By

Element: SimpleSearchString [type ExtendedAssetFilter]

Description

Optional. Use simple search, if you wish to search within all fields for a simple string.


ExtendedAssetFilter extendedAssetFilter = new ExtendedAssetFilter()
{
.  SimpleSearchString = "Switzerland",
.
.  other parameters
};

Derived By

Type string

Referenced By

Element: SiteId [type UserData]

Derived By

Type int

Referenced By

Element: SiteRight [type ArrayOfSiteRight]

Derived By

Type SiteRight

Enumeration
Value  Description 
List 
Manage 
Referenced By

Element: SiteRight

Derived By

Type SiteRight

Enumeration
Value  Description 
List 
Manage 

Element: SiteRights [type Rights]

Derived By

Type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfSiteRightuUS27HWe  anyType (restriction) 
Referenced By

Element: skin [element CreateSession]

Description

Optional. Available options: "SkinColor.Blue" and "SkinColor.Gray".

SkinColor? skin = SkinColor.Blue;
Derived By

Type SkinColor

Enumeration
Value  Description 
Gray 
Blue 
White 
Referenced By

Element: Skin [type FacetConfigurationViewItem]

Derived By

Type Skin

Content Model

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 
Referenced By

Element: Skin [type User]

Description

Available options:Gray=0, Blue=1, White=2.

Derived By

Type SkinColor

Enumeration
Value  Description 
Gray 
Blue 
White 
Referenced By

Element: Skin

Derived By

Type Skin

Content Model

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: SkinColor

Derived By

Type SkinColor

Enumeration
Value  Description 
Gray 
Blue 
White 

Element: SkinId [type FacetConfigurationViewItem]

Derived By

Type int

Referenced By

Element: SkinId [type Skin]

Derived By

Type int

Referenced By

Element: SmallerThanNumeric [type NumericBetweenOperation]

Derived By

Type float

Referenced By

Element: SmallerThanNumeric [type NumericSmallerThanOperation]

Derived By

Type float

Referenced By

Element: SmallPageImageMaxHeight [type Document]

Derived By

Type int

Referenced By

Element: SmallPageImageMaxWidth [type Document]

Derived By

Type int

Referenced By

Element: SmallPageImageResolution [type DocumentPage]

Derived By

Type double

Referenced By

Element: SmallPageImageUrl [type DocumentPage]

Derived By

Type string

Referenced By

Element: SmallThumbnailUrl [type PortAssetItem]

Derived By

Type string

Referenced By

Element: SortChildrenAlphabetically [type AssetContainerItem]

Description

Flag: sort child nodes alphabetically.

If true, child nodes are sorted alphabetically and sort order numbering is ignored.

Derived By

Type boolean

Referenced By

Element: sortDirection [element GetUsers]

Description

Optional. The SortDirection (ascending or descending), default is ascending.

Derived By

Type SortDirection

Enumeration
Value  Description 
Asc 
Desc 
Referenced By

Element: SortDirection [type SortInfo]

Derived By

Type SortDirection

Enumeration
Value  Description 
Asc 
Desc 
Referenced By

Element: SortDirection

Derived By

Type SortDirection

Enumeration
Value  Description 
Asc 
Desc 

Element: sortField [element GetUsers]

Description

Optional. A sortfield, e.g. "EmailAddress".

Derived By

Type string

Referenced By

Element: SortField [type SortInfo]

Derived By

Type string

Referenced By

Element: SortInfo [type ArrayOfSortInfo]

Derived By

Type SortInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SortDirection  SortDirection 
SortField  string 
Referenced By

Element: SortInfo

Derived By

Type SortInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SortDirection  SortDirection 
SortField  string 

Element: SortInfos [type ExtendedAssetFilter]

Description

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 });

Derived By

Type ArrayOfSortInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SortInfo  SortInfo 
Referenced By

Element: SortOrder [type AssetContainerItem]

Description

The relative sort order of siblings.

Derived By

Type int

Referenced By

Element: SortOrder [type AssetObject]

Derived By

Type int

Referenced By

Element: SortOrder [type AssetVersion]

Derived By

Type int

Referenced By

Element: SortOrder [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: SortOrder [type FacetConfigurationElement]

Derived By

Type int

Referenced By

Element: SortOrder [type FacetConfigurationGroup]

Derived By

Type int

Referenced By

Element: SortOrder [type FacetConfigurationRange]

Derived By

Type int

Referenced By

Element: SortOrder [type FacetResult]

Derived By

Type int

Referenced By

Element: SortOrder [type FacetValue]

Derived By

Type int

Referenced By

Element: SortOrder [type FieldOption]

Derived By

Type int

Referenced By

Element: SortOrder [type Language4Metadata]

Derived By

Type int

Referenced By

Element: SortOrder [type Language4UserInterface]

Derived By

Type int

Referenced By

Element: SortOrder [type Language4Version]

Derived By

Type int

Referenced By

Element: SortOrder [type LanguageFallback]

Derived By

Type int

Referenced By

Element: SortOrder [type RenderingActionValue]

Derived By

Type int

Referenced By

Element: SortOrder [type RightTemplate]

Derived By

Type int

Referenced By

Element: Source [type FieldValue]

Derived By

Type FieldValueSource

Enumeration
Value  Description 
FieldValues 
Assets 
Derivatives 
VideoStreams 
AudioStreams 
AssetClass 
XmpMetadata 
Referenced By

Element: sourceAssetContainerId [element MoveAssetContainer]

Description

The id of the source asset container.

Derived By

Type int

Referenced By

Element: start [element GetUsers]

Description

Optional. The row in the query, from where on to return the users. Default is 0.

Derived By

Type int

Referenced By

Element: startRow [element GetAssetLinksById]

Description

Start row.

Derived By

Type int

Referenced By

Element: StartRow [type ExtendedAssetFilter]

Description

Optional. The row in the query, from where on to return the assets. Default is 0.

Derived By

Type int

Referenced By

Element: StartsWithString [type StringStartsWithOperation]

Derived By

Type string

Referenced By

Element: stream [element UploadFile]

Description

A file stream

Derived By

Type StreamBody

Referenced By

Element: string [type ArrayOfstring]

Derived By

Type string

Referenced By

Element: string

Derived By

Type string

Element: StringContainsOperation

Derived By

Type StringContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
ContainsString  string 

Element: StringEmptyOperation

Derived By

Type StringEmptyOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 

Element: StringEqualOperation

Derived By

Type StringEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualString  string 

Element: StringListContainsExactOperation

Derived By

Type StringListContainsExactOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
ContainsExactStringList  ArrayOfstring 

Element: StringListContainsOperation

Derived By

Type StringListContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
ContainsStringList  ArrayOfstring 

Element: StringListEqualOperation

Derived By

Type StringListEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
EqualStringList  ArrayOfstring 

Element: StringNotContainsOperation

Derived By

Type StringNotContainsOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotContainsString  string 

Element: StringNotEmptyOperation

Derived By

Type StringNotEmptyOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 

Element: StringNotEqualOperation

Derived By

Type StringNotEqualOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
NotEqualString  string 

Element: StringStartsWithOperation

Derived By

Type StringStartsWithOperation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldName  string 
StartsWithString  string 

Element: StringValue [type KnownFieldValue]

Derived By

Type string

Referenced By

Element: SubAssetContainers [type AssetContainerItem]

Description

The number of child nodes (children only, not grand children etc).

Derived By

Type int

Referenced By

Element: subscriptionActionId [element ConfirmSubscriptionInfoReceived]

Description

The id of the subscription action.

Derived By

Type int

Referenced By

Element: subscriptionActionId [element GetSubscriptionInfo]

Description

The id of the subscription action.

Derived By

Type int

Referenced By

Element: substituteUserId [element RemoveUsers]

Description

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.

Derived By

Type int

Referenced By

Element: SubTitle [type PortAssetItem]

Description

The asset's sub title in more detailed views.

Derived By

Type string

Referenced By

Element: SuggestionSource

Derived By

Type SuggestionSource

Enumeration
Value  Description 
Default 
Tokenized 
None 

Element: SuggestionSourceId [type FacetConfigurationViewItem]

Derived By

Type SuggestionSource

Enumeration
Value  Description 
Default 
Tokenized 
None 
Referenced By

Element: Sum [type FacetValue]

Derived By

Type double

Referenced By

Element: TagBoxShowFullPath [type FieldControlInfos]

Description

Should the TagBox show the full path or only the Tag (AssetContainerName).

Derived By

Type boolean

Referenced By

Element: TemporaryFileHandling [type AssetUpdateOptions]

Description

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Derived By

Type TemporaryFileHandling

Enumeration
Value  Description 
KeepTemporaryFile 
DeleteTemporaryFile 
DeleteTemporaryFileAndContainingFolder 
Referenced By

Element: TemporaryFileHandling [type DerivativeUpdateOptions]

Description

Optional. How to handle the temporary files.

Available options: DeleteTemporaryFile, DeleteTemporaryFileAndContainingFolder and KeepTemporaryFile.


TemporaryFileHandling = TemporaryFileHandling.DeleteTemporaryFile

Derived By

Type TemporaryFileHandling

Enumeration
Value  Description 
KeepTemporaryFile 
DeleteTemporaryFile 
DeleteTemporaryFileAndContainingFolder 
Referenced By

Element: TemporaryFileHandling

Derived By

Type TemporaryFileHandling

Enumeration
Value  Description 
KeepTemporaryFile 
DeleteTemporaryFile 
DeleteTemporaryFileAndContainingFolder 

Element: TermsAndConditions [type FacetConfigurationViewItem]

Derived By

Type string

Referenced By

Element: Title [type FacetConfigurationViewItem]

Derived By

Type string

Referenced By

Element: Title [type PortAssetItem]

Description

The asset's title which is used all over the new port (in most cases it'll be the field AssetName).

Derived By

Type string

Referenced By

Element: To [type FacetDateRange]

Derived By

Type string

Referenced By

Element: ToNumeric [type FacetConfigurationRange]

Derived By

Type float

Referenced By

Element: ToolTip [type FieldTranslation]

Derived By

Type string

Referenced By

Element: TotalAssets [type AssetContainerTotalAssets]

Derived By

Type int

Referenced By

Element: TotalAssets [type AssetItemCollection]

Description

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.

Derived By

Type int

Referenced By

Element: TotalAssets [type PortAssetItemCollection]

Description

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.

Derived By

Type int

Referenced By

Element: TotalCountOfSiteMappings [type Skin]

Derived By

Type int

Referenced By

Element: totalLayers [element GetAssetContainers]

Description

Number of layers (children, grand-children ..) to be returned. 1 = only the parentAssetContainerId is returned, 0 = all.

Derived By

Type int

Referenced By

Element: TotalTextAreaRows [type FieldControlInfos]

Description

The numbers of rows of a textarea.

Derived By

Type int

Referenced By

Element: TotalUserActionHistoryInfos [type UserActionHistoryInfoCollection]

Derived By

Type int

Referenced By

Element: TotalUsers [type UserCollection]

Description

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.

Derived By

Type int

Referenced By

Element: traceJobId [element CreateSession]

Description

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.

Derived By

Type int

Referenced By

Element: traceJobId [element GetSecurityToken]

Description

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.

Derived By

Type int

Referenced By

Element: TraceJobId [type CoreInfo]

Description

Can be submitted if all generated traces within the current context should be pooled for special reporting capabilities.".

Needed for tracing purposes only.

Derived By

Type int

Referenced By

Element: traceJobType [element CreateTraceJob]

Description

The TraceJobType.

Derived By

Type TraceJobType

Enumeration
Value  Description 
AssetImport 
AssetRepair 
SubscriptionDispatch 
AggregateTraffic 
AggregateDiskspace 
Workflow 
PAS 
ContentImport 
Referenced By

Element: TraceJobType

Derived By

Type TraceJobType

Enumeration
Value  Description 
AssetImport 
AssetRepair 
SubscriptionDispatch 
AggregateTraffic 
AggregateDiskspace 
Workflow 
PAS 
ContentImport 

Element: TraceUsagePurpose [type PortDerivative]

Derived By

Type boolean

Referenced By

Element: TrackUsagePurpose [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: transferGuid [element UploadChunk]

Description

The guid which has been returned by UploadFirstChunk

Derived By

Type guid

Restrictions
Referenced By

Element: Translation [type Field]

Description

The field data in the language of the current user.

Translation.Caption contains the field name in this language.

Derived By

Type FieldTranslation

Content Model

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 
Referenced By

Element: Translations [type AssetContainerAssignmentExtended]

Derived By

Type ArrayOfAssetContainerTranslation

Content Model

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.
Referenced By

Element: Translations [type AssetContainerItem]

Description

An array with the AssetContainerTranslations (names and descriptions) for each asset container language.

Derived By

Type ArrayOfAssetContainerTranslation

Content Model

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.
Referenced By

Element: Translations [type DerivativeDefinition]

Derived By

Type ArrayOfDerivativeDefinitionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionTranslation  DerivativeDefinitionTranslation 
Referenced By

Element: Translations [type FacetConfigurationGroup]

Description

Used for configuration (read / save)

Derived By

Type ArrayOfFacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationTranslation  FacetConfigurationTranslation 
Referenced By

Element: Translations [type FacetConfigurationRange]

Description

Used for configuration (read / save)

Derived By

Type ArrayOfFacetConfigurationTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetConfigurationTranslation  FacetConfigurationTranslation 
Referenced By

Element: Translations [type Field]

Description

Currently not used.

Derived By

Type ArrayOfFieldTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldTranslation  FieldTranslation 
Referenced By

Element: Translations [type FieldOption]

Derived By

Type ArrayOfFieldOptionTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldOptionTranslation  FieldOptionTranslation 
Referenced By

Element: Translations [type UserGroupItem]

Derived By

Type ArrayOfUserGroupTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupTranslation  UserGroupTranslation 
Referenced By

Element: ts [type AssetContainerIndex]

Derived By

Type base64Binary

Referenced By

Element: ts [type AssetContainerItem]

Derived By

Type base64Binary

Referenced By

Element: ts [type AssetContainerTranslation]

Derived By

Type base64Binary

Referenced By

Element: ts [type AssetObject]

Derived By

Type base64Binary

Referenced By

Element: ts [type AssetVersion]

Derived By

Type base64Binary

Referenced By

Element: ts [type BusinessProcessShort]

Derived By

Type base64Binary

Referenced By

Element: ts [type Derivative]

Derived By

Type base64Binary

Referenced By

Element: ts [type DerivativeDefinition]

Derived By

Type base64Binary

Referenced By

Element: ts [type DerivativeDefinition2AssetType]

Derived By

Type base64Binary

Referenced By

Element: ts [type DerivativeDefinitionTranslation]

Derived By

Type base64Binary

Referenced By

Element: ts [type DerivativeLock]

Derived By

Type base64Binary

Referenced By

Element: ts [type Document]

Derived By

Type base64Binary

Referenced By

Element: ts [type DocumentPage]

Derived By

Type base64Binary

Referenced By

Element: ts [type Field]

Description

Time stamp.

Derived By

Type base64Binary

Referenced By

Element: ts [type FieldControlInfos]

Description

Time stamp.

Derived By

Type base64Binary

Referenced By

Element: ts [type FieldOption]

Derived By

Type base64Binary

Referenced By

Element: ts [type FieldOptionTranslation]

Derived By

Type base64Binary

Referenced By

Element: ts [type FieldTranslation]

Derived By

Type base64Binary

Referenced By

Element: ts [type FieldValue]

Derived By

Type base64Binary

Referenced By

Element: ts [type Language]

Derived By

Type base64Binary

Referenced By

Element: ts [type Language4AssetContainer]

Derived By

Type base64Binary

Referenced By

Element: ts [type Language4Content]

Derived By

Type base64Binary

Referenced By

Element: ts [type Language4FullTextIndex]

Derived By

Type base64Binary

Referenced By

Element: ts [type Language4Metadata]

Derived By

Type base64Binary

Referenced By

Element: ts [type Language4UserInterface]

Derived By

Type base64Binary

Referenced By

Element: ts [type Language4Version]

Derived By

Type base64Binary

Referenced By

Element: ts [type LanguageFallback]

Derived By

Type base64Binary

Referenced By

Element: ts [type LdapSecurityGroup]

Derived By

Type base64Binary

Referenced By

Element: ts [type MetadataProperty]

Derived By

Type base64Binary

Referenced By

Element: ts [type MetadataSchema]

Derived By

Type base64Binary

Referenced By

Element: ts [type RenderingActionArgumentValue]

Derived By

Type base64Binary

Referenced By

Element: ts [type RenderingActionValue]

Derived By

Type base64Binary

Referenced By

Element: ts [type RightTemplate]

Derived By

Type base64Binary

Referenced By

Element: ts [type RightTemplate2AssetType]

Derived By

Type base64Binary

Referenced By

Element: ts [type RightTemplate2Right]

Derived By

Type base64Binary

Referenced By

Element: ts [type Skin]

Derived By

Type base64Binary

Referenced By

Element: ts [type UserData]

Derived By

Type base64Binary

Referenced By

Element: ts [type UserGroupItem]

Derived By

Type base64Binary

Referenced By

Element: ts [type UserGroupTranslation]

Derived By

Type base64Binary

Referenced By

Element: ts [type UserShort]

Derived By

Type base64Binary

Referenced By

Element: Type [type PictureparkFault]

Derived By

Type PictureparkErrorType

Enumeration
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.
Referenced By

Element: UnassignedAssetsOnly [type ExtendedAssetFilter]

Description

Optional. If true, only assets which are in no category are returned. Default: false.

Derived By

Type boolean

Referenced By

Element: unsignedByte

Derived By

Type unsignedByte

Element: unsignedInt

Derived By

Type unsignedInt

Element: unsignedLong

Derived By

Type unsignedLong

Element: unsignedShort

Derived By

Type unsignedShort

Element: UpdateAssetContainer

Derived By

Restricting anyType

Content Model

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.

Element: UpdateAssetContainerResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: UpdateAssetLinks

Derived By

Restricting anyType

Content Model

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.

Element: UpdateAssetLinksResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: UpdateAssetMetadata

Derived By

Restricting anyType

Content Model

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.

Element: UpdateAssetMetadataResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: UpdateAssetsMetadata

Derived By

Restricting anyType

Content Model

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.

Element: UpdateAssetsMetadataResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: UpdateFieldSetDefaultValue

Derived By

Restricting anyType

Content Model

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.

Element: UpdateFieldSetDefaultValueResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: UpdateOriginalDerivative

Derived By

Restricting anyType

Content Model

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.

Element: UpdateOriginalDerivativeResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: updateStatistic [element GetMetadata]

Description

If true, the action is recorded in the statistics table.

Derived By

Type boolean

Referenced By

Element: UpdateUser

Derived By

Restricting anyType

Content Model

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.

Element: UpdateUserResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: UploadChunk

Derived By

Restricting anyType

Content Model

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.

Element: UploadChunkResponse

Derived By

Restricting anyType

Content Model

Always empty.

Element: UploadFile

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
stream  StreamBody  A file stream

Element: UploadFileResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UploadFileResult  guid 

Element: UploadFileResult [element UploadFileResponse]

Derived By

Type guid

Restrictions
Referenced By

Element: UploadFirstChunk

Derived By

Restricting anyType

Content Model

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.

Element: UploadFirstChunkResponse

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UploadFirstChunkResult  guid 

Element: UploadFirstChunkResult [element UploadFirstChunkResponse]

Derived By

Type guid

Restrictions
Referenced By

Element: URL [type Download]

Derived By

Type string

Referenced By

Element: UrlEntryPoint [type HttpContextRequestInfo]

Description

E.g. "https//customer.picturepark.com/Website/default.aspx".

Derived By

Type string

Referenced By

Element: UrlReferrer [type HttpContextRequestInfo]

Description

E.g. "http://start-picturepark.vit.local/development/"

Derived By

Type string

Referenced By

Element: UrlThumbnailSmall [type AssetFieldValues]

Description

The small thumbnail for preview in batch editor.

Derived By

Type string

Referenced By

Element: UrlThumbnailSmall [type DerivativeLock]

Derived By

Type string

Referenced By

Element: UrlThumbnailSmall [type UserActionHistoryInfo]

Derived By

Type string

Referenced By

Element: UsagePurpose [type DownloadOptions]

Description

Any text, needed only for logging purposes.

Derived By

Type string

Referenced By

Element: Use4AssetConversion [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: Use4Preview [type PortDerivative]

Derived By

Type boolean

Referenced By

Element: UseGuid4FileName [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: UseLdapAuthentication [type UserData]

Derived By

Type boolean

Referenced By

Element: UseLdapAuthentication [type UserShort]

Derived By

Type boolean

Referenced By

Element: UsePublicFileDirectory [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: User [type CoreInfo]

Description

Session specific User data.

Derived By

Type User

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DisplayName  string  First name plus last name
Email  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 
Referenced By

Element: User

Derived By

Type User

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DisplayName  string  First name plus last name
Email  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: UserAction [type DownloadOptions]

Description

Needed for logging purposes. Must be one of DerivativeDownload, DerivativeView or AssetReplication.

Derived By

Type UserAction

Enumeration
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 
Referenced By

Element: UserAction [type UserActionHistoryInfo]

Derived By

Type UserAction

Enumeration
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 
Referenced By

Element: UserAction

Derived By

Type UserAction

Enumeration
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: UserActionDate [type UserActionHistoryInfo]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: UserActionHistoryId [type UserActionHistoryInfo]

Derived By

Type int

Referenced By

Element: UserActionHistoryInfo [type ArrayOfUserActionHistoryInfo]

Derived By

Type UserActionHistoryInfo

Content Model

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 
Referenced By

Element: UserActionHistoryInfo

Derived By

Type UserActionHistoryInfo

Content Model

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 

Element: UserActionHistoryInfoCollection

Derived By

Type UserActionHistoryInfoCollection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
BatchGuid  string 
TotalUserActionHistoryInfos  int 
UserActionHistoryInfos  ArrayOfUserActionHistoryInfo 

Element: UserActionHistoryInfos [type UserActionHistoryInfoCollection]

Derived By

Type ArrayOfUserActionHistoryInfo

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserActionHistoryInfo  UserActionHistoryInfo 
Referenced By

Element: UserAgent [type HttpContextRequestInfo]

Description

E.g. "Mozilla/5.0 (Windows NT 6.1; rv:2.0) Gecko/20100101 Firefox/4.0".

Derived By

Type string

Referenced By

Element: UserCollection

Derived By

Type UserCollection

Content Model

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: UserCompact

Derived By

Type UserCompact

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
EmailAddress  string 
FirstName  string 
LastName  string 
UserId  int 

Element: userData [element CreateUser]

Description

UserData for the new user.

Derived By

Type UserData

Content Model

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 
Country  Country 
CountryId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Department  string 
EmailAddress  string 
ExpirationDate  DateTimeOffset 
FieldValues  ArrayOfFieldValue 
FirstName  string 
Guid4PasswordReset  string 
HasTermsAccepted  boolean 
Impersonation  Impersonation 
InternalContactUserId  int 
IsGuest  boolean 
IsSupport  boolean 
IsSupportContact  boolean 
IsUpdaterServiceUser  boolean 
LanguageId  int 
LastActiveFacetConfigurationId  int 
LastLoginDate  DateTimeOffset 
LastName  string 
LockDate  DateTimeOffset 
LoginOnlyWithClaimsIdentity  boolean 
LoginOnlyWithSecurityToken  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Phone  string 
RegistrationState  RegistrationState 
RenewalState  RenewalState 
RenewalUntilDate  DateTimeOffset 
SiteId  int 
UseLdapAuthentication  boolean 
UserGroupIds  ArrayOfint 
UserId  int 
Zip  string 
ts  base64Binary 
Referenced By

Element: userData [element GetSecurityToken]

Description

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.

Derived By

Type UserData

Content Model

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 
Country  Country 
CountryId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Department  string 
EmailAddress  string 
ExpirationDate  DateTimeOffset 
FieldValues  ArrayOfFieldValue 
FirstName  string 
Guid4PasswordReset  string 
HasTermsAccepted  boolean 
Impersonation  Impersonation 
InternalContactUserId  int 
IsGuest  boolean 
IsSupport  boolean 
IsSupportContact  boolean 
IsUpdaterServiceUser  boolean 
LanguageId  int 
LastActiveFacetConfigurationId  int 
LastLoginDate  DateTimeOffset 
LastName  string 
LockDate  DateTimeOffset 
LoginOnlyWithClaimsIdentity  boolean 
LoginOnlyWithSecurityToken  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Phone  string 
RegistrationState  RegistrationState 
RenewalState  RenewalState 
RenewalUntilDate  DateTimeOffset 
SiteId  int 
UseLdapAuthentication  boolean 
UserGroupIds  ArrayOfint 
UserId  int 
Zip  string 
ts  base64Binary 
Referenced By

Element: userData [element UpdateUser]

Description

The (modified) UserData.

Derived By

Type UserData

Content Model

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 
Country  Country 
CountryId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Department  string 
EmailAddress  string 
ExpirationDate  DateTimeOffset 
FieldValues  ArrayOfFieldValue 
FirstName  string 
Guid4PasswordReset  string 
HasTermsAccepted  boolean 
Impersonation  Impersonation 
InternalContactUserId  int 
IsGuest  boolean 
IsSupport  boolean 
IsSupportContact  boolean 
IsUpdaterServiceUser  boolean 
LanguageId  int 
LastActiveFacetConfigurationId  int 
LastLoginDate  DateTimeOffset 
LastName  string 
LockDate  DateTimeOffset 
LoginOnlyWithClaimsIdentity  boolean 
LoginOnlyWithSecurityToken  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Phone  string 
RegistrationState  RegistrationState 
RenewalState  RenewalState 
RenewalUntilDate  DateTimeOffset 
SiteId  int 
UseLdapAuthentication  boolean 
UserGroupIds  ArrayOfint 
UserId  int 
Zip  string 
ts  base64Binary 
Referenced By

Element: UserData

Derived By

Type UserData

Content Model

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 
Country  Country 
CountryId  int 
CreatedByUserId  int 
CreationDate  DateTimeOffset 
Department  string 
EmailAddress  string 
ExpirationDate  DateTimeOffset 
FieldValues  ArrayOfFieldValue 
FirstName  string 
Guid4PasswordReset  string 
HasTermsAccepted  boolean 
Impersonation  Impersonation 
InternalContactUserId  int 
IsGuest  boolean 
IsSupport  boolean 
IsSupportContact  boolean 
IsUpdaterServiceUser  boolean 
LanguageId  int 
LastActiveFacetConfigurationId  int 
LastLoginDate  DateTimeOffset 
LastName  string 
LockDate  DateTimeOffset 
LoginOnlyWithClaimsIdentity  boolean 
LoginOnlyWithSecurityToken  boolean 
ModificationDate  DateTimeOffset 
ModifiedByUserId  int 
Phone  string 
RegistrationState  RegistrationState 
RenewalState  RenewalState 
RenewalUntilDate  DateTimeOffset 
SiteId  int 
UseLdapAuthentication  boolean 
UserGroupIds  ArrayOfint 
UserId  int 
Zip  string 
ts  base64Binary 

Element: UserDerivativeRights [type ArrayOfUserDerivativeRights]

Derived By

Type UserDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  ArrayOfDerivativeDefinitionRights 
UserGroup  UserGroupItem 
Referenced By

Element: UserDerivativeRights

Derived By

Type UserDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRights  ArrayOfDerivativeDefinitionRights 
UserGroup  UserGroupItem 

Element: UserGroup [type UserDerivativeRights]

Derived By

Type UserGroupItem

Content Model

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 
Referenced By

Element: UserGroup [type UserGroupAssetContainerRights]

Derived By

Type UserGroupItem

Content Model

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 
Referenced By

Element: UserGroup [type UserGroupAssetRights]

Derived By

Type UserGroupItem

Content Model

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 
Referenced By

Element: UserGroup [type UserGroupDerivativeRights]

Derived By

Type UserGroupItem

Content Model

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 
Referenced By

Element: UserGroup [type UserGroupItem]

Derived By

Type string

Referenced By

Element: UserGroup2LdapSecurityGroupId [type LdapSecurityGroup]

Derived By

Type int

Referenced By

Element: userGroupAssetContainerRights [element SaveAssetContainerRights]

Description

The list of UserGroupAssetContainerRights which defines the rights for each usergroup in the list.

Derived By

Type ArrayOfUserGroupAssetContainerRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetContainerRights  UserGroupAssetContainerRights 
Referenced By

Element: UserGroupAssetContainerRights [type ArrayOfUserGroupAssetContainerRights]

Derived By

Type UserGroupAssetContainerRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRights  ArrayOfAssetContainerRight 
UserGroup  UserGroupItem 
Referenced By

Element: UserGroupAssetContainerRights

Derived By

Type UserGroupAssetContainerRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetContainerRights  ArrayOfAssetContainerRight 
UserGroup  UserGroupItem 

Element: userGroupAssetRights [element SaveAssetsRights]

Description

List<UserGroupAssetRights>

Derived By

Type ArrayOfUserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetRights  UserGroupAssetRights 
Referenced By

Element: UserGroupAssetRights [type ArrayOfUserGroupAssetRights]

Derived By

Type UserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRights  ArrayOfAssetRight 
UserGroup  UserGroupItem 
Referenced By

Element: UserGroupAssetRights [type AssetImportOptions]

Description

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

Derived By

Type ArrayOfUserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupAssetRights  UserGroupAssetRights 
Referenced By

Element: UserGroupAssetRights

Derived By

Type UserGroupAssetRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetRights  ArrayOfAssetRight 
UserGroup  UserGroupItem 

Element: userGroupDerivativeRights [element SaveDerivativeRights]

Description

List of datatype UserGroupDerivativeRights.

Derived By

Type ArrayOfUserGroupDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupDerivativeRights  UserGroupDerivativeRights 
Referenced By

Element: UserGroupDerivativeRights [type ArrayOfUserGroupDerivativeRights]

Derived By

Type UserGroupDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeRights  ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h 
UserGroup  UserGroupItem 
Referenced By

Element: UserGroupDerivativeRights [type AssetImportOptions]

Description

Optional. See under UserGroupAssetRights for a more detailed example for a similar parameter.

Derived By

Type ArrayOfUserGroupDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupDerivativeRights  UserGroupDerivativeRights 
Referenced By

Element: UserGroupDerivativeRights

Derived By

Type UserGroupDerivativeRights

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeRights  ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h 
UserGroup  UserGroupItem 

Element: userGroupId [element GetUsers]

Description

Optional. The id of a user group, if you wish to get only users from a certain group.

Derived By

Type int

Referenced By

Element: UserGroupId [type ClaimGroup]

Derived By

Type int

Referenced By

Element: UserGroupId [type LdapSecurityGroup]

Derived By

Type int

Referenced By

Element: UserGroupId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: UserGroupId [type RightTemplate2UserGroup]

Derived By

Type int

Referenced By

Element: UserGroupId [type UserGroupItem]

Derived By

Type int

Referenced By

Element: UserGroupId [type UserGroupTranslation]

Derived By

Type int

Referenced By

Element: UserGroupIds [type UserData]

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: UserGroupItem

Derived By

Type UserGroupItem

Content Model

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: UserGroupRight [type ArrayOfUserGroupRight]

Derived By

Type UserGroupRight

Enumeration
Value  Description 
ViewUserGroup 
EditUserGroup 
DeleteUserGroup 
ViewUserGroupRights 
EditUserGroupRights 
AssignUsers 
EditUsers 
ImpersonateUserGroup 
ImpersonateUser 
Referenced By

Element: UserGroupRight

Derived By

Type UserGroupRight

Enumeration
Value  Description 
ViewUserGroup 
EditUserGroup 
DeleteUserGroup 
ViewUserGroupRights 
EditUserGroupRights 
AssignUsers 
EditUsers 
ImpersonateUserGroup 
ImpersonateUser 

Element: UserGroupRightId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: UserGroupRights [type Rights]

Derived By

Type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfUserGroupRightuUS27HWe  anyType (restriction) 
Referenced By

Element: UserGroups [type User]

Description

Array of the ids of the assigned user groups.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: UserGroups2ClaimGroupId [type ClaimGroup]

Derived By

Type int

Referenced By

Element: UserGroupTranslation [type ArrayOfUserGroupTranslation]

Derived By

Type UserGroupTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LanguageId  int 
Name  string 
UserGroupId  int 
UserGroupTranslationId  int 
ts  base64Binary 
Referenced By

Element: UserGroupTranslation

Derived By

Type UserGroupTranslation

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
LanguageId  int 
Name  string 
UserGroupId  int 
UserGroupTranslationId  int 
ts  base64Binary 

Element: UserGroupTranslationId [type UserGroupTranslation]

Derived By

Type int

Referenced By

Element: UserHostAddress [type HttpContextRequestInfo]

Description

The ip address of the user host.

Derived By

Type string

Referenced By

Element: UserHostName [type HttpContextRequestInfo]

Description

The DNS name of the user host.

Derived By

Type string

Referenced By

Element: userId [element GetUserById]

Description

The id of the user.

Derived By

Type int

Referenced By

Element: UserId [type DerivativeLock]

Derived By

Type int

Referenced By

Element: UserId [type FieldValue]

Derived By

Type int

Referenced By

Element: UserId [type User]

Derived By

Type int

Referenced By

Element: UserId [type UserCompact]

Derived By

Type int

Referenced By

Element: UserId [type UserData]

Derived By

Type int

Referenced By

Element: UserId [type UserShort]

Derived By

Type int

Referenced By

Element: userIds [element RemoveUsers]

Description

A list of user ids.

Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: UserRight [type ArrayOfUserRight]

Derived By

Type UserRight

Enumeration
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 
Referenced By

Element: UserRight

Derived By

Type UserRight

Enumeration
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: UserRightId [type RightTemplate2Right]

Derived By

Type int

Referenced By

Element: UserRights [type Rights]

Derived By

Type ArrayOfUserRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserRight  UserRight 
Referenced By

Element: Users [type UserCollection]

Description

An array of UserShort.

Derived By

Type ArrayOfUserShort

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserShort  UserShort 
Referenced By

Element: UserShort [type ArrayOfUserShort]

Derived By

Type UserShort

Content Model

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 
Referenced By

Element: UserShort

Derived By

Type UserShort

Content Model

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: UseVideo4Thumbnails [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: ValidationRegEx [type Field]

Description

A regular expression used to check the input data, e.g. to enforce the input of an email address in a correct format.

Derived By

Type string

Referenced By

Element: Value [type ArrayOfKeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h/KeyValueOfDerivativeDefinitionArrayOfDerivativeRightU2tm7C3h]

Derived By

Type ArrayOfDerivativeRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeRight  DerivativeRight 
Referenced By

Element: Value [type ArrayOfKeyValueOfDownloadArrayOfAssetSelection9aSSyLXK/KeyValueOfDownloadArrayOfAssetSelection9aSSyLXK]

Derived By

Type ArrayOfAssetSelection

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
AssetSelection  AssetSelection 
Referenced By

Element: Value [type ArrayOfKeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe/KeyValueOfintArrayOfDerivativeDefinitionRightuUS27HWe]

Derived By

Type ArrayOfDerivativeDefinitionRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DerivativeDefinitionRight  DerivativeDefinitionRight 
Referenced By

Element: Value [type ArrayOfKeyValueOfintArrayOfFieldRightuUS27HWe/KeyValueOfintArrayOfFieldRightuUS27HWe]

Derived By

Type ArrayOfFieldRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FieldRight  FieldRight 
Referenced By

Element: Value [type ArrayOfKeyValueOfintArrayOfPersonalItemRightuUS27HWe/KeyValueOfintArrayOfPersonalItemRightuUS27HWe]

Derived By

Type ArrayOfPersonalItemRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
PersonalItemRight  PersonalItemRight 
Referenced By

Element: Value [type ArrayOfKeyValueOfintArrayOfSiteRightuUS27HWe/KeyValueOfintArrayOfSiteRightuUS27HWe]

Derived By

Type ArrayOfSiteRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
SiteRight  SiteRight 
Referenced By

Element: Value [type ArrayOfKeyValueOfintArrayOfUserGroupRightuUS27HWe/KeyValueOfintArrayOfUserGroupRightuUS27HWe]

Derived By

Type ArrayOfUserGroupRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
UserGroupRight  UserGroupRight 
Referenced By

Element: Value [type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe/KeyValueOfintArrayOfWidgetRightuUS27HWe]

Derived By

Type ArrayOfWidgetRight

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
WidgetRight  WidgetRight 
Referenced By

Element: Value [type ArrayOfKeyValueOfintPortViewField6jg_STziK/KeyValueOfintPortViewField6jg_STziK]

Derived By

Type PortViewField

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Caption  string 
IsFullWidth  boolean 
Position  int 
Values  ArrayOfstring 
Referenced By

Element: Value [type KnownFieldValueAssetContainerAssignment]

Derived By

Type AssetContainerAssignmentExtended

Content Model

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 
Referenced By

Element: Value [type KnownFieldValueBoolean]

Derived By

Type boolean

Referenced By

Element: Value [type KnownFieldValueDateTime]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: Value [type KnownFieldValueDouble]

Derived By

Type double

Referenced By

Element: Value [type KnownFieldValueInteger32]

Derived By

Type int

Referenced By

Element: Value [type KnownFieldValueInteger64]

Derived By

Type long

Referenced By

Element: Value [type KnownFieldValueString]

Derived By

Type string

Referenced By

Element: Value [type KnownFieldValueUserShort]

Derived By

Type UserShort

Content Model

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 
Referenced By

Element: Value [type RenderingActionArgumentValue]

Derived By

Type string

Referenced By

Element: Value [type XmpItem]

Derived By

Type string

Referenced By

Element: ValueAssetContainerAssignment [type FieldValue]

Derived By

Type AssetContainerAssignmentExtended

Content Model

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 
Referenced By

Element: ValueAssetContainerId [type FieldValue]

Derived By

Type int

Referenced By

Element: ValueBoolean [type FieldValue]

Derived By

Type boolean

Referenced By

Element: ValueDate [type FieldValue]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ValueDateTime [type FieldValue]

Derived By

Type DateTimeOffset

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
DateTime  dateTime 
OffsetMinutes  short 
Referenced By

Element: ValueDouble [type FieldValue]

Derived By

Type double

Referenced By

Element: ValueInteger32 [type FieldValue]

Derived By

Type int

Referenced By

Element: ValueInteger64 [type FieldValue]

Derived By

Type long

Referenced By

Element: Values [type FacetResult]

Derived By

Type ArrayOfFacetValue

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
FacetValue  FacetValue 
Referenced By

Element: Values [type PortViewField]

Derived By

Type ArrayOfstring

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
string  string 
Referenced By

Element: ValueString [type FieldOption]

Derived By

Type string

Referenced By

Element: ValueString [type FieldOptionTranslation]

Derived By

Type string

Referenced By

Element: ValueString [type FieldValue]

Derived By

Type string

Referenced By

Element: ValueUserShort [type FieldValue]

Derived By

Type UserShort

Content Model

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 
Referenced By

Element: Version [type AssetVersion]

Description

The name of the version, e.g. "English" or "French".

Derived By

Type string

Referenced By

Element: Version

Derived By

Type Version

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
_Build  int 
_Major  int 
_Minor  int 
_Revision  int 

Element: VersionOptionId [type AssetVersion]

Derived By

Type int

Referenced By

Element: VersionOptionId [type PortDerivative]

Derived By

Type int

Referenced By

Element: VersionTypeId [type AssetVersion]

Description

Versiontypes are e.g. Languages, History, Associated, Presentation etc.

They are individually configurable for each Picturepark. Language usually exists and has the id = 1.

Derived By

Type int

Referenced By

Element: VersionTypeId [type PortDerivative]

Derived By

Type int

Referenced By

Element: VersionTypeIds [type ExtendedAssetFilter]

Description

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 }
Derived By

Type ArrayOfint

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
int  int 
Referenced By

Element: VideoAudioBitrate [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: VideoAudioCodecId [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: VideoBitrate [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: VideoBitRate [type VideoStream]

Derived By

Type int

Referenced By

Element: VideoCodec [type VideoStream]

Derived By

Type string

Referenced By

Element: VideoCodecId [type DerivativeDefinition]

Derived By

Type int

Referenced By

Element: VideoCount [type MediaInfo]

Derived By

Type int

Referenced By

Element: VideoDisplayAspectRatio [type VideoStream]

Derived By

Type string

Referenced By

Element: VideoDuration [type VideoStream]

Derived By

Type duration

Restrictions
Referenced By

Element: VideoDurationInSeconds [type Derivative]

Derived By

Type double

Referenced By

Element: VideoFormat [type VideoStream]

Derived By

Type string

Referenced By

Element: VideoFrameCount [type VideoStream]

Derived By

Type int

Referenced By

Element: VideoFrameRate [type VideoStream]

Derived By

Type float

Referenced By

Element: VideoHeight [type Derivative]

Derived By

Type int

Referenced By

Element: VideoHeight [type VideoStream]

Derived By

Type int

Referenced By

Element: VideoLanguage [type VideoStream]

Derived By

Type string

Referenced By

Element: VideoPixelAspectRatio [type VideoStream]

Derived By

Type float

Referenced By

Element: VideoResolution [type VideoStream]

Derived By

Type int

Referenced By

Element: VideoRotation [type VideoStream]

Derived By

Type int

Referenced By

Element: VideoStream [type ArrayOfVideoStream]

Derived By

Type VideoStream

Content Model

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 
Referenced By

Element: VideoStream

Derived By

Type VideoStream

Content Model

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: VideoStreams [type MediaInfo]

Derived By

Type ArrayOfVideoStream

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
VideoStream  VideoStream 
Referenced By

Element: VideoStreamSize [type VideoStream]

Derived By

Type long

Referenced By

Element: VideoWidth [type Derivative]

Derived By

Type int

Referenced By

Element: VideoWidth [type VideoStream]

Derived By

Type int

Referenced By

Element: WidgetRight [type ArrayOfWidgetRight]

Derived By

Type WidgetRight

Enumeration
Value  Description 
View 
Manage 
Reply 
Rate 
Referenced By

Element: WidgetRight

Derived By

Type WidgetRight

Enumeration
Value  Description 
View 
Manage 
Reply 
Rate 

Element: WidgetRights [type Rights]

Derived By

Type ArrayOfKeyValueOfintArrayOfWidgetRightuUS27HWe

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
KeyValueOfintArrayOfWidgetRightuUS27HWe  anyType (restriction) 
Referenced By

Element: Width [type PortDerivative]

Derived By

Type int

Referenced By

Element: WidthInCm [type AssetObject]

Derived By

Type double

Referenced By

Element: WidthInCm [type DocumentPage]

Derived By

Type double

Referenced By

Element: WriteXmp2File [type DerivativeDefinition]

Derived By

Type boolean

Referenced By

Element: XmpItem [type ArrayOfXmpItem]

Derived By

Type XmpItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Name  string 
Value  string 
children  ArrayOfXmpItem 
expanded  boolean 
leaf  boolean 
Referenced By

Element: XmpItem

Derived By

Type XmpItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
Name  string 
Value  string 
children  ArrayOfXmpItem 
expanded  boolean 
leaf  boolean 

Element: XmpItems [type AssetMetadata]

Description

An array with XmpItems if the asset is an image and metadata mapping is enabled.

Derived By

Type ArrayOfXmpItem

Content Model

Contains elements as defined in the following table.

Component  Type  Description 
   
XmpItem  XmpItem 
Referenced By

Element: XmpOutOfSync [type AssetItem]

Description

Technical flag concerning the rendering state.

Derived By

Type boolean

Referenced By

Element: XmpSyncFailed [type AssetItem]

Description

Technical flag concerning the rendering state.

Derived By

Type boolean

Referenced By

Element: Zip [type UserData]

Derived By

Type string

Referenced By

Element: Zip [type UserShort]

Derived By

Type string

Referenced By