Aprimo DAM REST API documentation

After deployment of the Aprimo DAM REST API, you should also configure the Aprimo DAM structures that are used by the REST API.

This configuration will, among other things, create a .rest_SettingsWhitelist system setting. If you want to work with Aprimo DAM settings via the REST API, this setting should be provisioned by an Aprimo DAM administrator, as described in the setting resource documentation. However, the whitelist does not affect users from the Aprimo DAM Administrator and Operator user groups: they have access to all their Aprimo DAM settings, irrespective of the whitelist.

To do the configuration:

1. Authenticate, using the credentials of an Aprimo DAM administrator account on the Aprimo DAM registration that you want to initialize, and use the token to connect to the setup endpoint.
2. Perform an HTTP POST request on the /setup endpoint. This POST request should have an empty body.

Note: If you have more than one Aprimo DAM registration, you have to repeat this request for each of the Aprimo DAM registrations.

POST /setup HTTP/1.1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
API-VERSION: 1

The command above will upgrade your REST API system structures to the up-to-date state. However, such upgrade depends on other components of the system and previous upgrades. You may face a situation when configuration call passes successfully, but there is still an issue e.g. when uploading files. If you see such issues, these are the possible actions to fix them:

1. First, try rebuilding an Enterprise Search index and/or ensure synchronization is started. Consult Aprimo DAM Administrator Guide or Enterprise Search Administration on how to do this.
2. If step 1 doesn't solve the issue, you can try to repair your REST API structures by performing a forced configuration call. It differes from regular configuration call by an added request body containing a forceRebuild flag. Of course, you should also add the content-type header.

Note: this form of configuration request is an emergency action that is not normally needed. All the missing items needed by REST API will be recreated. This means that as the result of this command you may get useless objects in your system if you previously renamed them manually.

POST /setup HTTP/1.1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
API-VERSION: 1
Content-Type: application/json
{ "forceRebuild": true }

The Aprimo DAM REST API supports two different ways of consuming and navigating the API:

HAL/JSON hypermedia

Once a resource is retrieved, your client can bookmark the URI in its cache. The existing relation names will not change over time, but new relations can be introduced.

Links in the returned resource representation help you to navigate the API, just by following those links. Using this approach helps create API clients/servers that do not depend too much on each other and can be developed in an independent way, as long as both the client and the server have a common understanding of media types used in the communication. For example, you can start using the API by going to the root URI of the API and discover all the resources you can access. From that point on, you can follow links and explore the resources existing throughout the API. You can use the "select" keys, present in most of the resources, which provide you with information about which sub-resources can be embedded in that resource. This way you can retrieve the exact information needed in a single request, which helps you optimize the chattiness of the API for your specific use case.

Plain JSON consumption

Next to using the HAL/JSON hypermedia API, clients can also consume the API using plain JSON. This is a simpler but less robust approach, since it lacks discoverability and requires upfront knowledge of the URI's for all the endpoints that the client will need. For pure JSON clients, we provide an exhaustive list of the endpoints available in the API.

A required request header parameter, which specifies which version of the API the request will refer to:

API-Version: 1

There are some exceptions to this requirement, like the root resource and the "supported versions" resource. These resources are version-agnostic, meaning they will always display the same result, no matter which "API-Version" parameter has been specified (if any). Also, they will never change what exists, but can add new information to ensure backwards-compatibility. The reason for this exception is a requirement to provide consumers with a way to discover the list of existing and supported API versions before they start using it. If these resources were also version-aware, consumers wouldn't have a way to discover the proper values that can be specified in the "API-Version" parameter.

For the complete list of exceptions, refer to the Endpoint header requirements section.

The Aprimo DAM REST API supports the following media types:

• Response media types:

  • application/hal+json (default)
  • application/json

• Request media types:

  • application/json (default)

The selecting feature is used in the Aprimo DAM REST API to support the dynamic nature of the Aprimo DAM resources and to provide the API consumers with a way to select a custom granularity level for the resource representation they want to retrieve from Aprimo DAM. It helps consumers retrieve more information using a single request.

By default, when a resource is requested, it is usually returned using a minimal representation, which contains as little data as possible (for example, all of the sub-resources of the requested resource are not returned in this minimal representation). If needed, a consumer can extend this resource representation by selecting more data to be included, using the "select" header parameter.

The general format of the select parameter is: "Select-{Resource}: SubResource1,SubResource2,SubResource3, ..." where the value is a comma-separated list of subresources to be included in the resulting resource representation. It specifies that the returned resource's representation also contain its subresources, beside the basic/minimal data, which is always returned. For example, to request a list of records, with their classifications and files included with each returned record resource, a consumer typically performs a request like this:

GET /records HTTP/1.1
accept: application/hal+json
select-record: classifications, files

It is also possible to further select the sub-resource's additional attributes in the same request. For example, if a consumer likes to select the children for each classification returned with each record, it is done in this way:

GET /records HTTP/1.1
accept: application/hal+json
select-record: classifications, files
select-classification: children

The returned records collection resource contains records, each of which has the embedded files collection resource and the classifications collection resource with each classification's children collection embedded in the classification resource. All of this has been accomplished in a single request.

There is a possible recursion issue in this particular case, since the "children" sub-resource is also a collection of classifications, each of which can have "children" as a sub-resource, too, which could lead to an unexpected data overflow. To avoid this, a limit was introduced to return only the first level of recursive sub-resources.

Sub-resources

In case sub-resources are returned as linked resources of another parent resource, all of those sub-resources will have an additional attribute named "select-key". This parameter indicates that the sub-resource can be selected (embedded) in the parent resource representation. The value of the "select-key" parameter can be used as a value of the "select-<parent-resource>" parameter. For example, to get a record:

GET /record/250d22a231ed4f0ba9afa49900b0252e HTTP/1.1
accept: application/hal+json

We can see there are numerous linked resources available for that record, which can be selected (embedded) in the returned record representation, using the specified "select-key" parameter:

{
	"_links": {
		"self": {
			"href": "/record/250d22a231ed4f0ba9afa49900b0252e"
		},
		"fields": {
			"href": "/record/250d22a231ed4f0ba9afa49900b0252e/fields",
                    "select-key": "fields"
		},
		"files": {
			"href": "/record/250d22a231ed4f0ba9afa49900b0252e/files",
                    "select-key": "files"
		},
		...
	},
	"id": "250d22a231ed4f0ba9afa49900b0252e",
	"createdOn": "2015-05-15T10:41:19.51Z",
	"modifiedOn": "2015-06-12T11:13:15.433Z",
	"tag": null
}

To request a record resource, with, for example, all the fields selected, look at the "fields" linked resource for the " select-key" parameter with the value " fields". This value means that you can include this sub-resource within the record resource just by specifying: " select-record: fields", when requesting the record next time, like this:

GET /record/250d22a231ed4f0ba9afa49900b0252e HTTP/1.1
accept: application/hal+json
select-record: fields

This time you will get the fields embedded within the record resource instead of just returning a linked resource. This way you can dynamically change the amount of information returned for the same resource requested.

For a more detailed example, see: Reading a record

Attributes

Next to the sub-resources, some resource attributes can also be selected (included or excluded from the requested resource representation). If not selected, these attributes will NOT be returned by default. This will be clearly indicated in the description of the property on the resource page.

The listed attributes were either rarely used or the calculation of their value was too expensive to be included in the default representation of a resource, consequently, it was decided to hide these attributes unless a consumer specifically selects them.

Explicit fields selection

When selecting the fields of a record, classification, user or file, it can be useful to select only certain fields, instead of having them all included in the returned resource. For example, to select fields of a record:

GET /record/250d22a231ed4f0ba9afa49900b0252e HTTP/1.1
accept: application/hal+json
select-record: fields

This selects all the fields on that record. To filter out specific fields (or field groups), you can use additional header parameters that provide such filtering, like " select-record-fields" and " select-record-fieldgroups". The value for these parameters is a comma-separated list of fields/fieldgroups. Fields and field groups can be specified using their Ids (in the form of a GUID) or their names. Since the field/fieldgroup names can contain random text, it is advised to properly encode them using the "Percent-Encoding" so that they can safely pass over the network to the API server. Also take into account that the "comma" character needs to be escaped because it has a special meaning in the HTTP header values. This is an example of the selected fields' filtering feature:

GET /record/250d22a231ed4f0ba9afa49900b0252e HTTP/1.1
accept: application/hal+json
select-record: fields
select-record-fields: 295B1779-A381-4018-BE1D-B29E3458B41C, MyField, DummyField
select-record-fieldgroups: TestFieldGroup, CDE8E0C4-CD7E-47BC-93D3-0F54C7109FB6, FooBarGroup

In the previous example there was no need to use the percent-encoding, but let's consider an example where escaping is required.The field " My,Field,With,Commas" contains a "comma" character in its name. To escape it properly, because in HTTP the header values represent the list of comma-separated values, and to avoid selecting fields with these names: My", " Field", " With" and " Commas", you need to percent-encode the field name so that the request reads as follows:

GET /record/250d22a231ed4f0ba9afa49900b0252e HTTP/1.1
accept: application/hal+json
select-record: fields
select-record-fields: My%2CField%2CWith%2CCommas

This request will result in one field only, named " My,Field,With,Commas".

Default values in field selection

You can choose receive default values in your result set by adding an additional header parameter named select-resolve-default-values. The value for this parameter must either contain true or false. Empty values and spaces will be ignored. True will return default values and false will omit default values. If this parameter is omitted, you will receive default values in your selected fields.

GET /record/250d22a231ed4f0ba9afa49900b0252e HTTP/1.1
accept: application/hal+json
select-record: fields
select-record-fields: 295B1779-A381-4018-BE1D-B29E3458B41C, MyField, DummyField
select-record-fieldgroups: TestFieldGroup, CDE8E0C4-CD7E-47BC-93D3-0F54C7109FB6, FooBarGroup
select-resolve-default-values: false

Advanced selecting and preventing recursion

The REST API will intelligently decide on whether or not to select a resource. Selecting is done based on the resource type. However, the number of times a resource is selected, is limited to prevent recursion. Without that limitation, querying for instance a user with "Select-User: CreatedBy" can lead to a recursive embedding loop where the selection is endlessy re-applied to the embedded resource.

To remedy this, the API will preform selections in such a way that any resource type cannot occur more than two times in the path leading from the topmost resource to the leaves. For instance:

GET /user/{id} HTTP/1.1
select-user: createdby

will return the user, and embed the createdby. The select-user: createdby will no longer be applied to the embedded createdby user, even though this too is a user resource. Similarly:

GET /classification/{id} HTTP/1.1
select-classification: parent, children

will return the specified classification, and embed its parents and children. However, the children of the parent and the parent of the children will not be embedded. This also applies to deeper levels of nesting:

GET /user/{id} HTTP/1.1
select-user: fields
select-field: definition
select-fielddefinition: createdby

will return the following 'tree' of embedded resources:

user
	.field
		.definition
			.createdby
	.field
		.definition
			.createdby

After the second occurrence of the createdby the embedding will stop, because the API will detect that createdby is of type user, which also appears higher up in the embedding tree.

Embedding/following relations that result in missing data

When a relation points to either of the following:

• an image with HasImage=false
• a null value, e.g. when a record’s MasterFile has no files
• an obsolete value, e.g. CreatedBy/ModifiedBy that points to a user who was removed from the database

Then clicking that type of link will have the API by default return a 404 NotFound error containing a meaningful error message. Selecting that type of link will by default have the propertyname: null embedded in the output.

A filter expression can be passed in the request with the filter parameter. It can be specified as a query string or a header parameter. The parameter is only taken into account on collections of resources.

A filter expression is a single-line Aprimo DAM search expression without parameters or any additional options. See simple search examples for more details.

Warning: Searching for records/classifications using a search expression is done in 2 steps: first ElasticSearch is queried to get a list of matching IDs, then those IDs are used to query the Aprimo DAM database.
If any of the search results is deleted between step 1 and 2, the TotalCount value will be out of sync with the real count of search results.

A sort expression can be passed in the request with the sort parameter. It can be specified in the query string or as a header. The parameter is only taken into account on collections of resources. See simple search examples for more details.

Although there are pre-built pagination links via relations such as: " first", " prev", " next" and " last", you can also control the page number and the number of items per page if you provide the " page" and/or " pageSize" parameters. These parameters can be passed as a query string or header parameters. For performance reasons, the " pageSize" parameter has a limit of 1000. When omitted, it defaults to 50. See simple search examples for more details.

Newer or more recently updated routes preferentially support Skip and Take pagination and may not support page and pagesize. skip - bypass a specified number of search results then return the remaining results of this paged collection (int32). take - specify the number of search results to return in this paged collection (int32)

The following registered relations are used: " self", " first", " prev", " next" and " last" (as specified in the Web Linking RFC). Other custom relations are added per resource to allow intuitive navigation of the Rest API.

Note that not all entities, which are exposed as resources through the Rest API, are returned as relations if referenced by another entity. For small and static collections, such as languages, the client application should fetch and cache the list of resources at startup and then map the Ids to resources on the client-side. These resources are not returned as relations but as plain GUIDs.

Fields and labels can be requested in specific languages using the languages header parameter. This parameter can be a single language Id, a comma-separated list of language IDs or an asterisk ("*") that represents all languages. If omitted, this parameter will return the current user's default language.

When unexpected exceptions occur, the Aprimo DAM REST API will feed this back to the API consumer via an HTTP error response containing an exception object as body. The HTTP response code will correspond to the type of exception that occurred:

• HTTP 4xx response codes indicate specific error conditions (validation errors, malformatted requests, access denied, resource not available...)
• HTTP 500 internal server error is returned for all other exceptions

The error object returned can contain the following properties:

The verbosity of this exception object is controlled by the <customErrors /> settings element. By default the full object is only returned for callers from the same host as where the server is located. At low verbosity, the stackTrace and innerException properties are omitted.

When downloading a file using a link returned by an Order or a URI property of an Image resource, the file name is not always known upfront. This can be the case, e.g. when a resize action is applied during the ordering of an object, because that action changes the file name.

Download URI will contain a security token set to expire

• after 30 hours, if default File store is configured to use disk as a storage.
• not sooner than the value of the setting .minimumAvailableTimeForPreviews (for /additionalfile, /image/preview and /image/thumbnail endpoints) or .minimumAvailableTimeForOrders (for download orders) (See the DAM Operations help for more information), if the default File store is configured to use Azure blob storage.

The download URI can return

• file content
• a redirect to the proper file location in case CDN is enabled. It then responds with the http status code "MovedPermanently" (301) or "Redirect" (302)".

It is possible to specify CDN location by setting the value of the optional Location-Alias header. Used values:

• us1 - for South America, Antarctica, North America, Central America, Caribbean
• eu2 - for Europe, Africa, Middle East
• au1 - for Australia, Pacific, Asia (except China)
• cn1 - for China

For reference, the Content-Disposition header is added to the response, and contains the file name, e.g. Content-Disposition: attachment; filename="fname.ext"

For more information, see: section 19.5.1 or RFC 2616.

The Aprimo DAM REST API supports 2 modes of authentication: Bearer and Token-based authentication.

There are several endpoints in the Aprimo DAM REST API that do not require authentication. You can find them in the Endpoint Requirements section.

Bearer authentication

Aprimo DAM REST API supports the Bearer authentication scheme, used with OAuth 2.0. When using Bearer token authentication, the client making a call to an endpoint requiring authentication needs to add an  Authorization HTTP header providing Bearer token, obtained from Marketing Operations. Within the bearer authentication scheme, JWT security tokens are used to authenticate users.

To use the Bearer authentication, your REST client first needs to obtain a JWT (JSON Web Token) from the Marketing Operations REST API.

Here is an example of a valid JWT security token created by the Marketing Operations REST API: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJVSUQiOiIxIiwiQ0lEIjoiMSIsIkRCIjoiMiIsIkRvbWFpbklkIjoiMSIsIkxJRCI6IjEiLCJUSUQiOiI0MyIsIkdNIjoiMjEwMywyMTA0LDIxMDUiLCJVc2VyUmlnaHRzIjoiNjk1LDY4NSw2NjUsMTAyLDEiLCJVVCI6IjEiLCJBVCI6IjAiLCJkYW0tdWlkIjoiZTc1ZGM5OGUtMzIyOS00NDAxLTk0YjctZDZhYzlkMzk0ODk2IiwiZGFtLWxvZ2luIjoiYWhlYXRoIiwiZGFtLXRlbmFudCI6ImxhYi0xMjMiLCJjbGllbnRfaWQiOiJhZGFtIiwiaXNzIjoic2VsZiIsImF1ZCI6Imh0dHBzOi8vbGFiMTIzLmFwcmltby5jb20vIiwiZXhwIjoxNTA4MjExMjI5LCJuYmYiOjE1MDgxNDY0Mjl9

Here is that same token base64-decoded:

{
      "typ": "JWT",
      "alg": "HS256"
}
.
{
      "UID": "1",
      "CID": "1",
      "DB": "2",
      "DomainId": "1",
      "LID": "1",
      "TID": "43",
      "GM": "2103,2104,2105",
      "UserRights": "695,685,665,102,1",
      "UT": "1",
      "AT": "0",
      "dam-uid": "e75dc98e-3229-4401-94b7-d6ac9d394896",
      "dam-login": "aheath",
      "dam-tenant": "lab-123",
      "client_id": "dam",
      "iss": "self",
      "aud": "https://lab123.aprimo.com/",
      "exp": 1508211229,
      "nbf": 1508146429
}
.
[signature]

Once a user is successfully authenticated to Marketing Operations, the obtained JWT token can then be used to access all of the authorized REST API resources.

GET /records  HTTP/1.1
Authorization: Bearer eyJ0e...(base64-encoded JWT security token)...jrzpAg
200 OK
<content>

The following table gives an overview of which header fields are required for all endpoints:

Aprimo DAM REST API, among other features, supports editing of resources. In order to create a new resource, you need to perform a POST request on a collection to which you want to add a new resource. Performing a PUT request updates an existing resource and issuing a DELETE request deletes an existing resource. You need to have appropriate privileges in order to perform these requests.

In most cases, you can reuse the response (in application/json format) of the read operation to provide that response as a request body for the edit requests.

Also, in most cases, setting a resource's property to null resets its value (like "tag" for example).

For changing the nested collections, you can use addOrUpdate and remove sections in the collections request, which contain id's of elements which have to be added/updated (removed) in (from) nested collections.

Each resource contains the "Examples" section on its documentation page, which provides more info on how to properly perform editing requests on that resource.

Filename restrictions

Uploading files below 20 MB

POST [CustomerURL]/uploads HTTP/1.1

POST [CustomerURL]/uploads HTTP/1.1
Content-Length: 244947
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...
api-version: 1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
Content-Type: multipart/form-data; boundary=----BoundaryzZaqkP0Sxn4p9XFF
Accept: */*
------BoundaryzZaqkP0Sxn4p9XFF
Content-Disposition: form-data; name="file1"; filename="Logo_flame.png"
Content-Type: image/png
[binary content]

{
	"token":"NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ=" 
}

Uploading files above 20 MB - in segments

POST [CustomerURL]/uploads/segments HTTP/1.1
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...
api-version: 1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
Accept: */*
Content-Type: application/json
{
	"filename":"photo.png",
}

{
	"uri":"/uploads/segments/NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ%3d"
}

POST [CustomerURL]/uploads/segments/NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ%3d?index=0 HTTP/1.1
Content-Length: 24947
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...
api-version: 1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
Content-Type: multipart/form-data; boundary=----BoundaryzZaqkP0Sxn4p9XFF
Accept: */*
------BoundaryzZaqkP0Sxn4p9XFF
Content-Disposition: form-data; name="segment0"; filename="Logo_flame.png.segment0"
Content-Type: image/png
[binary content]

POST [CustomerURL]/uploads/segments/NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ%3d/commit HTTP/1.1
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...
api-version: 1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
Accept: */*
Content-Type: application/json
{
	"filename":"photo.png",
	"segmentcount":"4"
}

{
	"token":"NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ=" 
}

DELETE [CustomerURL]/uploads/segments/NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ%3d HTTP/1.1
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...
api-version: 1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
Accept: */*

Uploading files directly to the blob storage

POST [CustomerURL]/uploads HTTP/1.1

POST /uploads HTTP/1.1
Authorization: Bearer eyJhbGciOiJIU...ebgDHSYc-dvI
api-version: 1
Content-Type: application/json

{
	"fileName" : "bigfile.psd"
}

{
	"token":"NzVmMDY5YTA4MGU1NDBhMDkyY2FmYzQ3YzQwMzNjMmQ=" 
}
                        

Cleaning the uploads

Basic search functionality is provided by the filter parameter that can be passed in requests to the top-level collection endpoints. See the Examples: Searching section for details.

For more complex search queries on records and classifications, the REST API provides the top-level /search endpoint.

POST /search/records HTTP/1.1

The body of the request is in the following format:

{
	"searchExpression":
	{
		"disabledKeywords": null,
		"supportWildcards": false,
		"defaultLogicalOperator": "AND",
		"languages": ["c2bd4f9bbb954bcb80c31e924c9c26dc"],
		"expression": "CreatedOn < 2015-09-29T12:24:22.287Z",
		"parameters": [],
		"namedParameters": {},
		"subExpressions": null
	},
	"facets": [
		{
			"name": "price",
			"type": "numericFieldRange",
			"fieldId": "b7a3a79f-f403-4af3-9f4c-a3cd0069b2c4",
			"rangeStart": 0,
			"rangeEnd": 1000,
			"spans": [1, 2]
		}
	],
	"logRequest": true
}

The result for the above query has the following structure:

{
	"facets": [
		{
			"name": "price",
			"values": [
				{
					"key": {
						"from": 0,
						"to": 1
					},
					"count": 645
				},
				{
					"key": {
						"from": 1,
						"to": 3
					},
					"count": 2945
				},
				...
			]
		}
	],
	"page": 1,
	"pageSize": 50,
	"totalCount": 38610,
	"items": [ ... ]
}

POST /search/classifications HTTP/1.1

The body of the request is in the following format:

{
    "searchExpression":
    {
        "disabledKeywords": null,
        "supportWildcards": false,
        "defaultLogicalOperator": "AND",
        "languages": ["c2bd4f9bbb954bcb80c31e924c9c26dc"],
        "expression": "NamePath = ?",
        "parameters": ["/Goods/Phones"],
        "namedParameters": {},
        "subExpressions": null
    },
    "logRequest": true
}

The result for the above query is similar to a regular classification search .

Some remarks:

• Due to the way search works, the TotalCount returned is an approximation and might not be the same as the amount of returned search results. The retrieved facet count is also an approximation.
• Facet values with a count of 0 are omitted from the reply, even if they are directly specified, e.g. as explicit values. If the consuming application needs to display facet values with a count of 0, it should keep track of them internally.
• The /search/classifications endpoint supports only searchExpression and logRequest parameters.

The search request has the following parameters:

Search expression parameters

Facets

All facets have these parameters in common:

The number of facets that can be returned per request is limited. The limit is 12 facets per request. If more than the allowed number of facets, is submitted in the request, the list of facets will be truncated. This means that the search engine will only include the first 12 facets from the list, and all others will be ignored. The list of ignored facet names are later on listed in the search response, in the property TruncatedFacets. See search response resource for more information on its properties.

The following facet types are supported:

• ClassificationFacet

  {
  	"name": "brand",
  	"type": "classification",
  	"facetRootId": "BCAEDD3B-DA09-4DED-817D-D92D335158AF",
  	"options": ["FacetRoot", "Children"],
  	"directLinkedOnly": true,
  	"maximumFacetValues": 20,
  	"filters": []
  }
  

  or

  {
  	"name": "brand",
  	"type": "classification",
  	"explicitValues": ["BCAEDD3B-DA09-4DED-817D-D92D335158AF", "20099504-462F-408F-A5F8-51CB140A7A43"],
  	"directLinkedOnly": true,
  	"filters": ["BCAEDD3B-DA09-4DED-817D-D92D335158AF"]
  }
  

  Parameter	Required	Description
  facetRootId	no	The classification Id used to determine which classifications will be faceted on, in combination with the options parameter. You must specify either explicitValues or facetRootId.
  options	no	These options specify how the facetRootId is used to determine which classifications are faceted on. This must be a combination of FacetRoot, Children, Descendants or All: FacetRoot: include the facet root classification as facet value. Children: include the facet root classifications children as facet values. Descendants: include all the facet root classifications descendants as facet values. All: include the facet root classification and all its descendants as facet values. Defaults to FacetRoot.
  directLinkedOnly	no	Determines if facet counts only take records into account that are directly linked to the facet classification, or also records that are linked to children or descendants of the facet classification.
  explicitValues	no	A list of Ids, when specified, only shows facets corresponding to the specified classifications. You must specify either explicitValues or classificationId.
  maximumFacetValues	no	Maximum number of facet values.

• ClassificationListFieldFacet

  {
  	"name": "region",
  	"type": "classificationListField",
  	"fieldId": "9336117A-047E-4C76-BCBC-0A4A7316F8A6",
  	"explicitValues": [
  		"42A9A761-D22B-4694-A196-618282B64957",
  		"9F4205FD-4977-488C-A8E4-6FB4D6B09AC5"
  	]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  explicitValues	no	A list of Ids. When specified, only shows facets corresponding to the specified classification items. If not specified, all classification items are included.
  maximumFacetValues	no	Maximum number of facet values returned.
  alwaysIncludeFiltersInFacetValues	no	Determines if the filters applied to this facet should always be part of the facet values. When maximumFacetValues is set and explicitValues is not and filters are applied, it is possible that the items being filtered on are not part of the facet values. If you want to prevent this from happening, set this property to True. Defaults to False.

• ContentTypeFacet

  {
  	"name": "Content Types",
  	"type": "contentType",
  	"rootContentType": "Image",
      "maximumFacetValues": 20,
      "directLinkedOnly": true
  }
  

  or

  {
  	"name": "Content Types",
  	"type": "contentType",
  	"explicitValues": [
  		"Image",
  		"Video"
  	]
  }
  

  Parameter	Required	Description
  explicitValues	no	A list of content type names. When specified, only shows facets corresponding to the specified content types. If not specified, all content types are included.
  maximumFacetValues	no	Maximum number of facet values returned.
  directLinkedOnly	no	Determines if facet counts only take records into account that are directly linked to the facet content type, or also records that are linked to child content types.
  rootContentType	no	Specify the content type to be used as the root. All child content types will be returned. The selected root content type will be included.

• CreatedByFacet

  {
  	"name": "creator",
  	"type": "createdBy",
  	"explicitValues": [ "BCAEDD3B-DA09-4DED-817D-D92D335158AF", "20099504-462F-408F-A5F8-51CB140A7A43" ],
  	"maximumFacetValues": 12,
  	"filters": [ "20099504-462F-408F-A5F8-51CB140A7A43" ]
  }
  

  Parameter	Required	Description
  explicitValues	no	A list of Ids. When specified, only shows facets corresponding to the specified users. When not specified, all users are taken into account.
  maximumFacetValues	no	Maximum number of facet values returned.

• CreatedOnFacet

  {
  	"name": "date of creation",
  	"type": "createdOn",
  	"rangeStart": "2014-05-15T10:41:19.51Z",
  	"rangeEnd": "2015-05-15T10:41:19.51Z",
  	"spans": [
  		{
  			"dateTimeUnit": "days",
  			"value": 7
  		},
  		{
  			"dateTimeUnit": "months",
  			"value": 1
  		}
  	],
  	"boundaries": ["Lower", "Upper"],
  	"filters": [
  		{
  			"rangeStart": "2014-05-01T10:41:19.51Z",
  			"rangeEnd": "2014-05-15T10:41:19.51Z"
  		},
  		{
  			"rangeStart": "2014-05-15T10:41:19.51Z",
  			"rangeEnd": "2014-05-31T10:41:19.51Z"
  		}
  	]
  }
  

  or

  {
  	"name": "date of creation",
  	"type": "createdOn",
  	"explicitRanges": [
  		{
  			rangeStart: "2014-05-01T10:41:19.51Z",
  			rangeEnd: "2014-05-15T10:41:19.51Z"
  		},
  		{
  			rangeStart: "2014-05-15T10:41:19.51Z",
  			rangeEnd: "2014-05-31T10:41:19.51Z"
  		}
  	],
  	"boundaries": ["Lower", "Upper"],
  	"filters": []
  }
  

  Parameter	Required	Description
  rangeStart	no	Start date and time of the range to take into account. Cannot be specified if explicitRanges is specified.
  rangeEnd	no	End date and time of the range to take into account. Cannot be specified if explicitRanges is specified.
  spans	no	Allows for the explicit specification of spans to divide the facet in. If the range specified is larger than the sum of all spans, the last span will be repeated to cover the entire range. Spans are objects that have a number property value, and a dateUnit that can be one of years, months, days, hours, minutes or seconds. Cannot be specified if explicitRanges is specified. If spans are specified, rangeStart and rangeEnd are mandatory.
  explicitRanges	no	Allows for the explicit specification of ranges to include in the facet. If explicitRanges are specified, you cannot specify rangeStart, rangeEnd or spans.
  boundaries	no	Specifies how to include hits that coincide with range or span boundaries. Can be a combination of Lower, Upper, All, Edge or None. Defaults to None.

• DateFieldRangeFacet

  {
  	"name": "productionDate",
  	"type": "dateFieldRange",
  	"fieldId": "E63E2645-BC54-4D64-AEE6-FC5458DB6AAE",
  	"rangeStart": "2014-05-15T00:00:00.00Z",
  	"rangeEnd": "2015-05-15T00:00:00.00Z",
  	"spans": [
  		{
  			"dateUnit": "days",
  			"value": 7
  		},
  		{
  			"dateUnit": "months",
  			"value": 1
  		}
  	],
  	"boundaries": ["Lower", "Upper"],
  	"filters": []
  }
  

  or

  {
  	"name": "productionDate",
  	"type": "dateFieldRange",
  	"fieldId": "53092CEF-A15C-42EE-AA89-369D9A0E1E1B",
  	"explicitRanges": [
  		{
  			"rangeStart": "2014-05-01T00:00:00.00Z",
  			"rangeEnd": "2014-05-15T00:00:00.00Z"
  		},
  		{
  			"rangeStart": "2014-05-15T00:00:00.00Z",
  			"rangeEnd": "2014-05-31T00:00:00.00Z"
  		}
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	],
  	"filters": [
  		{
  			"rangeStart": "2014-05-15T00:00:00.00Z",
  			"rangeEnd": "2014-05-31T00:00:00.00Z"
  		}
  	]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  rangeStart	no	Start date of the range to take into account. Cannot be specified if explicitRanges is specified.
  rangeEnd	no	End date of the range to take into account. Cannot be specified if explicitRanges is specified.
  spans	no	Allows for the explicit specification of spans to divide the facet in. If the range specified is larger than the sum of all spans, the last span will be repeated to cover the entire range. Spans are objects that have a number property value, and a dateUnit that can be one of years, months or days. Cannot be specified if explicitRanges is specified. If spans are specified, rangeStart and rangeEnd are mandatory.
  explicitRanges	no	Allows for the explicit specification of ranges to include in the facet. If explicitRanges are specified, you cannot specify rangeStart, rangeEnd or spans.
  boundaries	no	Specifies how to include hits that fall on range or span boundaries. Can be a combination of Lower, Upper, All, Edge or None. Defaults to None.

• DateTimeFieldRangeFacet

  {
  	"name": "productionDateTime",
  	"type": "dateTimeFieldRange",
  	"fieldId": "53092CEF-A15C-42EE-AA89-369D9A0E1E1B",
  	"rangeStart": "2014-05-15T10:41:19.51Z",
  	"rangeEnd": "2015-05-15T10:41:19.51Z",
  	"spans": [
  		{
  			"dateTimeUnit": "hours",
  			"value": 4
  		},
  		{
  			"dateTimeUnit": "days",
  			"value": 1
  		}
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	],
  	"filters": []
  }
  

  or

  {
  	"name": "productionDateTime",
  	"type": "dateTimeFieldRange",
  	"explicitRanges": [
  		{
  			"rangeStart": "2014-05-01T10:41:19.51Z",
  			"rangeEnd": "2014-05-15T10:41:19.51Z"
  		},
  		{
  			"rangeStart": "2014-05-15T10:41:19.51Z",
  			"rangeEnd": "2014-05-31T10:41:19.51Z"
  		}
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	],
  	"filters": []
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  rangeStart	no	Start date and time of the range to take into account. Cannot be specified if explicitRanges is specified.
  rangeEnd	no	End date and time of the range to take into account. Cannot be specified if explicitRanges is specified.
  spans	no	Allows for the explicit specification of spans to divide the facet in. If the range specified is larger than the sum of all spans, the last span will be repeated to cover the entire range. Spans are objects that have a number property value, and a dateTimeUnit that can be one of years, months, days, hours, minutes or seconds. Cannot be specified if explicitRanges is specified. If spans are specified, rangeStart and rangeEnd are mandatory.
  explicitRanges	no	Allows for the explicit specification of ranges to include in the facet. If explicitRanges are specified, you cannot specify rangeStart, rangeEnd or spans.
  boundaries	no	Specifies how to include hits that fall on range or span boundaries. Can be a combination of Lower, Upper, All, Edge or None. Defaults to None.

• FileTypeFacet

  {
  	"name": "type of file",
  	"type": "fileType",
  	"explicitValues": [
  		"BCAEDD3B-DA09-4DED-817D-D92D335158AF",
  		"20099504-462F-408F-A5F8-51CB140A7A43"
  	],
  	"maximumFacetValues": 9,
  	"filters": [
  		"20099504-462F-408F-A5F8-51CB140A7A43"
  	]
  }
  

  Parameter	Required	Description
  explicitValues	no	A list of Ids, when specified, only shows facets corresponding to the specified file types. When not specified, all file types are taken into account.
  maximumFacetValues	no	Maximum number of facet values returned.

• ModifiedByFacet

  {
  	"name": "modifier",
  	"type": "modifiedBy",
  	"explicitValues": [
  		"BCAEDD3B-DA09-4DED-817D-D92D335158AF",
  		"20099504-462F-408F-A5F8-51CB140A7A43"
  	],
  	"maximumFacetValues": 9,
  	"filters": [
  		"BCAEDD3B-DA09-4DED-817D-D92D335158AF"
  	]
  }
  

  Parameter	Required	Description
  explicitValues	no	A list of Ids. When specified, only shows facets corresponding to the specified users. When not specified, all users are taken into account.
  maximumFacetValues	no	Maximum number of facet values returned.

• ModifiedOnFacet

  {
  	"name": "date of modification",
  	"type": "modifiedOn",
  	"rangeStart": "2014-05-15T10:41:19.51Z",
  	"rangeEnd": "2015-05-15T10:41:19.51Z",
  	"spans": [
  		{
  			"dateTimeUnit": "days",
  			"value": 7
  		},
  		{
  			"dateTimeUnit": "months",
  			"value": 1
  		}
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	]
  }
  

  or

  {
  	"name": "date of modification",
  	"type": "modifiedOn",
  	"explicitRanges": [
  		{
  			"rangeStart": "2014-05-01T10:41:19.51Z",
  			"rangeEnd": "2014-05-15T10:41:19.51Z"
  		},
  		{
  			"rangeStart": "2014-05-15T10:41:19.51Z",
  			"rangeEnd": "2014-05-31T10:41:19.51Z"
  		}
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	]
  }
  

  Parameter	Required	Description
  rangeStart	no	Start date and time of the range to take into account. Can not be specified if explicitRanges is specified.
  rangeEnd	no	End date and time of the range to take into account. Can not be specified if explicitRanges is specified.
  spans	no	Allows for the explicit specification of spans to divide the facet in. If the range specified is larger than the sum of all spans, the last span will be repeated to cover the entire range. Spans are objects that have a number property value, and a dateUnit that can be one of years, months, days, hours, minutes or seconds. Can not be specified if explicitRanges is specified. If spans are specified, rangeStart and rangeEnd are mandatory.
  explicitRanges	no	Allows for the explicit specification of ranges to include in the facet. If explicitRanges are specified, you cannot specify rangeStart, rangeEnd or spans.
  boundaries	no	Specifies how to include hits that fall on range or span boundaries. Can be a combination of Lower, Upper, All, Edge or None. Defaults to None.

• NumericFieldFacet

  {
  	"name": "price",
  	"type": "numericField",
  	"fieldId": "EE85EBFD-E46E-44DF-AE44-90A6A4FEC9D7",
  	"explicitValues": [
  		10,
  		99.9,
  		12,
  		27
  	],
  	"maximumFacetValues": 9,
  	"filters": [
  		10,
  		12
  	]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  explicitValues	no	A list of Ids, when specified, only shows facets corresponding to the specified values. When not specified, all occurring values are returned.
  maximumFacetValues	no	Maximum number of facet values returned.

• NumericFieldRangeFacet

  {
  	"name": "priceRange",
  	"type": "numericFieldRange",
  	"fieldId": "53092CEF-A15C-42EE-AA89-369D9A0E1E1B",
  	"rangeStart": 100,
  	"rangeEnd": 999,
  	"spans": [
  		5,
  		5,
  		10
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	],
  	"filters": []
  }

  or

  {
  	"name": "priceRange",
  	"type": "numericFieldRange",
  	"fieldId": "53092CEF-A15C-42EE-AA89-369D9A0E1E1B",
  	"explicitRanges": [
  		{
  			"rangeStart": 5,
  			"rangeEnd": 25
  		},
  		{
  			"rangeStart": 26,
  			"rangeEnd": 50
  		}
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  rangeStart	no	Start of the range to take into account. Cannot be specified if explicitRanges is specified.
  rangeEnd	no	End of the range to take into account. Cannot be specified if explicitRanges is specified.
  spans	no	Allows for the explicit specification of spans to divide the facet in. If the range specified is larger than the sum of all spans, the last span will be repeated to cover the entire range. Cannot be specified if explicitRanges is specified. If spans are specified, rangeStart and rangeEnd are mandatory.
  explicitRanges	no	Allows for the explicit specification of ranges to include in the facet. If explicitRanges are specified, you cannot specify rangeStart, rangeEnd or spans.
  boundaries	no	Specifies how to include hits that fall on range or span boundaries. Can be a combination of Lower, Upper, All, Edge or None. Defaults to None.

• OptionListFieldFacet

  {
  	"name": "choice",
  	"type": "optionListField",
  	"fieldId": "40A5C3E5-518A-4368-823D-CD289723F78F",
  	"explicitValues": [
  		"BCAEDD3B-DA09-4DED-817D-D92D335158AF",
  		"20099504-462F-408F-A5F8-51CB140A7A43"
  	]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  explicitValues	no	A list of Ids. When specified, only shows facets corresponding to the specified option collection items. If not specified, all option collection items are included.
  maximumFacetValues	no	Maximum number of facet values returned.

• TextFieldFacet

  {
  	"name": "color",
  	"type": "textField",
  	"fieldId": "40A5C3E5-518A-4368-823D-CD289723F78F",
  	"explicitValues": [
  		"green",
  		"yellow",
  		"blue"
  	],
  	"caseSensitive": false,
  	"filters": [
  		"yellow"
  	]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  explicitValues	no	A list of strings. When specified, only returns facet values for these strings. If not specified, all occurring strings are returned.
  maximumFacetValues	no	Maximum number of facet values returned.
  caseSensitive	no	Whether or not strings that only differ in case are aggregated into the same facet.

• TextListFieldFacet

  {
  	"name": "status",
  	"type": "textListField",
  	"fieldId": "CDB72463-2056-4A2D-8903-54D7A1DBBBD0",
  	"explicitValues": [
  		"available",
  		"out of stock"
  	]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  explicitValues	no	A list of string values. When specified, only shows facets corresponding to the specified option collection items. If not specified, all option collection items are included.
  maximumFacetValues	no	Maximum number of facet values returned.
  alwaysIncludeFiltersInFacetValues	no	Determines if the filters applied to this facet should always be part of the facet values. When maximumFacetValues is set and explicitValues is not and filters are applied, it is possible that the items being filtered on are not part of the facet values. If you want to prevent this from happening, set this property to True. Defaults to False.

• TimeFieldRangeFacet

  {
  	"name": "productionTime",
  	"type": "timeFieldRange",
  	"fieldId": "53092CEF-A15C-42EE-AA89-369D9A0E1E1B",
  	"rangeStart": "10:41:19",
  	"rangeEnd": "18:41:19",
  	"spans": [
  		"00:15:00",
  		"00:30:00",
  		"01:00:00"
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	]
  }
  

  or

  {
  	"name": "productionTime",
  	"type": "timeFieldRange",
  	"fieldId": "53092CEF-A15C-42EE-AA89-369D9A0E1E1B",
  	"explicitRanges": [
  		{
  			"rangeStart": "10:41:00",
  			"rangeEnd": "14:40:59"
  		},
  		{
  			"rangeStart": "14:41:00",
  			"rangeEnd": "18:41:00"
  		}
  	],
  	"boundaries": [
  		"Lower",
  		"Upper"
  	]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  rangeStart	no	Start time of the range to take into account. Cannot be specified if explicitRanges is specified.
  rangeEnd	no	End time of the range to take into account. Cannot be specified if explicitRanges is specified.
  spans	no	Allows for the explicit specification of spans to divide the facet in. If the range specified is larger than the sum of all spans, the last span will be repeated to cover the entire range. Spans are also expressed as times. Cannot be specified if explicitRanges is specified. If spans are specified, rangeStart and rangeEnd are mandatory.
  explicitRanges	no	Allows for the explicit specification of ranges to include in the facet. If explicitRanges are specified, you cannot specify rangeStart, rangeEnd or spans.
  boundaries	no	Specifies how to include hits that fall on range or span boundaries. Can be a combination of Lower, Upper, All, Edge or None. Defaults to None.

• DateFieldRangeFilter

  {
      "name": "expirationDate",
      "type": "dateFieldRangeFilter",
      "fieldId": "835C1B53-AFD5-46E0-801F-02054A85DE22",
      "filters": []
  }
  

  or

  {
      "name": "expirationDate",
      "type": "dateFieldRangeFilter",
      "fieldId": "98C9974E-260C-4399-866C-AF330057B0A4",
      "filters": [
          {
              "rangeStart": "2022-08-24T00:00:00.00Z",
              "rangeEnd": "2022-08-29T00:00:00.00Z"
          }
      ]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  rangeStart	no	Start date of the range to take into account. If both rangeStart and rangeEnd are specified in the filters, it will contain all the items related to the search between the dates supplied. Otherwise, it will contain all the items related to the search.
  rangeEnd	no	End date of the range to take into account. If both rangeStart and rangeEnd are specified in the filters, it will contain all the items related to the search between the dates supplied. Otherwise, it will contain all the items related to the search.

• NumericFieldRangeFilter

  {
      "name": "Test Numeric",
      "type": "numericFieldRangeFilter",
      "fieldId": "b0a96b8a-243b-475e-ac2d-afaf009d81df",
      "filters": []
  }
  

  or

  {
      "name": "Test Numeric",
      "type": "numericFieldRangeFilter",
      "fieldId": "b0a96b8a-243b-475e-ac2d-afaf009d81df",
      "filters": [
          {
              "rangeStart": 1.5,
              "rangeEnd": 612.155
          }
      ]
  }
  

  Parameter	Required	Description
  fieldId	yes	The Id of the field this facet should operate on.
  rangeStart	no	Start value of the range to take into account. If both rangeStart and rangeEnd are specified in the filters, it will contain all the items related to the search between the numeric values supplied. Otherwise, it will contain all the items related to the search.
  rangeEnd	no	End value of the range to take into account. If both rangeStart and rangeEnd are specified in the filters, it will contain all the items related to the search between the numeric values supplied. Otherwise, it will contain all the items related to the search.

The REST API exposes Aprimo DAM's Enterprise Search support for record suggestions via the /search/records/suggestions endpoint. Issue a POST request with the following body:

POST /search/records/suggestions HTTP/1.1
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...
api-version: 1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
Accept: */*
Content-Type: application/json
{
	"input": "TRY",
	"languageids": [
		"c2bd4f9b-bb95-4bcb-80c3-1e924c9c26dc"
	],
	"fieldids": [
		"72de5be85e4b453e867ea3cd0069b0f4"
	],
	"fuzziness": 1,
	"numberOfSuggestions": 10
}

This suggestions request object contains the following properties:

The suggestions response contains a list of suggestions per input language:

[
	{
		"languageId": "c2bd4f9bbb954bcb80c31e924c9c26dc",
		"suggestions": [
			{
				"text": "TRYGG",
				"score": 17.31806755065918
			},
			{
				"text": "EKBY VALTER/ EKBY TRYGGVE",
				"score": 8.439911842346191
			}
		]
	}
]

Each suggestion contains the matched text and a score estimating how well the input was matched.

For diagnostic purposes, the REST API can perform and report some performance measurements, such as timing statistics of requests and some breakdown of these timings. This functionality is exposed via the /statistics endpoint.

NOTE that this a feature intended for support & debugging purposes only; it is subject to change and should not be used in normal operation of the API. Not all detailed output will be meaningful without internal knowledge of the REST API.

Toggling statistics gathering

Enabling or disabling the collection of statistics can be done via a PUT to the statistics endpoint. By default the gathering of statistics is disabled.

PUT /statistics HTTP/1.1
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...
api-version: 1
Authorization: Token Y2ZkZDdjZTc2NDdmNDBlOWE5NDI2ZDhjNjY2MDRhMTU6QURBTU5FVA==
Accept: */*
Content-Type: application/json
{
	"enabled": "true"
}

Retrieving statistics

To retrieve the gathered statistics, perform a HTTP GET request to the /statistics endpoint. Statistics are structured as a call tree, aggregated at the top level per request type:

{
	"get classification/{classificationId}": {
		"identifier": "get classification/{classificationId}",
		"children":{
			"classificationByIdQuery":{
				"identifier": "ClassificationByIdQuery",
				"children": null,
				"occurences": 1,
				"minDuration": 955,
				"maxDuration": 955,
				"average": 955
			},
			"mappingRequest<Classification, ClassificationResource>":{
				"identifier": "MappingRequest<Classification, ClassificationResource>",
				"children":{"classificationChildrenByParentIdQuery":{
					"identifier": "ClassificationChildrenByParentIdQuery",
					"children": null,
					"occurences": 1,
					...
				},
				"occurences": 1,
				"minDuration": 158,
				"maxDuration": 158,
				"average": 158
			}
		},
		"occurences": 1,
		"minDuration": 1293,
		"maxDuration": 1293,
		"average": 1293
	}
}

Clearing statistics

Clearing the running statistics is also possible, by performing a HTTP DELETE on the /statistics endpoint.

Enterprise Search

• Reading the search index state
• Rebuilding the search index