Jump to

• Request
• Response

Find Collation Matching Rule by DN

get

/rest/v1/admin/{dn}

Returns an Collation Matching Rule by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be fetched.

Query Parameters

• attributes: array
  Collection Format: multi

  List of attributes to be fetched for the entry.

  • [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
  Collection Format: multi

  LDAP controls to be sent to server for search operation.

  • [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
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
• scope: string
  Scope for the LDAP search operation.

  Allowed Values: [ "base", "sub", "one" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Collation Matching Rule GetSuccessResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  The REST message type
• searchResultEntries: array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults: integer(int32)
  Specifies the number of entries created, and returned.

{
    "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/Collation Matching Rule SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object Collation Matching Rule SearchResultEntry

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

Nested Schema : Collation Matching Rule SearchResultEntry

Type: object

Show Source

• attributes: object Collation Matching Rule Properties
• dn: string
  LDAP DN of the entry to be created

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

Nested Schema : Collation Matching Rule Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-collation: array ds-cfg-collation
  The set of supported locales
• ds-cfg-enabled: boolean
  Indicates whether the Matching Rule is enabled for use.
• ds-cfg-java-class: string
  Default Value: org.opends.server.schema.CollationMatchingRuleFactory

  Specifies the fully-qualified name of the Java class that provides the Collation Matching Rule implementation.
• ds-cfg-matching-rule-type: array ds-cfg-matching-rule-type
  The types of matching rules that should be supported for each locale
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-collation",
        "ds-cfg-enabled",
        "ds-cfg-matching-rule-type"
    ],
    "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-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the Collation Matching Rule implementation. ",
            "readOnly":false,
            "default":"org.opends.server.schema.CollationMatchingRuleFactory",
            "type":"string"
        },
        "ds-cfg-collation":{
            "description":"The set of supported locales ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Matching Rule is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-matching-rule-type":{
            "description":"The types of matching rules that should be supported for each locale ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "equality",
                "greater-than",
                "greater-than-or-equal-to",
                "less-than",
                "less-than-or-equal-to",
                "substring"
            ]
        }
    }
}

Nested Schema : ds-cfg-collation

Type: array

The set of supported locales

Show Source

• Array of: string

{
    "description":"The set of supported locales ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-matching-rule-type

Type: array

The types of matching rules that should be supported for each locale

Allowed Values: [ "equality", "greater-than", "greater-than-or-equal-to", "less-than", "less-than-or-equal-to", "substring" ]

Show Source

• Array of: string

{
    "description":"The types of matching rules that should be supported for each locale ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "equality",
        "greater-than",
        "greater-than-or-equal-to",
        "less-than",
        "less-than-or-equal-to",
        "substring"
    ]
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

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

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• ldapErrorCode(optional): integer(int32)
  Specifies the LDAP error code returned for the operation.
• message: string
  Error message returned returned for the operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  The REST message type

{
    "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."
        }
    }
}

Back to Top