はじめに
Redmine APIを利用していて、プロジェクトID・トラッカーID・ユーザーIDが必要になる場面があったのでそれぞれ確認方法を調べました。
確認方法がまとまっているサイトがなかなか無かったので、自分用のメモも兼ねて記事を作成しました。お役立ていただければ幸いです。
前提
当記事では、APIキーを使用したプロジェクトID・トラッカーID・ユーザーIDの確認方法を紹介しています。
APIキー取得方法については以下をご参照ください。
プロジェクトIDの確認方法
以下のURLにAPIアクセスキーを指定して開くと、ブラウザ上でプロジェクトの一覧が確認できる。
Json形式、またはxml形式での取得が可能。
https://[redmine server]/projects.json?key=[APIキー]
https://[redmine server]/projects.xml?key=[APIキー]
＜Json形式での出力例👇＞
{
"projects": [
{
"id": 30,
"name": "[プロジェクト名１]",
"identifier": "[プロジェクト識別子]",
"description": "[説明]",
"homepage": "[ホームページURL]",
"status": 1,
"is_public": false,
"inherit_members": false,
"created_on": "2020-01-01T01:01:00Z",
"updated_on": "2020-01-01T01:01:00Z"
},
{
"id": 31,
"name": "[プロジェクト名２]",
"identifier": "[プロジェクト識別子]",
"description": "[説明]",
"homepage": "",
"parent": {
"id": 30,
"name": "[プロジェクト名１]"
},
"status": 1,
"is_public": false,
"inherit_members": false,
"created_on": "2020-01-01T01:01:00Z",
"updated_on": "2020-01-01T01:01:00Z"
}
],
"total_count": 2,
"offset": 0,
"limit": 25
}
トラッカーIDの確認方法
プロジェクトIDと同様、以下URLにアクセスする。
https://[redmine server]/trackers.json?key=[APIキー]
https://[redmine server]/trackers.xml?key=[APIキー]
＜Json形式での出力例👇＞
{
"trackers": [
{
"id": 30,
"name": "課題",
"default_status": {
"id": 1,
"name": "新規"
},
"description": "",
"enabled_standard_fields": [
"assigned_to_id",
"category_id",
"fixed_version_id",
"parent_issue_id",
"start_date",
"due_date",
"estimated_hours",
"done_ratio",
"description",
"priority_id"
]
},
{
"id": 31,
"name": "Q&A",
"default_status": {
"id": 1,
"name": "新規"
},
"description": "",
"enabled_standard_fields": [
"assigned_to_id",
"category_id",
"fixed_version_id",
"parent_issue_id",
"start_date",
"due_date",
"estimated_hours",
"done_ratio",
"description",
"priority_id"
]
}
]
}
ユーザーIDの確認方法
ユーザーIDとは、RedmineマイページのURL末尾など指定されている、ユーザーを一意に識別するための数値のこと。
https://[redmine server]/users/[ユーザーID（数値）]
プロジェクトIDと同様、以下URLにアクセスする。
https://[redmine server]/users.json?key=[APIキー]
https://[redmine server]/users.xml?key=[APIキー]
＜Json形式での出力例👇＞
{
"users": [
{
"id": 100,
"login": "[ログインID]",
"admin": false,
"firstname": "GAS男",
"lastname": "田中",
"mail": "[メールアドレス]",
"created_on": "2020-01-01T01:01:00Z",
"updated_on": "2020-01-01T01:01:00Z",
"last_login_on": "2020-01-01T01:01:00Z",
"passwd_changed_on": "2020-01-01T01:01:00Z",
"avatar_url": "[アイコン画像URL]",
"twofa_scheme": "totp",
"status": 1
},
{
"id": 200,
"login": "[ログインID]",
"admin": true,
"firstname": "Redmine子",
"lastname": "佐藤",
"mail": "[メールアドレス]",
"created_on": "2020-01-01T01:01:00Z",
"updated_on": "2020-01-01T01:01:00Z",
"last_login_on": "2020-01-01T01:01:00Z",
"passwd_changed_on": "2020-01-01T01:01:00Z",
"avatar_url": "[アイコン画像URL]",
"twofa_scheme": "totp",
"status": 1
}
],
"total_count": 2,
"offset": 0,
"limit": 25
}
参考サイト