Project API¶

Project APIは、プロジェクトの作成、更新、削除、タグ付けなどの操作を提供します。

ListProject¶

Endpoint¶

GET: /project/list-project/

Parameters¶

Name	Type	In	Description
`user_id`	number	query	ユーザーID
`project_id`	number	query	プロジェクトID
`name`	string	query	プロジェクト名

Code sample¶

curl -XGET \
    --header 'Authorization: Bearer xxx' \
    'https://{your-site}/api/v1/project/list-project/?project_id=1001'

Response¶

Status: 200 OK

{
    "data": {
        "project": [
            {
                "project_id": 1001,
                "name": "sample-project",
                "tag": [
                    {
                        "project_id": 1001,
                        "tag": "sample-tag",
                        "color": "blue",
                        "created_at": 1629337534,
                        "updated_at": 1629337534
                    }
                ],
                "created_at": 1629337534,
                "updated_at": 1629337534
            }
        ]
    }
}

CreateProject¶

Endpoint¶

POST: /project/create-project/

Parameters¶

Name	Type	In	Required	Description
`user_id`	number	body	yes	プロジェクトオーナーのユーザーID
`name`	string	body	yes	プロジェクト名（1〜64文字）

Code sample¶

curl -XPOST \
    --header 'Authorization: Bearer xxx' \
    --header 'Content-Type: application/json' \
    --data '{"user_id":1001, "name":"sample-project"}' \
    'https://{your-site}/api/v1/project/create-project/'

Response¶

Status: 200 OK

{
    "data": {
        "project": {
            "project_id": 1001,
            "name": "sample-project",
            "created_at": 1629337534,
            "updated_at": 1629337534
        }
    }
}

UpdateProject¶

Endpoint¶

POST: /project/update-project/

Parameters¶

Name	Type	In	Required	Description
`project_id`	number	body	yes	プロジェクトID
`name`	string	body	yes	プロジェクト名（1〜64文字）

Code sample¶

curl -XPOST \
    --header 'Authorization: Bearer xxx' \
    --header 'Content-Type: application/json' \
    --data '{"project_id":1001, "name":"updated-project-name"}' \
    'https://{your-site}/api/v1/project/update-project/'

Response¶

Status: 200 OK

{
    "data": {
        "project": {
            "project_id": 1001,
            "name": "updated-project-name",
            "created_at": 1629337534,
            "updated_at": 1629974029
        }
    }
}

DeleteProject¶

Endpoint¶

POST: /project/delete-project/

Parameters¶

Name	Type	In	Required	Description
`project_id`	number	body	yes	プロジェクトID

Code sample¶

curl -XPOST \
    --header 'Authorization: Bearer xxx' \
    --header 'Content-Type: application/json' \
    --data '{"project_id":1001}' \
    'https://{your-site}/api/v1/project/delete-project/'

Response¶

Status: 200 OK

{"data":{}}

TagProject¶

Endpoint¶

POST: /project/tag-project/

Parameters¶

Name	Type	In	Required	Description
`project_id`	number	body	yes	プロジェクトID
`tag`	string	body	yes	タグ名（1〜512文字）
`color`	string	body		タグの色（0〜32文字）

Code sample¶

curl -XPOST \
    --header 'Authorization: Bearer xxx' \
    --header 'Content-Type: application/json' \
    --data '{"project_id":1001, "tag":"sample-tag", "color":"blue"}' \
    'https://{your-site}/api/v1/project/tag-project/'

Response¶

Status: 200 OK

{
    "data": {
        "project_tag": {
            "project_id": 1001,
            "tag": "sample-tag",
            "color": "blue",
            "created_at": 1629337534,
            "updated_at": 1629337534
        }
    }
}

UntagProject¶

Endpoint¶

POST: /project/untag-project/

Parameters¶

Name	Type	In	Required	Description
`project_id`	number	body	yes	プロジェクトID
`tag`	string	body	yes	タグ名（1〜512文字）

Code sample¶

curl -XPOST \
    --header 'Authorization: Bearer xxx' \
    --header 'Content-Type: application/json' \
    --data '{"project_id":1001, "tag":"sample-tag"}' \
    'https://{your-site}/api/v1/project/untag-project/'

Response¶

Status: 200 OK

{"data":{}}