Object Security API Resource

Rest services for detailed object security assignments

DELETE /api/admin/security/objects

Remove security scheme from given objects

Request Body
media type data type description
application/json array of UpsertObjRequest (JSON) Array with destination objects
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON response with information if security scheme removal was successful or not

Example

Request
DELETE /api/admin/security/objects
Content-Type: application/json
Accept: application/json

                
[ {
  "systemGuidSourceId" : 12345,
  "systemGuid" : "...",
  "parentObjectId" : 12345,
  "objectId" : 12345,
  "parentClassId" : 12345,
  "tempGuid" : "...",
  "classId" : 12345,
  "params" : {
    "property1" : { },
    "property2" : { }
  },
  "addInStrictMode" : true
} ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

PUT /api/admin/security/objects/{securitySchemeId}

Assign security scheme for given objects

Request Parameters
name type description constraints
securitySchemeId path security scheme id long
Request Body
media type data type description
application/json array of UpsertObjRequest (JSON) Array with destination objects
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON response with information if security scheme assign was successful or not

Example

Request
PUT /api/admin/security/objects/{securitySchemeId}
Content-Type: application/json
Accept: application/json

                
[ {
  "systemGuidSourceId" : 12345,
  "systemGuid" : "...",
  "parentObjectId" : 12345,
  "objectId" : 12345,
  "parentClassId" : 12345,
  "tempGuid" : "...",
  "classId" : 12345,
  "params" : {
    "property1" : { },
    "property2" : { }
  },
  "addInStrictMode" : true
} ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

DELETE /api/admin/security/object/{classId}/{objectId}

Set security scheme for given object inclusion

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

Example

Request
DELETE /api/admin/security/object/{classId}/{objectId}
Content-Type: */*
Accept: application/json

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

                
{ }

DELETE /api/admin/security/objects/tree/{perspectiveId}

Remove security scheme from given objects trees in given perspective inclusion

Request Parameters
name type description constraints
perspectiveId path perspective id long
Request Body
media type data type description
application/json array of UpsertObjRequest (JSON) Array with destination objects
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON response with information if security scheme removal was successful or not

Example

Request
DELETE /api/admin/security/objects/tree/{perspectiveId}
Content-Type: application/json
Accept: application/json

                
[ {
  "systemGuidSourceId" : 12345,
  "systemGuid" : "...",
  "parentObjectId" : 12345,
  "objectId" : 12345,
  "parentClassId" : 12345,
  "tempGuid" : "...",
  "classId" : 12345,
  "params" : {
    "property1" : { },
    "property2" : { }
  },
  "addInStrictMode" : true
} ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /api/admin/security/perspective/json/{perspectiveId}

Get unrestricted (t.m. omitting view right) hierarchy in the given perspective - using configured root object. Additional security scheme id information will be attached for each returned object.

Request Parameters
name type description constraints
perspectiveId path The unique identifier of perspective. long
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children of the root object in the given perspective.

Example of response:

{"children":[{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7101 XXX 2","objectId":"90","classId":"11", "securityMask":"3", securitySchemeId: "1"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7102 - Bottenstocken 13","objectId":"91","classId":"11", "securityMask":"3", securitySchemeId: "1"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7103 - Bygeln 1","objectId":"92","classId":"11", "securityMask":"3", securitySchemeId: "1"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7104 - Bygeln 5bb","objectId":"93","classId":"11", "securityMask":"3", securitySchemeId: "1"}],"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"Root","objectId":"0","classId":"10", "securityMask":"3", securitySchemeId: "1"}

Example

Request
GET /api/admin/security/perspective/json/{perspectiveId}
Content-Type: */*
Accept: application/json

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

                
...

PUT /api/admin/security/object/{classId}/{objectId}/{securitySchemeId}

Set security scheme for given object inclusion

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

Example

Request
PUT /api/admin/security/object/{classId}/{objectId}/{securitySchemeId}
Content-Type: */*
Accept: application/json

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

                
{ }

PUT /api/admin/security/objects/tree/{perspectiveId}/{securitySchemeId}

Assign security scheme for given objects trees in given perspective inclusion

Request Parameters
name type description constraints
perspectiveId path perspective id long
securitySchemeId path security scheme id long
Request Body
media type data type description
application/json array of UpsertObjRequest (JSON) Array with destination objects
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON response with information if security scheme assign was successful or not

Example

Request
PUT /api/admin/security/objects/tree/{perspectiveId}/{securitySchemeId}
Content-Type: application/json
Accept: application/json

                
[ {
  "systemGuidSourceId" : 12345,
  "systemGuid" : "...",
  "parentObjectId" : 12345,
  "objectId" : 12345,
  "parentClassId" : 12345,
  "tempGuid" : "...",
  "classId" : 12345,
  "params" : {
    "property1" : { },
    "property2" : { }
  },
  "addInStrictMode" : true
} ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

DELETE /api/admin/security/object/tree/{perspectiveId}/{classId}/{objectId}

Set security scheme for given object tree in given perspective inclusion

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

Example

Request
DELETE /api/admin/security/object/tree/{perspectiveId}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

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

                
{ }

GET /api/admin/security/perspective/json/{perspectiveId}/{classId}/{objectId}

Get unrestricted (t.m. omitting view right) hierarchy of the specified object with the given class in the given perspective. Additional security scheme id information will be attached for each returned object.

Request Parameters
name type description constraints
classId path The unique identifier of object class. long
objectId path The unique identifier of object. long
perspectiveId path The unique identifier of perspective. long
childClassId query long
Response Body
media type data type description
application/json object (JSON) JSON Response with the list of children of the specified object in the given perspective.

Example of response:

{"children":[{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"1","objectId":"325","classId":"12", "securityMask":"3", securitySchemeId: "1"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"2","objectId":"327","classId":"12", "securityMask":"3", securitySchemeId: "1"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"3","objectId":"192","classId":"12", "securityMask":"3", securitySchemeId: "1"},{"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"4","objectId":"158712","classId":"12", "securityMask":"3", securitySchemeId: "1"}],"hasChildren":true,"metadata":{},"contentType":0,"contentId":0,"objectName":"7102 XXX 2","objectId":"90","classId":"11", "securityMask":"3", securitySchemeId: "1"}

Example

Request
GET /api/admin/security/perspective/json/{perspectiveId}/{classId}/{objectId}
Content-Type: */*
Accept: application/json

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

                
...

PUT /api/admin/security/object/tree/{perspectiveId}/{classId}/{objectId}/{securitySchemeId}

Set security scheme for given object tree in given perspective inclusion

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

Example

Request
PUT /api/admin/security/object/tree/{perspectiveId}/{classId}/{objectId}/{securitySchemeId}
Content-Type: */*
Accept: application/json

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

                
{ }