機械翻訳について

移動

• リクエスト
• レスポンス

グループの検索

get

{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/groups

指定された基準でグループを検索

リクエスト

問合せパラメータ

• configuredGroupsOnly(required): boolean
  すべてのグループまたは構成済のファイル・サーバー・グループのみを検索するフラグ

  デフォルト値: false
• searchCriteria(required): string
  searchCriteria

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

成功

本文()

ルート・スキーマ : groups

型: object

読取り専用: true

グループ検索結果を提供

Show Source

• groups: array groups

{
    "type":"object",
    "properties":{
        "groups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FileServerGroup"
            }
        }
    },
    "description":"Provides group search result",
    "readOnly":true,
    "xml":{
        "name":"groups"
    }
}

ネストされたスキーマ: groups

型: array

Show Source

• Array of: object schema
  グループ・ファイル・サーバー・メタデータを記述

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FileServerGroup"
    }
}

ネストされたスキーマ : schema

型: object

グループ・ファイル・サーバー・メタデータを記述

Show Source

• homeDirectory: string
  グループのホーム・ディレクトリまたはランディング・フォルダ
• homeType: string
  許容値: [ "Default", "Custom", "None" ]

  ホーム・タイプ
• name: string
• status: string
  許容値: [ "not configured", "enabled", "disabled" ]

  グループ・ステータス

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"Group's status",
            "enum":[
                "not configured",
                "enabled",
                "disabled"
            ]
        },
        "homeType":{
            "type":"string",
            "description":"Home type",
            "enum":[
                "Default",
                "Custom",
                "None"
            ]
        },
        "homeDirectory":{
            "type":"string",
            "description":"Home directory or landing folder for group",
            "nullable":true
        }
    },
    "description":"describes group's fileserver metadata",
    "xml":{
        "name":"groupConfig"
    }
}

401レスポンス

グループを取得する権限がありません

404レスポンス

グループは使用できません

500レスポンス

内部サーバー・エラー

トップに戻る