Skip to content

Allowed tags API

Allowed tags API can be used for reading and setting allowed tags for users and teams.

How to use it


Get home


Returns all available links.
GET http://localhost:8080/api
Accept: application/vnd.manictime.v3+json
HTTP/1.1 200 OK
Content-Type: application/vnd.manictime.v3+json; charset=utf-8

{
    "links": [
        {
            "rel": "self",
            "href": "http://localhost:8080/api/"
        },
        {
            "rel": "manictime/timelines",
            "href": "http://localhost:8080/api/timelines"
        },
        {
            "rel": "manictime/environments",
            "href": "http://localhost:8080/api/environments"
        },
        {
            "rel": "manictime/screenshots",
            "href": "http://localhost:8080/api/screenshots"
        },
        {
            "rel": "manictime/clientState",
            "href": "http://localhost:8080/api/clientState"
        },
        {
            "rel": "manictime/tagcombinationlist",
            "href": "http://localhost:8080/api/tagcombinationlist"
        },
        {
            "rel": "manictime/clientsettings",
            "href": "http://localhost:8080/api/clientSettings"
        }
    ]
}

Get allowed tags

Returns allowed tag combinations. Follow link "manictime/tagcombinationlist" from home response. "getAll" query parameter is optional. If false (default) returns available tag combinations for current user, if true, returns available tag combinations for all users, including user and team data (admin or content editor only).

Get for current user

GET http://localhost:8080/api/tagcombinationlist
Accept: application/vnd.manictime.v3+json
HTTP/1.1 200 OK
Content-Type: application/vnd.manictime.v3+json; charset=utf-8

{
    "tagCombinations": [
        "client 1, project 1",
        "client 1, project 2",
        "client 2, project 3",
        "client 2, project 4"
    ],
    "links": [
        {
            "rel": "self",
            "href": "http://localhost:8080/api/tagcombinationlist"
        }
    ]
}

Get for all users including user and team data (admin or content editor only)

GET http://localhost:8080/api/tagcombinationlist?getAll=true
Accept: application/vnd.manictime.v3+json
HTTP/1.1 200 OK
Content-Type: application/vnd.manictime.v3+json; charset=utf-8

{
    "tagCombinations": [
        "client 1, project 1",
        "client 1, project 2",
        "",
        "[domain\\user1]",
        "[domain\\user2]",
        "client 2, project 3",
        "client 2, project 4",
        "",
        "{team1}",
        "client 3, project 5",
        "client 3, project 6"
    ],
    "links": [
        {
            "rel": "self",
            "href": "http://localhost:8080/api/tagcombinationlist"
        }
    ]
}

Update allowed tags

Updates allowed tag combination list. Follow link "manictime/tagcombinationlist" from home response. "tagCombinations" in request body contains tag combinations for all users, "userTagCombinationLists" contains tags for specific users and teams.
POST http://localhost:8080/api/tagcombinationlist
Accept: application/vnd.manictime.v3+json
Content-Type: application/vnd.manictime.v3+json

{
    "tagCombinations": [
        "client 1, project 1",
        "client 1, project 2"
    ],
    "userTagCombinationLists": [
        {
            "users": [
                "[domain\\user1]",
                "[domain\\user2]"
            ],
            "tagCombinations": [
                "client 2, project 3",
                "client 2, project 4",
            ]
        },
        {
            "users": [
                "{team1}"
            ],
            "tagCombinations": [
                "client 3, project 5",
                "client 3, project 6"
            ]
        }
    ]
}
HTTP/1.1 200 OK
Content-Type: application/vnd.manictime.v3+json; charset=utf-8

{
    "tagCombinations": [
        "client 1, project 1",
        "client 1, project 2",
        "client 2, project 3",
        "client 2, project 4"
    ],
    "links": [
        {
            "rel": "self",
            "href": "http://localhost:8080/api/tagcombinationlist"
        }
    ]
}

Feedback and Knowledge Base