質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.50%
Redmine

Redmineは、プロジェクトのタスク管理、進捗管理、情報共有が可能な、 オープンソースプロジェクト管理ソフトウェアです。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

Q&A

解決済

3回答

9920閲覧

Redmine:カスタムフィールドをJSON形式のAPI検索条件に指定する方法

a-syuji

総合スコア16

Redmine

Redmineは、プロジェクトのタスク管理、進捗管理、情報共有が可能な、 オープンソースプロジェクト管理ソフトウェアです。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

0グッド

1クリップ

投稿2019/10/20 17:32

編集2019/10/20 23:03

前提・実現したいこと

curl -s -XGET 'http://localhost/redmine/issues.json?project_id=4' -H 'Content-Type: application/json' | jq .total_count

により、project_id=4のチケットを検索・件数表示できますが、
下記のようなカスタムフィールドを検索条件に指定する方法が分かりません。
※id=1のカスタムフィールドの値がhttp://www.example1.comであるチケットのみを返したい。

"custom_fields": [ { "id": 1, "name": "URL", "value": "http://www.example1.com" }, ... ]

試したこと

Redmineのページを参照しましたが見当たりませんでした。
http://www.redmine.org/projects/redmine/wiki/Rest_Issues

補足情報(FW/ツールのバージョンなど)

CentOS Linux release 7.6.1810 (Core)

Environment:
Redmine version 3.4.11.stable.18600
Ruby version 2.4.1-p111 (2017-03-22) [x86_64-linux]
Rails version 4.2.11.1
Environment production
Database adapter PostgreSQL
SCM:
Subversion 1.7.14
Git 1.8.3.1
Filesystem
Redmine plugins:
easy_gantt 1.12
redmine_issue_checklist 2.1.0
redmine_issue_templates 0.2.2-dev
redmine_news_notification 0.0.1
view_customize 2.5.0

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答3

0

ベストアンサー

なぜか、プロジェクトを含めると全件ヒットしてしまい、カスタムフィールドの条件で絞り込まれません。
curl -v --insecure --user user:password https://localhost/redmine/issues.json?project_id=4&cf_1=http://www.example1.com&key=API KEY

検索条件をカスタムフィールドのみにしたらうまく行きましたが、複数プロジェクトを検索してヒットしてしまいます。
curl -v --insecure --user user:password https://localhost/redmine/issues.json?cf_1=http://www.example1.com&key=API KEY

そこで、以下のようにリンク部分で指定したら、特定のプロジェクトのカスタムフィールドで絞り込めました。
curl -v --insecure --user user:password https://localhost/redmine/projects/プロジェクト名/issues.json?cf_1=http://www.example1.com&key=API KEY

投稿2019/10/22 01:06

編集2019/10/22 01:40
takashikawai

総合スコア172

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

takashikawai

2019/10/22 07:37

解決したようで良かったです。 プロジェクトを含めると全件ヒットしてしまっていた原因がわかりました。 リンクを '' で囲っていなかったからでした。 curl -v --insecure --user user:password 'https://localhost/redmine/issues.json?project_id=4&cf_1=http://www.example1.com&key=API KEY' これなら、期待通りの検索結果になります。 あと、デフォルトだと最大25件しかヒットしないので、?limit=100 をつけると良いです。 参考:https://vividtone.github.io/redmine-tokyo-slide-20180526/#/36
guest

0

Redmineのページを参照しましたが見当たりませんでした。
http://www.redmine.org/projects/redmine/wiki/Rest_Issues

===>このページに以下の記載があります。
Optional filters:
cf_x: get issues with the given value for custom field with an ID of x. (Custom field must have 'used as a filter' checked.)

Examples:
GET /issues.xml?cf_1=abcdef

redmineの管理 → カスタムフィールド → id=1のカスタムフィールドの設定画面(../redmine/custom_fields/1/edit)で、「フィルタとして使用」のチェックボックスがONになっていないと検索されないようです。

投稿2019/10/21 22:26

takashikawai

総合スコア172

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

投稿2019/10/21 02:21

編集2019/10/21 02:30
takashikawai

総合スコア172

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

a-syuji

2019/10/21 16:15

ご回答ありがとうございます。 しかしながら取得できませんでした。 後学のため上記の情報元を教えて頂けると幸いです。
guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問