Defining the parameters for a search operation and a result list

If, for example, you want to provide your users with a predefined search operation or result list, you can specify a variety of parameters. Usually, the full-text search in a d.3 repository is not specific enough. Therefore, you can restrict the search query by using query parameters.

You must encode the URL parameters (e.g. spaces in %20). The length of the encoded query parameter is limited to 2000 characters.

Parameter

Description

objectdefinitionids

Sets the categories used for searching items. You can define at least one category. Specify the ID of a category. If this value is not specified, the search is done across all categories in a d.3 repository.

Examples (not encoded):

  • objectdefinitionids=["RECH"]: for performing a search across the category "Invoice" ("RECH").

  • objectdefinitionids=["RECH","AUFT"]: for performing a search across the categories "Invoice" ("RECH") and "Orders" ("AUFT").

fulltext

Specifies a full-text keyword.

properties

Specifies the search restriction based on the properties of documents and dossiers. You can use the following criteria to restrict a search operation:

  • Document ID: property_document_id

  • File type: property_filetype

  • Document number: property_document_number

  • Document status: property_state (Allowed values are Be for Processing (Bearbeitung), Pr for Verification (Prüfung), Fr for Release (Freigabe) and Ar for the status Archive (Archiv).

  • Editor: property_editor (d.3 user ID)

  • File name: property_filename

  • Import date: property_creation_date

  • File size: property_size (when searching for the file size, the size must be specified in bytes and as an integer. A search within a specific range can be done using the separator pipe and minus character (|-): Search for documents whose document file is smaller than or equal to 1024 bytes with the expression {"property_size":["|-1024"]}.

  • Last modified: property_last_modified_date

  • Last file update: property_last_alteration_date

  • Access date: property_access_date

  • Comment: property_remark

  • Color marking: property_colorcode (is an integer value between 1 and 24 that correspond to the number of the color code you want to assign).

  • Variant number: property_variant_number

You can define at least one value for each property.

Examples (not encoded):

  • properties={"property_filetype":["docx"]}: for searching the file type "docx".

  • properties={"property_filetype":["docx","pdf"]}: for searching for items with the file type "docx" or "pdf".

Restriction in relation to the definition of a search operation: You can also define multiple values for a parameter, provided that facets have been configured for the corresponding property. If no facets for viewing have been configured for the property, the last value is always adopted for the search operation.

You can also limit the result list and search operation based on an advanced property. The ID of the property corresponds to the ID (RID) of a property that you can determine for each advanced property in d.3 admin. For additional information about the ID of a property (RID) see the manual about d.3 admin (d3admin_eng.pdf).

Examples (not encoded):

  • properties={"227":["KND001"]}: for searching for items which have the advanced property with the ID "227" and this property has the value "KND001".

  • properties={"227":["KND001","KND002"]}: for searching for items which have the advanced property with the ID "227" and this property has the value "KND001" or "KND002".

You can also use several properties as search restrictions simultaneously.

Examples (not encoded):

  • properties={"227":["KND001"],"231":["|-100"]}: for searching for items with the customer number (advanced property with the ID "227") "KND001" and an invoice amount (advanced property with the ID "231") lower than or equal to 100.

  • properties={"227":["KND001"],"property_filetype":["pdf"]}: for searching for items with the customer number (advanced property with the ID "227") "KND001" and the file type “pdf”.

Note

Specific values for the properties parameter related to the various options for restricting the result in a targeted way:

  1. Search for a numeric value or a money value:

    Specify the value without using a thousand separator. The decimal separator is the period (.). Example: For the value 1,000.20 EUR specify 1000.20.

  2. Search for a date and time:

    Specify the date in the format YYYY-MM-DD. Example: Enter 2014-12-05 for the date 12/05/2014 (MM/DD/YYYY).

    Time is specified in the format YYYY-MM-DDTHH:mm:ss+01:00. You must encode the plus character (+) with %2b. Example: 2015-02-18T23:59:59%2b01:00 for 02/18/2015 at 11:59 p.m. and 59 seconds in the time zone UTC+1 for standard time in Germany.

  3. Search for items that are located in a specific range:

    To search in a range, use a combination of the pipe and minus character (|-) as separators. Examples for a numeric field with the ID "231":

  • Values greater than or equal to 100:  {"231":["100|-"]}

  • Values smaller than or equal to 100: {"231":["|-100"]}

  • Values between 100 and 200: {"231":["100|-200"]}