ユーザーエクスポートAPI

いつもお世話になっております。

このページで紹介されているユーザーエクスポート API（JSON）について、
PHPで外部から取得する場合、どのように記述するのでしょうか。

PHP Tipsの情報を参考に、このページのリクエストの内容をPHPに置き換えてみたのですが、条件パラメータが効いておらず、アカウント情報が毎回、全件抽出されてしまいます。

 $context = array(
 "http" => array(
 "method" => 'GET',
 "header" => implode("\r\n", $header),
 "content" => json_encode(array("query" => 'ids=1 and ids=2 limit 100 offset 0'))
 )
 );
 $result = file_get_contents(
 "https://" . $subDomain . ".cybozu.com/v1/users.json",
 false,
 stream_context_create($context)
 );

$context内のqueryが無視されている感じです。
試しに$result内のURLに直接
～v1/users.json?ids[0]=1&ids[1]=2&offset=0&size=100
のように記載してみましたが、これも結果は同じでした。

ご教授いただけますよう、よろしくお願い申し上げます。

TAKA様

お世話になっております。

ユーザーエクスポートAPIはkintone APIと異なりqueryをサポートしていません。

cybozu Development teamさま

回答ありがとうございます。

URLで「ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100」というように指定できるようになっていますが、
これをqueryで指定する方法はないということでしょうか。

TAKA様

はい、リクエストボディでのクエリ指定ができないので、クエリ文字列をURLに含める形になります。
ご確認よろしくお願いします。

cybozu Development teamさま

何度も恐縮ですが、確認でございます。

仰る通りqueryでの指定はできませんでしたので、file_get_contentsのURLに「ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100」を追加してみましたが、これも無視され、全件抽出されました。

$result = file_get_contents(
 "https://" . $subDomain . ".cybozu.com/v1/users.json?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100",
 false,
 stream_context_create($context)
 );

PHPでは条件指定で抽出する方法はないという認識で間違いないでしょうか？

cybozu Development teamさま

ご丁寧なお返事をいただきありがとうございました。

指定したidのみ出力できたとのこと、ご提示いただいたコードはこちらで試したものと変わらない内容ですので、私のコードがどこか間違っていたのかもしれません。
再度見直しを行ないます。
お騒がせして申し訳ございませんでした。

TAKA 様

とんでもございません。またご不明な点がございましたら、お気軽にコミュニティなどご活用ください。

すみませんが本APIについて教えて下さい

標準のフィールドを使わずにアプリを作成したく、JavascriptとHTMLのみで作成を進めています

ユーザー選択と同等のコンポーネントを作成したく、APIの箇所は以下の通りに作りました。

export const kintoneGetUserData = (): Promise<RestUsersResponse> => {
  return new Promise<RestUsersResponse>((ok, _) => {
    kintone.api(kintone.api.url('/v1/users', true), 'GET', { size: 10000 }).then((response: RestUsersResponse) => {
      ok(response);
    });
  })
}

export default function UserSelectField(props: Args) {
  const [userData, setUserData] = React.useState<RestUsersResponse | undefined>(undefined);

  React.useEffect(() => {
    kintoneGetUserData().then(res => {
      console.log(res.users.length)
      setUserData(res);
    })
  }, [])

  return <Autocomplete
    options={userData === undefined ? [] : userData.users.map(e => e)}
    getOptionLabel={(option) => option.name}
    size="small"
    renderInput={(params) => <TextField
      {...params}
      {...props.register}
      label={props.label}
      variant="outlined"
    />}
  />
}

yuichiro 様

お世話になっております。cybozu developer network 運営でございます。

Yuichiro 様のご認識の通り、100件より多くのユーザーデータをエクスポートする場合は、
Offsetを利用しながら数回にわたってリクエストを送信し、都度レスポンスをメモリに保存する必要があります。

ユーザーエクスポート API は、クエリによるフィルタには対応しておらず、
他にユーザー情報を出力できる API はございません。

お力になれず申し訳ございませんが、ご理解のほどよろしくお願いいたします。

cybozu Development team様

ご回答ありがとうございます。
仕様について了解しました

offsetを指定した場合、残りのぺージャーが何件あるか判定する方法は仕様上存在しますか？

特になければapiからの返り値の配列が0か否かで全てのページャーを、取得したか判定したいと思います

yuichiro 様

残りのページャー数は返り値には含まれませんので、
返り値である配列の長さが0か否かで、全てのページャーを取得したか判定する必要があります。

また、技術的な質問に関しましては、
ぜひ cybozu developer コミュニティ をご利用ください。