Macro admin API Resource

Abstract class for REST webservices

POST /api/admin/macro

Add macro to database

Request Body
media type data type description
application/json HdcMacroInputTO (JSON)

Example of request:

{"macroName":"55","perspectiveSetId":"9","targetClassId":"104","targetFieldName":"fi2prop_id"}
Response Body
media type data type description
application/json HdcSuccessWithIds (JSON) JSON Response with the specified object properties. Properties are in format {propertyName, "fieldName":propertyName}.

Example of response:

{"list":[{"id":1,"macroName":"55","perspectiveSetId":9,"targetClassId":104,"targetFieldName":"fi2prop_id"}],"success":true}

Example

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

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

                
{ }

DELETE /api/admin/macro/{macroId}

Delete macro from database

Request Parameters
name type description constraints
macroId path of macro to be deleted long
Response Body
media type data type description
application/json HdcSuccessTO (JSON) success: true/false

Example

Request
DELETE /api/admin/macro/{macroId}
Content-Type: */*
Accept: application/json

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

                
{ }

PUT /api/admin/macro/{macroId}

update macro in database

Request Parameters
name type description constraints
macroId path of macro to be updated long
Request Body
media type data type description
application/json HdcMacroTO (JSON)

Example of request:

{"id":1,"macroName":"55","perspectiveSetId":"9","targetClassId":"104","targetFieldName":"fi2prop_id"} *
Response Body
media type data type description
application/json HdcSuccessTO (JSON) success: true/false

Example

Request
PUT /api/admin/macro/{macroId}
Content-Type: application/json
Accept: application/json

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

                
{ }