10.8.0

Notification

Contracts Notification

Notification contract + details was changed

• It now includes a ReferenceDocType + ReferenceId to point you to the correct reference for your notification (e.g. when creating a share, referenceDocType will be ShareDoc and the referenceId will be the share's ID)

• Everything business process related has been moved to a new base class of which all business process related details inherit. ReferenceDocType is then BusinessProcessDoc and the referenceId contains the ID of the business process

See Picturepark.Swagger.json

Index Fields

/v1/schemas/indexFields/searchBySchemaIds (Schema.GetIndexFieldsAsync)

Endpoint removed

• Endpoint to get the index fields was removed

• Related IndexField contracts were removed

Notification

/v1/notifications

Notifications exposed on API

• Notifications are now accessible using API. Retrieval of single notifications, searches and marking notifications as read is supported.

See PictureparkSwagger.json or NotificationTests.cs for samples

Email notifications

/v1/notifications/emailNotifications/settings

Email notification settings

• A user can now configure to receive certain notifications (produced by BusinessRule's ProduceNotificationAction) via email.

• The configuration includes an interval, a general opt-in flag and an override for specific notification details to included in the email.

See PictureparkSwagger.json or NotificationTests.cs for samples

Templates

/v1/templates

Templates exposed on API

• Templates are now accessible using API.

• New templates overriding the system defaults can be created.

• New template types NotificationMail and NotificationMailItem were introduced. NotificationMailItem templates can be created using a custom 'Name' property and therefore referenced using this property from the BusinessRule Notification contract.

• Custom templates for different languages can also be created for the types SharePage, ShareMail and ShareNotFoundPage.

See PictureparkSwagger.json or TemplateTests.cs for samples

Share

/v1/shares/{id}

Content resolve limit

• Share get supports new parameter contentResolveLimit to limit the number of contents resolved.

• Defaults (if not set at all) to resolving all contents in Share. Set to a low value to improve performance.

See PictureparkSwagger.json or ShareTests.cs for samples

Share

/v1/shares/{id}/contents

New endpoint to resolve contents in share

• This new endpoint allows paging over the resolved contents in a share.

See PictureparkSwagger.json or ShareTests.cs for samples

Schema Aggregation Fields

/v1/schemas/{id}/aggregationFields (Schema.GetAggregationFieldsAsync)

Endpoint added

• Endpoint to get the agggreation fields on a schema was added

• Related FieldInfo contract was added

See PictureparkSwagger.json or SchemaTests.cs for samples

Schema Aggregation Fields

/v1/schemas/many/aggregationFields?ids={schemaId1},{schemaId2} (Schema.GetAggregationFieldsManyAsync)

Endpoint added

• Endpoint to get the agggreation fields on multiple schemas was added

• Related FieldInfo contract was added

See PictureparkSwagger.json or SchemaTests.cs for samples

Schema Filter Fields

/v1/schemas/{id}/filterFields (Schema.GetFilterFieldsAsync)

Endpoint added

• Endpoint to get the filter fields on a schema was added

• Related FieldInfo contract was added

See PictureparkSwagger.json or SchemaTests.cs for samples

Schema Filter Fields

/v1/schemas/many/filterFields?ids={schemaId1},{schemaId2} (Schema.GetFilterFieldsManyAsync)

Endpoint added

• Endpoint to get the filter fields on multiple schemas was added

• Related FieldInfo contract was added

See PictureparkSwagger.json or SchemaTests.cs for samples

Channel Aggregation Fields

/v1/channels/fields/aggregation (Channel.GetAggregationFieldsAsync)

Endpoint added

• Endpoint to get the agggreation fields that can be used to define aggregations in any channel

• Related FieldInfo contract was added

See PictureparkSwagger.json or ChannelTests.cs for samples

Channel Filter Fields

/v1/channels/fields/filter (Channel.GetFilterFieldsAsync)

Endpoint added

• Endpoint to get the filter fields that can be used to define filters in any channel and in aggregations in a channel

• Related FieldInfo contract was added

See PictureparkSwagger.json or ChannelTests.cs for samples

Channel Sort Fields

/v1/channels/fields/sort) (Channel.GetSortFieldsAsync)

Endpoint added

• Endpoint to get the sort fields that can be used to sort a channel

• Related SortFieldInfo contract was added

See PictureparkSwagger.json or ChannelTests.cs for samples

Share languages

/v1/info/customer

New property added

• Available share languages for a customer are now exposed on CustomerInfo in property LanguageConfiguration.ShareLanguages

Reference

Schema field's configuration

Endpoints to create, update and get one or multiple schemas

New analyzer added

• When configuring a text field (FieldString) of a schema, is now possible to use the new "NoDiacriticalAnalyzer" that removes all the diacritical signs from the words, so that the search works properly independently if the search terms are with or without any diacritical sign

See Contracts.Generated.cs or AnalyzerTests.cs for samples

All features supporting aggregation

TermsAggregator, TermsRelationAggregator

Sort field added

• Sort field is available for TermsAggregator and TermsRelationAggregator (if DocumentType is ListItem).

• If no sort is defined (null is passed), aggregation behaves same as before and aggregation result items are sorted by count.

• Otherwise, there are two attributes to influence the order of the result items:

  • Field – specifies the field to sort on, if no field is specified, the result items will be sorted by aggregation's field,

  • Direction – specifies either ascending or descending direction of the sort.

See Contracts.Generated.cs

Schema

SchemaIndexingInfo, TransferSchemaIndexingInfo

Option IncludeNameDisplayValueInFilters added

• If IncludeNameDisplayValueInFilters option is set to true, display value Name will be indexed along with the filter index for the respective tagbox field, allowing to use a '_displayValues.name' index field to sort aggregations.

• Setting the attribute to true for a non-tagbox field will result in a validation error.

See Contracts.Generated.cs