Collection Access

Data Structures

CollectionAccessModel

Attribute	Type	Required	Description
subject_id	string		Read-only. Subject identifier. Uniqueness is required in the combination of attribute subject_id with attribute object_id.
subject_name	string		Read-only; expensive to use. Subject name.
object_id	string		Read-only. Object identifier. Uniqueness is required in the combination of attribute object_id with attribute subject_id.
object_name	string		Read-only; expensive to use. Object name.
rights	string-array		Read-only. List of access rights.
builtin	boolean		Read-only; expensive to use. Is object built-in? Built-in objects shouldn’t be editable.
hidden	boolean		Read-only; expensive to use. Shall the object be hidden in UI?

Retrieve Available Attributes of the CollectionAccessModel

Request

Method	GET
Path	/api/v2/objspec/collection_access

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.

List Collection Access

Request

Method	GET
Path	/api/v2/access/collection

GET /api/v2/access/collection

Example Request

curl -s -k -X GET \
  -H 'Authorization: <token>' \
  'https://10.31.135.179/api/v2/access/collection'

Response

{
    "result": "success",
    "collection_access": [
        {
            "subject_id": "8754997675608244225",
            "subject_name": "admin",
            "object_id": "8754997675608244225",
            "object_name": "Development Team",
            "rights": [
                "read",
                "modify",
                "delete",
                "move",
                "create"
            ],
            "builtin": false,
            "hidden": false
        }
    ]
}

Get Specific Collection Access

Request

Method	GET
Path	/api/v2/access/<subject_id>/collection/<object_id>

GET /api/v2/access/<subject_id>/collection/<object_id>

Example Request

curl -s -k -X GET \
  -H 'Authorization: <token>' \
  'https://10.31.135.179/api/v2/access/8754997675608244225/collection/8754997675608244225'

Response

{
    "result": "success",
    "collection_access": {
        "subject_id": "8754997675608244225",
        "subject_name": "admin",
        "object_id": "8754997675608244225",
        "object_name": "Development Team",
        "rights": [
            "read",
            "modify",
            "delete",
            "move",
            "create"
        ],
        "builtin": false,
        "hidden": false
    }
}