/
[GET] /name

[GET] /name

Owned by Team Dodo
Last updated: Apr 01, 2025 by Technische Redaktion
1 min read

n /api/dms/objects/{objectId}/native/name

Description

Returns a name for the object based on a hit list configuration and the index data. There are three kinds of hit list configuration:

  • EMAILFIELDS

  • FIELDS

  • WINDOWTITELFIELDS

In enaio® client or enaio® webclient a user can configure the hit list for each object type. The hit list configuration should be applied when sending the object via mail (EMAILFIELDS), when displaying it in the client (FIELDS) and for the enaio® client application window title (WINDOWTITELFIELDS). One of this constants can be send within the request to use a specific configuration for generating the name. If no configuration is send within the request the constant FIELDS is used by default. Additional the ACCEPT_LANGUAGE can be send within the request to format date values in a certain format.

Request
Method

GET

Request optional
Query Parameter

  • objectTypeId (Integer): For performance reasons the objectTypeId of the object can be provided.

  • hitListConfigType (String): One of the constant strings EMAILFIELDS, FIELDS, WINDOWTITELFIELDS.

Request Header

  • Accept-Language
    Set the locale for formatting date and datetime fields. Example: Accept-Language: en-GB

Response
Format

JSON

Minimum Version

5.4.0

Request
Example

/api/dms/objects/11882/native/name
/api/dms/objects/11882/native/name?objectTypeId=262208&hitListConfigType=EMAILFIELDS

Result
Example

{ "objects": [{ "properties": { "system:objectId": { "value": "11816" }, "system:objectTypeId": { "value": "26" }, "Name": { "value": "11-09-2019 14.02.34 - info@optimal-systems.de - MyFieldValue" }  } }], "numItems": 1, "hasMoreItems": false, "totalNumItems": 1 }

 

Related content