ジャンプ先

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

DNによる検索フィルタ・ロード・バランシング・ルートの検索

GET

/rest/v1/admin/{dn}

DNによって検索フィルタ・ロード・バランシング・ルートを返します

リクエスト

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

• application/json

パス・パラメータ

• dn: string
  フェッチするエントリのLDAP DN。

問合せパラメータ

• attributes: array
  コレクション形式: multi

  エントリに対してフェッチする属性のリスト。

  • [0]: string

  {
      "name":"attributes",
      "in":"query",
      "description":"List of attributes to be fetched for the entry.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• controls: array
  コレクション形式: multi

  検索操作のためにサーバーに送信するLDAP制御。

  • [0]: string

  {
      "name":"controls",
      "in":"query",
      "description":"LDAP controls to be sent to server for search operation.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
• scope: string
  LDAP検索操作の範囲。

  指定可能な値: [ "base", "sub", "one" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: 検索フィルタ・ロード・バランシング・ルートのGetSuccessResponse

型: object

ソースを表示

• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults: integer(int32)
  作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/Searchfilter Load Balancing Route SearchResultEntry"
            }
        }
    }
}

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

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

• [0]: object 検索フィルタ・ロード・バランシング・ルートのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Searchfilter Load Balancing Route SearchResultEntry"
    }
}

ネストされたスキーマ: 検索フィルタ・ロード・バランシング・ルートのSearchResultEntry

型: object

ソースを表示

• attributes: object 検索フィルタ・ロード・バランシング・ルートのプロパティ
• dn: string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Searchfilter Load Balancing Route Properties"
        }
    }
}

ネストされたスキーマ: 検索フィルタ・ロード・バランシング・ルートのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-allowed-attributes(optional): array ds-cfg-allowed-attributes
  許可された属性のリスト。
• ds-cfg-priority: integer(int32)
  ルートの優先度。
• ds-cfg-prohibited-attributes(optional): array ds-cfg-prohibited-attributes
  禁止された属性のリスト。
• ds-cfg-workflow-element(optional): string
  読取り専用: true

  ルートを含むワークフロー要素。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-priority"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-allowed-attributes":{
            "description":"The list of allowed attributes. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-workflow-element":{
            "description":"The workflow element which contains the route. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-priority":{
            "description":"The priority of the route. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-prohibited-attributes":{
            "description":"The list of prohibited attributes. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-allowed-attributes

型: array

許可された属性のリスト。

ソースを表示

• [0]: string

{
    "description":"The list of allowed attributes. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-prohibited-attributes

型: array

禁止された属性のリスト。

ソースを表示

• [0]: string

{
    "description":"The list of prohibited attributes. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

• [0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode(optional): integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message: string
  操作に対して返されるエラー・メッセージ。
• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  RESTメッセージ・タイプ

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

先頭に戻る