Util admin API Resource

Abstract class for REST webservices

POST /api/admin/eventplugins

Add plugin configuration.

Example of request:

{"classId":105,"classLabel":"Building","fieldName":"hd_objcustom2","fieldLabel":"Area (BRA)","pluginName":"CalculatedFieldResolver","configuration":"{\"childClassId\": \"107\", \"childFieldName\": \"hd_objcustom1\", \"perspectiveSetId\":\"8\"}","sequence":1}

Request Body
media type data type description
application/json HdcEventPluginConfigTO (JSON) The specification of plugin's configuration that has to be added.
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON with information, whether the adding has or has not been succeeded.

Example

Request
POST /api/admin/eventplugins
Content-Type: application/json
Accept: application/json

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

                
{ }

PUT /api/admin/eventplugins

Update plugin configuration.

Example of request:

{"classId":105,"classLabel":"Building","fieldName":"hd_objcustom2","fieldLabel":"Area (BRA)","pluginName":"CalculatedFieldResolver","configuration":"{\"childClassId\": \"107\", \"childFieldName\": \"hd_objcustom1\", \"perspectiveSetId\":\"8\"}","sequence":1}

Request Body
media type data type description
application/json HdcEventPluginConfigTO (JSON) The specification of plugin's configuration that has to be updated.
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON with information, whether the updating has or has not been succeeded.

Example

Request
PUT /api/admin/eventplugins
Content-Type: application/json
Accept: application/json

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

                
{ }

POST /api/admin/fielddefaults

Request Body
media type data type
application/json FieldDefaultObjectModel (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON)

Example

Request
POST /api/admin/fielddefaults
Content-Type: application/json
Accept: application/json

                
{
  "classId" : 12345,
  "fieldLabel" : "...",
  "defaultValue" : "...",
  "classLabel" : "...",
  "fieldName" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

PUT /api/admin/eventplugins/availability

Set plugin's availability for events

Example of request:

[{"name":"AutoSumResolver","isRunForEvents":false,"applyFieldRules":true},{"name":"MathBasicOperationResolver","isRunForEvents":false,"applyFieldRules":true},{"name":"TextCompounderResolver","isRunForEvents":false,"applyFieldRules":false}]

Request Body
media type data type
application/json array of PluginDescription (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON with information, whether the switching availability for event has or has not been succeeded.

Example

Request
PUT /api/admin/eventplugins/availability
Content-Type: application/json
Accept: application/json

                
[ {
  "runForEvents" : true,
  "name" : "...",
  "applyFieldRules" : true,
  "events" : [ "...", "..." ]
} ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /api/admin/eventplugins/json

Information on whether and at what events the plugin is launched.

Response Body
media type data type description
application/json object (JSON) JSON with list of available plugins

Example of response:

{"list":{"CalculatedFieldResolver":{"events":["ObjectModified"],"isRunForEvents":false},"CustomFieldResolver":{"events":["ObjectModified"],"isRunForEvents":true}}}

Example

Request
GET /api/admin/eventplugins/json
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/fielddefaults/json

Response Body
media type data type description
application/json object (JSON)

Example

Request
GET /api/admin/fielddefaults/json
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/eventplugins/config/json

Get plugins configuration.

Response Body
media type data type description
application/json object (JSON)

Example

Request
GET /api/admin/eventplugins/config/json
Content-Type: */*
Accept: application/json

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

                
...

DELETE /api/admin/eventplugins/{classId}/{fieldName}

Delete plugin configuration.

Request Parameters
name type description constraints
classId path ID of class long
fieldName path name of field  
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON with information, whether the deleting has or has not been succeeded.

Example

Request
DELETE /api/admin/eventplugins/{classId}/{fieldName}
Content-Type: application/json
Accept: application/json

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

                
{ }

DELETE /api/admin/fielddefaults/{classId}/{fieldName}

Request Parameters
name type description constraints
classId path long
fieldName path  
Response Body
media type data type description
application/json HdcSuccessTO (JSON)

Example

Request
DELETE /api/admin/fielddefaults/{classId}/{fieldName}
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/util/clearcaches/json

Clear all HDC caches

Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the clearing has or has not been succeeded.

Example

Request
GET /api/admin/util/clearcaches/json
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/admin/util/clearhopacache/json

Clear HOPA cache

Response Body
media type data type description
application/json object (JSON) JSON Response with information, whether the clearing has or has not been succeeded.

Example

Request
GET /api/admin/util/clearhopacache/json
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/util/longrunning/json

Get list of currently running processes.

Response Body
media type data type description
application/json array of HdcProcessStateTO (JSON) JSON with list running processes

Example of response:

{"list":[{"processId":"5fed573b-9fcc-48fe-87c9-31a01961f2fe","state":"ErrorInProgress","userName":"Admin","startDate":"Wed Mar 11 11:42:44 CET 2015","operationType":"TdxmImport"}]}

Example

Request
GET /api/admin/util/longrunning/json
Content-Type: */*
Accept: application/json

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

                
[ { } ]

POST /api/admin/util/scheduledtask/{systemTaskId}

Runs in background scheduled system task of given Id.

Request Parameters
name type description constraints
systemTaskId path systemTaskId int
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON with info whether system task started successfully

Example

Request
POST /api/admin/util/scheduledtask/{systemTaskId}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/admin/util/scheduledtasks/json

Get scheduled tasks

Response Body
media type data type description
application/json object (JSON) JSON response with list of scheduled tasks

Example of response:

[{"systemTaskId":1,"taskName":"License Validation","system":true,"lastExecution":"2019-11-19T11:40:24.602770Z","nextExecution":"2019-11-20T12:40:24.519151185+01:00","periodic":true,"processState":"1"},{"systemTaskId":2,"taskName":"Auto Delete Import Packages","system":true,"lastExecution":"2019-11-19T07:41:12.868719Z","nextExecution":"2019-11-20T01:00+01:00","periodic":true,"processState":"1"}]

Example

Request
GET /api/admin/util/scheduledtasks/json
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/util/longrunning/json/{processId}

Inspect desired long-running process.

Request Parameters
name type description
processId path Id of long-running process
Response Body
media type data type description
application/json HdcProcessStateTO (JSON) JSON with info on requested process

Example of response:

{"stage":"GettingPackageForDb","gettingPackageForDbParams":{},"processId":"5fed573b-9fcc-48fe-87c9-31a01961f2fe","state":"ErrorInProgress","userName":"Admin","startDate":"Wed Mar 11 11:42:44 CET 2015","endDate":"Wed Mar 11 11:42:48 CET 2015","operationType":"TdxmImport"}

Example

Request
GET /api/admin/util/longrunning/json/{processId}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/admin/util/longrunning/result/{processId}

Request Parameters
name type description
processId path
Response Body
media type data type description
application/json object (JSON)
application/pdf object
application/zip object
image/* object

Example

Request
GET /api/admin/util/longrunning/result/{processId}
Content-Type: */*
Accept: application/json

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

                
...

POST /api/admin/util/longrunning/result/{processId}

Request Parameters
name type description
processId path
Response Body
media type data type description
application/json object (JSON)

Example

Request
POST /api/admin/util/longrunning/result/{processId}
Content-Type: */*
Accept: application/json

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

                
...

GET /api/admin/util/longrunning/result/json/{processId}

Request Parameters
name type description
processId path
Response Body
media type data type description
application/json object (JSON)
application/pdf object
application/zip object
image/* object

Example

Request
GET /api/admin/util/longrunning/result/json/{processId}
Content-Type: */*
Accept: application/json

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

                
...