Skip to content

グループを検索する#

Description#

リクエストパラメータを検索条件として該当するグループ情報を検索します。
項目「複数指定グループＩＤ」「グループ名」はいずれか１つを条件として設定できます。
（いずれも設定されている場合は入力エラーとなります。）

Method#

GET

Request Header#

共通リクエストヘッダーを参照してください。

Argument#

Name Type Required Length
（Long /Decimalの場合はValue）		 URI Query String Description

group_id

String

8
～
1007

-

○

複数指定グループＩＤ
グループを一意に識別するＩＤ
複数指定可。複数指定の場合、カンマ「,」を区切り文字として指定。

group_name

String

1
～
40

-

○

グループ名

free_item1

String

1
～
1000

-

○

フリー項目１

free_item2

String

1
～
1000

-

○

フリー項目２

free_item3

String

1
～
1000

-

○

フリー項目３

free_item4

String

1
～
1000

-

○

フリー項目４

free_item5

String

1
～
1000

-

○

フリー項目５

free_item6

String

1
～
1000

-

○

フリー項目６

free_item7

String

1
～
1000

-

○

フリー項目７

free_item8

String

1
～
1000

-

○

フリー項目８

free_item9

String

1
～
1000

-

○

フリー項目９

free_item10

String

1
～
1000

-

○

フリー項目１０

sort_item1

String

1
～
40

-

○

ソート項目名１

sort1

String

1

-

○

ソート順１

sort_item2

String

1
～
40

-

○

ソート項目名２

sort2

String

1

-

○

ソート順２

sort_item3

String

1
～
40

-

○

ソート項目名３

sort3

String

1

-

○

ソート順３

start_position

Long

1
～
9999999

-

○

開始位置
共通仕様はこちらを参照

end_position

Long

1
～
9999999

-

○

終了位置
共通仕様はこちらを参照

URI#

/API/v2/api/group

Sample request uri#

グループ名とページング指定の開始位置と終了位置を指定しての検索

/API/v2/api/group?group_name=富士通&start_position=1&end_position=100

Parameters in request body#

なし

Return Codes#

Code Description
200 レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。
401 認証エラー。API認証時のエラー。
403 アクセス不可。
404 対象なし。対象の情報が見つからない場合。
500 業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。

Response Header#

なし

Response Parameter#

共通仕様はこちらを参照してください。

  • レスポンス（正常）

Example#

Parameters#

Top