ジャンプ先

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

DNによる辞書編集分散パーティションの検索

GET

/rest/v1/admin/{dn}

DNによって辞書編集分散パーティションを返します

リクエスト

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

• application/json

パス・パラメータ

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

問合せパラメータ

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

  エントリに対してフェッチする属性のリスト。
• controls: array[string]
  コレクション形式: multi

  検索操作のためにサーバーに送信するLDAP制御。
• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
• scope: string
  LDAP検索操作の範囲。

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: 辞書編集分散パーティションのGetSuccessResponse

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): 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/Lexico Distribution Partition SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト 辞書編集分散パーティションのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Lexico Distribution Partition SearchResultEntry"
    }
}

ネストされたスキーマ: 辞書編集分散パーティションのSearchResultEntry

型: object

ソースを表示

• attributes(required): object 辞書編集分散パーティションのプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

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

ネストされたスキーマ: 辞書編集分散パーティションのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-criticality: string
  デフォルト値: true

  指定可能な値: [ "false", "partial", "true" ]

  クリティカル度は、検索操作中にパーティションが起動している必要があるか、それともパーティションを停止することを許容するかを決定します。
• ds-cfg-lower-bound: string
  読取り専用: true

  パーティションの下限値。
• ds-cfg-partition-id: integer(int32)
  読取り専用: true

  パーティションを識別します。
• ds-cfg-upper-bound: string
  読取り専用: true

  パーティションの上限値。
• ds-cfg-workflow-element: string
  読取り専用: true

  パーティションを含むワークフロー要素。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass"
    ],
    "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-lower-bound":{
            "description":"The lower boundary of the partition. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-workflow-element":{
            "description":"The workflow element which contains the partition. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-criticality":{
            "description":"The criticality determines whether a partition must be up, or if it is acceptable to have it down during search operations. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        },
        "ds-cfg-upper-bound":{
            "description":"The upper boundary of the partition. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-partition-id":{
            "description":"Identifies the partition. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): 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."
        }
    }
}

先頭に戻る