Skip to content

Secret Group

Info

For API overview and usages, check out this page

Get List

GET /api/project-manager/projects/:project_id/roles (requires authentication)

Response

Status: 200 OK
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "68f764ab-36b2-4f6a-9281-412867a40e6d",
            "name": "admin",
            "description": "admin",
            "permission": [
                {
                    "id": "0a259b52-341f-4e42-baf2-cbdb76b0818a",
                    "title": "Update Project",
                    "description": "admin"
                }
            ]
        }
    ]
}

Get Object

GET /api/project-manager/projects/:project_id/roles/:roles_id (requires authentication)

Response

Status: 200 OK
{
    "id": "68f764ab-36b2-4f6a-9281-412867a40e6d",
    "name": "admin",
    "description": "admin",
    "permission": [
        {
            "id": "0a259b52-341f-4e42-baf2-cbdb76b0818a",
            "title": "Update Project",
            "description": "admin"
        }
    ]
}

Create new data

POST /api/project-manager/projects/:project_id/roles (requires authentication)

Parameters

Name Description
name name of role
permission list of permission ids
description description of role

Request

{
    "name": "admin",
    "description": "admin",
    "permission": [
        "0a259b52-341f-4e42-baf2-cbdb76b0818a"
    ]
}

Response

Status: 201 Created
{
    "id": "68f764ab-36b2-4f6a-9281-412867a40e6d",
    "name": "admin",
    "description": "admin",
    "permission": [
        {
            "id": "0a259b52-341f-4e42-baf2-cbdb76b0818a",
            "title": "Update Project",
            "description": "admin"
        }
    ]
}

Partial Update

PATCH /api/project-manager/projects/:project_id/roles/:roles_id(requires authentication)

Parameters

Name Description
name name of role
permission list of permission ids
description description of role

Request

{
    "name": "admin",
    "description": "admin",
    "permission": [
        "0a259b52-341f-4e42-baf2-cbdb76b0818a"
    ]
}

Response

Status: 201 Created
{
    "id": "68f764ab-36b2-4f6a-9281-412867a40e6d",
    "name": "admin",
    "description": "admin",
    "permission": [
        {
            "id": "0a259b52-341f-4e42-baf2-cbdb76b0818a",
            "title": "Update Project",
            "description": "admin"
        }
    ]
}


Last update: November 28, 2021