Search API Resource

REST Web Services for supporting various search operations.

GET /api/search/content

Request Parameters
name type description constraints
includePath query boolean
parentClassId query long
parentObjectId query long
query query  
Response Body
media type data type description
application/json object (JSON)

Example

Request
GET /api/search/content
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/search/quick

Perform quick search basing on defined configuration. If perspectiveId parameter is provided then quick search will be performed only on configured classes which are also part of given perspective set definition.

Request Parameters
name type description constraints
perspectiveId query perspective set identifier long
query query query string  
Response Body
media type data type description
application/json object (JSON) json with list of objects fulfilling search criteria

Example

Request
GET /api/search/quick
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/audit/activity/json

Get list of administrative operations.

Request Parameters
name type description constraints
filter query  
limit query long
sortField query  
start query long
Response Body
media type data type description
application/json object (JSON) JSON with list of administrative operations.

Example of response:

{"total":1,"list":[{"invokerId":1,"userId":10,"activityType":3,"name":"stonoga3","userFullName":"stonoga3","email":"stonoga3@abc.pl","activityTexts":["stonoga3","stonoga3x"],"activityIdentifiers":[],"invokerName":"admin","invokerFullName":"Administrator","invokerEmail":"dada@abc.pl","operationDate":"2020-03-04T15:46:28.860286Z"}]}

Example

Request
GET /api/audit/activity/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/audit/objects/json

Get list of object operations.

Request Parameters
name type description constraints
filter query  
limit query long
sortField query  
start query long
Response Body
media type data type description
application/json object (JSON) JSON with list of administrative operations.

Example of response:

{"total":1,"list":[{"invokerId":1,"userId":10,"activityType":3,"name":"stonoga3","userFullName":"stonoga3","email":"stonoga3@abc.pl","activityTexts":["stonoga3","stonoga3x"],"activityIdentifiers":[],"invokerName":"admin","invokerFullName":"Administrator","invokerEmail":"dada@abc.pl","operationDate":"2020-03-04T15:46:28.860286Z"}]}

Example

Request
GET /api/audit/objects/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/search/advanced/query

Get advanced search queries for user - owned and shared

Response Body
media type data type description
application/json object (JSON) JSON response with advanced search queries

Example of response:

[{"id":8,"classId":111,"classLabel":"Document","name":"All Docs (empty hql)","ownerId":1113,"ownerFullName":"John Bob","shared":false},{"id":9,"classId":108,"classLabel":"Rum","name":"Room area BRA > 20","hql":"fi2space_areabra > 20","ownerId":11,"ownerFullName":"John Smith","shared":true}]

Example

Request
GET /api/search/advanced/query
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/search/advanced/query

Add advanced search query

Example of request:

{"classId":"108","classLabel":"Rum","hql":"fi2space_class in (\"01\",\"ÖVA\",\"02\")","name":"Rum LOA or ÖVA", "parents": [{"objectId":"100", "classId":100}}

Request Body
media type data type
application/json SavedSearchQuery (JSON)
Response Body
media type data type description
application/json HdcSuccessWithId (JSON) JSON Response with information if creation was successful or not

Example

Request
POST /api/search/advanced/query
Content-Type: application/json
Accept: application/json

                
{
  "ownerId" : 12345,
  "hql" : "...",
  "ownerFullName" : "...",
  "name" : "...",
  "id" : 12345,
  "parents" : [ { }, { } ],
  "shared" : true,
  "parentsAsString" : "...",
  "classId" : 12345,
  "classLabel" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

GET /api/search/objects/{childClassId}

Get objects of specified class which fulfill specified fields filtering criteria

Request Parameters
name type description constraints
childClassId path object class identifier long
limit query used in paging, defines the number of objects returned in a single call long
offset query used in paging, defines the offset for positions long
sortField query used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])  
Response Body
media type data type description
application/json object (JSON) json with collection of objects of specified class which fullfil filtering criteria

Example

Request
GET /api/search/objects/{childClassId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/search/advanced/members/{queryId}

Get shared users/groups for advanced search query

Request Parameters
name type description constraints
queryId path id of advanced search query long
mode query Values can be users or groups  
Response Body
media type data type description
application/json object (JSON) JSON response with advanced search queries

Example of response:

{"list":[{"id":7129,"name":"user123","userFullName":"user123","enabled":false,"email":"user123@tessel.pl"}]}

Example

Request
GET /api/search/advanced/members/{queryId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/search/advanced/objects/{childClassId}

Get objects of specified class in json/binary format which fulfill criteria specified in HQL

Example of request (json payload):

{"hqlCriteria":"hd_objcustom2 starts-with \"TEST\" and fi2space_areanta > 0.1"}

Please note that providing outputTemplateType param starts generating binary report in background

Request Parameters
name type description constraints
childClassId path object class identifier long
includePath query boolean
limit query used in paging, defines the number of objects returned in a single call long
offset query used in paging, defines the offset for positions long
outputTemplateType query type of response destination output format  
rootClassId query object class identifier of root object long
rootObjectId query object identifier of root object long
sortField query used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])  
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json object (JSON) json with collection of objects of specified class which fullfil filtering criteria or information about started background process

Example

Request
POST /api/search/advanced/objects/{childClassId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /api/search/advanced/query/{queryId}

Delete advanced search query

Request Parameters
name type description constraints
queryId path id of query to be deleted long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information if delete was successful or not

Example

Request
DELETE /api/search/advanced/query/{queryId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

POST /api/search/advanced/share/{queryId}

Share advanced search query with users or/and groups

Example of request:

{"list":[{"id":"userId"}]} or {"list":[{"id":"groupId"}]}

Request Parameters
name type description constraints
queryId path id of query to be unshared long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON response with information if sharing was successful or not

Example

Request
POST /api/search/advanced/share/{queryId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

POST /api/search/advanced/unshare/{queryId}

Unshare advanced search query with users or/and groups

Example of request:

{"list":[{"id":"userId"}]} or {"list":[{"id":"groupId"}]}

Request Parameters
name type description constraints
queryId path id of query to be unshared long
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON response with information if unsharing was successful or not

Example

Request
POST /api/search/advanced/unshare/{queryId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

GET /api/search/flex/statistics/{classId}

Get facets statistics for a flex search, for specified object class.

Request Parameters
name type description constraints
classId path object class identifier long
Response Body
media type data type description
application/json object (JSON) json with collection of facets statistics for a flex search fields

Example

Request
GET /api/search/flex/statistics/{classId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/search/quick/classes/add

Add object class to quick search configuration.

Example of request:

{"list":[{"id":"11"},{"id":"12"}]}

Request Body
media type data type description
application/json string (JSON) id's of classes to be added to quick search configuration
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/search/quick/classes/add
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /api/search/quick/classes/json

Get list of object classes to be used with quick search.

Response Body
media type data type description
application/json object (JSON) json with list of object classes to be used with quick search

Example

Request
GET /api/search/quick/classes/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/search/quick/classes/remove

Remove object class to quick search configuration.

Example of request:

{"list":[{"id":"12"}]}

Request Body
media type data type description
application/json string (JSON) id's of classes to be removed from quick search configuration
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/search/quick/classes/remove
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /api/audit/activity/details/{userId}/{date}

Get list of login specific data.

Request Parameters
name type description constraints
date path - date time of specific activity  
userId path - id of user who performed specific activity long
Response Body
media type data type description
application/json object (JSON) JSON with login specific information that the requested activity occurred during.

Example of response:

{"geoIp":"{\"ip\":\"127.0.0.1\",\"country_code\":\"\",\"country_name\":\"\",\"region_code\":\"\",\"region_name\":\"\",\"city\":\"\",\"zip_code\":\"\",\"time_zone\":\"\",\"latitude\":0.0,\"longitude\":0.0,\"metro_code\":0}","userAgent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.132 Safari/537.36","ip":"127.0.0.1","date":"2020-03-17T11:18:27.411185Z","userId":100}

Example

Request
GET /api/audit/activity/details/{userId}/{date}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /api/audit/object/json/{classId}/{hdid}

Request Parameters
name type description constraints
classId path long
hdid path long
limit query long
sortField query  
start query long
Response Body
media type data type description
application/json object (JSON)

Example

Request
GET /api/audit/object/json/{classId}/{hdid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/search/byguid/advanced/objects/{childClassId}

Get objects of specified class in json/binary format which fulfill criteria specified in HQL

Example of request (json payload):

{"hqlCriteria":"hd_objcustom2 starts-with \"TEST\" and fi2space_areanta > 0.1"}

Please note that providing outputTemplateType param starts generating binary report in background

Request Parameters
name type description constraints
childClassId path object class identifier long
includePath query boolean
limit query used in paging, defines the number of objects returned in a single call long
offset query used in paging, defines the offset for positions long
outputTemplateType query type of response destination output format  
rootSystemGuid query the unique UUID identifier of root object.  
sortField query used as a sorting base of the returned objects package, consists of field name and sorting directions: 'asc' or 'desc' (format: sortField=[{"property":"hd_docdescr","direction":"ASC"}])  
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcPathProcessStateTO (JSON) json with collection of objects of specified class which fullfil filtering criteria or information about started background process

Example

Request
POST /api/search/byguid/advanced/objects/{childClassId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

POST /api/search/quick/fields/add/{classId}

Add fields of specified object class to quick search configuration. Only text fields are possible to use.

Example of request:

{"list":[{fieldName":"hd_objcustom4"}]}

Request Parameters
name type description constraints
classId path object class identifier long
Request Body
media type data type description
application/json string (JSON) names of fields to be added to quick search configuration
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/search/quick/fields/add/{classId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /api/search/quick/fields/json/{classId}

Get list of fields to be used with quick search with specified object class.

Request Parameters
name type description constraints
classId path object class identifier long
Response Body
media type data type description
application/json object (JSON) json with list of fields to be used with quick search with specified object class

Example

Request
GET /api/search/quick/fields/json/{classId}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /api/search/quick/fields/remove/{classId}

Remove fields of specified object class from quick search configuration.

Example of request:

{"list":[{fieldName":"hd_objcustom4"}]}

Request Parameters
name type description constraints
classId path object class identifier long
Request Body
media type data type description
application/json string (JSON) names of fields to be removed from quick search configuration
Response Body
media type data type description
application/json object (JSON) JSON with information whether request was successful

Example

Request
POST /api/search/quick/fields/remove/{classId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...