Oracle Unified Directoryの管理REST API: DNによるスキーマ・ローカル・バックエンド・ワークフロー要素の変更

DNによるスキーマ・ローカル・バックエンド・ワークフロー要素の変更

PATCH

/rest/v1/admin/{dn}

DNによるスキーマ・ローカル・バックエンド・ワークフロー要素の変更

リクエスト

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

application/json

パス・パラメータ

dn: string

変更するエントリのLDAP DN。

変更する必要があるスキーマ・ローカル・バックエンド・ワークフロー要素

ルート・スキーマ: PatchRequest

型: object

ソースを表示

controls(optional): array controls

LDAP変更操作のためにサーバーに送信するLDAP制御。
msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

RESTメッセージ・タイプ
operations: array operations

エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: string

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

[0]: object PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

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

型: object

ソースを表示

attribute: string

変更するエントリ属性。
opType: string

指定可能な値: [ "add", "delete", "replace", "increment" ]

パッチ操作のタイプ。
values(optional): array values

更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

更新する属性値。

ソースを表示

[0]: string

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: スキーマ・ローカル・バックエンド・ワークフロー要素のPatchSuccessResponse

型: object

ソースを表示

msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

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:ModifyResponse",
            "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/Schema Local Backend Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: object スキーマ・ローカル・バックエンド・ワークフロー要素のSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Schema Local Backend Workflow Element 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/Schema Local Backend Workflow Element Properties"
        }
    }
}

ネストされたスキーマ: スキーマ・ローカル・バックエンド・ワークフロー要素のプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-base-dn: array ds-cfg-base-dn

バックエンドが処理するデータのベースDNを指定します。
ds-cfg-enabled: boolean

サーバーでワークフロー要素が使用可能かどうかを示します。
ds-cfg-java-class: string

デフォルト値: org.opends.server.workflowelement.localbackend.SchemaLocalBackendWorkflowElement

スキーマ・ローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-referrals-url(optional): array ds-cfg-referrals-url

サーバーがリクエストを完了できない場合に返されるURL。
ds-cfg-schema-entry-dn(optional): array ds-cfg-schema-entry-dn

base-dnプロパティに含まれている値に加え、スキーマ情報が公開されるサブツリーのベースDNを定義します。
ds-cfg-show-all-attributes: boolean

スキーマ・エントリ内のすべての属性を、それらの構成に関係なく、ユーザー属性と同様に処理するかどうかを示します。
ds-cfg-writability-mode: string

デフォルト値: enabled

指定可能な値: [ "disabled", "enabled", "internal-only" ]

バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。
objectclass: array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-show-all-attributes",
        "ds-cfg-writability-mode",
        "ds-cfg-base-dn",
        "ds-cfg-enabled"
    ],
    "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 Schema Local Backend Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.localbackend.SchemaLocalBackendWorkflowElement",
            "type":"string"
        },
        "ds-cfg-referrals-url":{
            "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-show-all-attributes":{
            "description":"Indicates whether to treat all attributes in the schema entry as if they were user attributes regardless of their configuration. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-writability-mode":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"enabled",
            "type":"string",
            "enum":[
                "disabled",
                "enabled",
                "internal-only"
            ]
        },
        "ds-cfg-schema-entry-dn":{
            "description":"Defines the base DNs of the subtrees in which the schema information is published in addition to the value included in the base-dn property. ",
            "readOnly":false,
            "default":[
                "cn=schema"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN(s) for the data that the backend handles. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-base-dn

型: array

バックエンドが処理するデータのベースDNを指定します。

ソースを表示

[0]: string

{
    "description":"Specifies the base DN(s) for the data that the backend handles. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-referrals-url

型: array

サーバーがリクエストを完了できない場合に返されるURL。

ソースを表示

[0]: string

{
    "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-schema-entry-dn

型: array

base-dnプロパティに含まれている値に加え、スキーマ情報が公開されるサブツリーのベースDNを定義します。

デフォルト値: [ "cn=schema" ]

ソースを表示

[0]: string

{
    "description":"Defines the base DNs of the subtrees in which the schema information is published in addition to the value included in the base-dn property. ",
    "readOnly":false,
    "default":[
        "cn=schema"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

400レスポンス

ERROR

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

先頭に戻る