ちぐログ

メモ書きです

Azure DevOps Server の REST API エラーでハマった

Azure DevOps Server (オンプレの方) が必要になったので、REST APIの検証していたのですが、
叩く API によって、エラーが返ってくるので悩んでいました。

エラーになる API と 実行結果

例えば、エラーになる REST API はこちらです。 docs.microsoft.com

API の結果がこちら。

{"$id":"1","innerException":null,"message":"searchPlatformConnectionString","typeName":"System.ArgumentException, mscorlib","typeKey":"ArgumentException","errorCode":0,"eventId":0}

こちらの REST API はエラーになりません。 docs.microsoft.com

原因

管理コンソールで検索サービスの構成がされていなかったのが原因でした。 f:id:chiguniiita:20200502052017p:plain

画像は構成済ですがエラーが出る場合は、ここが未構成状態になっています。
エラーになる API は クエリを POST していたので、クエリを使うものがエラーの対象となる可能性が高いです。(未検証)

検索サービスを使わずに運用回避

やりたいことは作業項目を特定の条件で取得することだったので、事前に Boards のクエリで作成しておいて、REST API で叩くことにしました。 docs.microsoft.com

まとめ

大半の人は、Azure DevOps Services(クラウドの方)を使うと思うので、このエラーには遭遇しないと思いますが、誰かの助けになれば・・・