WORKSECTION

Tags

Getting the list of titles of status/label groups through API: get_tag_groups

Sample get_tag_groups request

https://your—domain.com/api/admin/v2/?action=get_tag_groups&hash=HASH
Returns data on status and label groups
This request does not require page parameter
Returned data on status/tag groups:
  • id — group unique identifier
  • title — group name
  • type — group type (status/label)
  • access — visibility of labels of a certain label group (statuses are always visible and have public value)
    public — available to all teams (including external client teams)
    private — available only for your company teams

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "status": "ok",
    "data": [
        {
            "title": "GROUP_NAME_1",
            "id": GROUP_ID,
            "type": "status",
            "access": "public"
        },
        {
            "title": "GROUP_NAME_2",
            "id": GROUP_ID,
            "type": "label",
            "access": "public"
        },
        {
            "title": "GROUP_NAME_3",
            "id": GROUP_ID,
            "type": "label",
            "access": "private"
        }
    ]
}
Was this article helpful? Yes, thank you! No

Getting the list of statuses and labels through API: get_tags

Sample get_tags request

https://your—domain.com/api/admin/v2/?action=get_tags&hash=HASH
Returns data on all statuses and labels along with the groups they belong to
This request does not require page parameter

Optional parameters:
  • group — returns data of one specified group. You can specify the name of the group or its ID (can be obtained through the same method from the returned group parameter or through get_tag_groups method)
Returned data:
  • id — unique status/label identifier
  • title — status/label name
  • group — data on a status/label group (see get_tag_groups method for returned parameters description)

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "status": "ok",
    "data": [
        {
            "title": "LABEL_NAME",
            "id": "LABEL_ID",
            "group": {
                "title": "GROUP_NAME",
                "id": GROUP_ID,
                "type": "label",
                "access": "public"
                 }
        },
        {
            "title": "STATUS_NAME",
            "id": "STATUS_ID",
            "group": {
                "title": "GROUP_NAME",
                "id": GROUP_ID,
                "type": "status",
                "access": "public"
             }
        }
    ]
}

Was this article helpful? Yes, thank you! No

Creating groups for statuses and labels through API: add_tag_groups

Sample add_tag_groups request

https://your-domain.com/api/admin/v2/?action=add_tag_groups&
title=GROUP_NAME_1,GROUP_NAME_2&type=label&access=public&hash=HASH
Checks for the possible existence of status or label groups with specified names and creates new ones if necessary
This request does not require page parameter

Required parameters:
  • type — group type (status/label)
  • access — visibility of labels of a certain label group (statuses are always visible and have public value)
    public — available to all teams (including external client teams)
    private — available only for your company teams
    • title — comma separated list of group names
Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "status": "ok",
    "data": [
        {
            "title": "GROUP_NAME_1",
            "id": GROUP_ID,
            "type": "label",
            "access": "public"
        },
        {
            "title": "GROUP_NAME_2",
            "id": GROUP_ID,
            "type": "status",
            "access": "public"
        }
    ]
}
Was this article helpful? Yes, thank you! No

Creating statuses and labels through API: add_tags

Sample add_tags request

https://your-domain.com/api/admin/v2/?action=add_tags&
title=LABEL_NAME_1,LABEL_NAME_2&group=GROUP_ID&hash=HASH
Checks for the possible existence of statuses or labels with specified names and creates new ones if necessary
This request does not require page parameter

Required parameters:
  • group — group, where statutes or labels will be created. You can specify the name of the group or its ID (can be obtained through [get_tag_groups] method)
    • title — comma separated list of status or label names
Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "status": "ok",
    "data": [
        {
            "title": "LABEL_NAME_1",
            "id": LABEL_ID
        },
        {
            "title": "LABEL_NAME_2",
            "id": LABEL_ID
        }
    ]
}
Was this article helpful? Yes, thank you! No

Setting/removing statuses and labels of tasks/subtasks through API: update_tags

Sample update_tags request

https://your—domain.com/api/admin/v2/?action=update_tags&
page=/project/PROJECT_ID/TASK_ID/&plus=Tag1,Tag2&minus=Tag3,
Tag4&hash=HASH
Sets new and removes previous task/subtask statuses and labels
Statuses and labels can be specified by their names (full match) or ID (can be obtained through get_tags method)

Required parameters:
  • page — task/subtask link (see link format for details)

Optional parameters:
  • plus — comma separated list of status and label names to be set
  • minus — comma separated list of status and label names to be removed
Sample JSON response
If the request succeeds, the response will contain ok status

{
    "status": "ok"
}

Was this article helpful? Yes, thank you! No

Getting the list of project statuses and labels through API: get_project_tags

Sample get_project_tags request

https://your—domain.com/api/admin/v2/?action=get_project_tags&hash=HASH
Returns data on all project statuses and labels along with the groups they belong to
This request does not require page parameter
Returned data:
  • id — unique project status/label identifier
  • title — project status/label name
  • group — data on a project status/label group (see get_tag_groups method for returned parameters description)

Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{
    "status": "ok",
        "data": [
            {
                "title": "PROJECT_STATUS_NAME_1",
                "id": "PROJECT_STATUS_ID",
                "group": {          
                    "title": "PROJECT_GROUP_NAME",
                    "id": "PROJECT_GROUP_ID",
                    "type": "status",
                    "access": "public"
            },
            {
                "title": "_PROJECT_LABEL_NAME_2",
                "id": "PROJECT_LABEL_ID",
                "group": {             
                    "title": "PROJECT_GROUP_NAME",
                    "id": "PROJECT_GROUP_ID",
                    "type": "label",
                    "access": "public"
            }
        ]
}

Was this article helpful? Yes, thank you! No

Creating project statuses and labels through API: add_project_tags

Sample add_project_tags request

https://your-domain.com/api/admin/v2/?action=add_project_tags&title=
PROJECT_LABEL_NAME_1,PROJECT_LABEL_NAME_2&group=PROJECT_GROUP_ID&hash=HASH
Checks for the possible existence of project statuses or labels with specified names and creates new ones if necessary
This request does not require page parameter

Required parameters:
  • group — group, where project statutes or labels will be created. You can specify the name of the group or its ID
    • title — comma separated list of project status or label names
Sample JSON response
If the request succeeds, the response will contain ok status and the following data:

{ 
    "status": "ok",
    "data": [
        {
            "title": "PROJECT_LABEL_NAME_1",
            "id": PROJECT_LABEL_ID
        },
        {
            "title": "PROJECT_LABEL_NAME_2",
            "id": PROJECT_LABEL_ID
        }
    ]
}
Was this article helpful? Yes, thank you! No

Setting/removing statuses and labels of projects through API: update_project_tags

Sample update_project_tags request

https://your-domain.com/api/admin/v2/?action=update_project_tags&
page=/project/PROJECT_ID/&plus=Tag1,Tag2&minus=Tag3,Tag4&hash=HASH
Sets new and removes previous project statuses and labels
Statuses and labels can be specified by their names (full match) or ID (can be obtained through get_project_tags method)

Required parameters:

Optional parameters:
  • plus — comma separated list of project status and label names to be set
  • minus — comma separated list of project status and label names to be removed
Sample JSON response
If the request succeeds, the response will contain ok status

{
    "status": "ok"
}

Was this article helpful? Yes, thank you! No
esc
или
Print