ジャンプ先

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

DNによる変換ワークフロー要素の変更

PATCH

/rest/v1/admin/{dn}

DNによる変換ワークフロー要素の変更

リクエスト

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

• application/json

パス・パラメータ

• dn(required): string
  変更するエントリのLDAP DN。

本文 ()

変更する必要がある変換ワークフロー要素

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls: array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType(required): 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制御。

ソースを表示

• 配列: 文字列

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

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

型: array

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

ソースを表示

• 配列: オブジェクト PatchOperation

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

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

型: object

ソースを表示

• attribute(required): string
  変更するエントリ属性。
• opType(required): string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values: 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

更新する属性値。

ソースを表示

• 配列: 文字列

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: 変換ワークフロー要素のPatchSuccessResponse

型: object

ソースを表示

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

  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: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/Transformations Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト 変換ワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: 変換ワークフロー要素のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-entry-match-filter: string
  変換を適用するためにエントリが一致する必要があるフィルタを指定します。定義しない場合、(他の潜在的な条件と一致する)すべてのエントリが変換されます。
• ds-cfg-entry-parent-suffix: array ds-cfg-entry-parent-suffix
  変換を適用するための操作DNの親DNを指定します。複数の値を指定した場合、指定した親DNの1つ以上がエントリDNの親DNであれば、そのエントリは変換されます。指定しない場合、(他の潜在的な条件と一致する)すべてのエントリが変換されます。
• ds-cfg-excluded-operation: array ds-cfg-excluded-operation
  変換を適用しない操作を指定します。例: ある変換タイプで通常はADDおよびMODIFY操作が処理される場合、変換でMODIFYを除外してADD操作のみが処理されるように指定できます。リストが空の場合、処理される操作はそれぞれの変換タイプに依存します。制限はありません。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.workflowelement.transformations.TransformationsWorkflowElement

  変換ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-next-workflow-element(required): string
  ワークフロー要素のチェーン内の次のワークフロー要素を定義します。
• ds-cfg-transformation(required): array ds-cfg-transformation
  適用する変換を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-next-workflow-element",
        "ds-cfg-transformation",
        "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 Transformations Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.transformations.TransformationsWorkflowElement",
            "type":"string"
        },
        "ds-cfg-entry-match-filter":{
            "description":"Specifies the filters that the entry must match for the transformations to apply. When not defined, all entries (that match other potential conditions) are transformed. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-excluded-operation":{
            "description":"Specifies operations on which transformations never apply. Example: When one transformation type normally processes ADD and MODIFY operation, it is possible to exclude MODIFY and thus to make the transformation only process ADD operation. When the list is empty, the operation processed depend on each type of transformation with no restriction. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "extended",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-entry-parent-suffix":{
            "description":"Specifies an parent DN of the operation DN for the transformations to apply. When several values are specified, the entry is transformed when at least one parent DN specified is a parent DN of the entry DN. When not specified, all entries (that match other potential conditions) are transformed. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-next-workflow-element":{
            "description":"Defines the next workflow element in the chain of workflow elements. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-transformation":{
            "description":"Specifies the transformations that are applied. ",
            "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-entry-parent-suffix

型: array

変換を適用するための操作DNの親DNを指定します。複数の値を指定した場合、指定した親DNの1つ以上がエントリDNの親DNであれば、そのエントリは変換されます。指定しない場合、(他の潜在的な条件と一致する)すべてのエントリが変換されます。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies an parent DN of the operation DN for the transformations to apply. When several values are specified, the entry is transformed when at least one parent DN specified is a parent DN of the entry DN. When not specified, all entries (that match other potential conditions) are transformed. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-excluded-operation

型: array

変換を適用しない操作を指定します。例: ある変換タイプで通常はADDおよびMODIFY操作が処理される場合、変換でMODIFYを除外してADD操作のみが処理されるように指定できます。リストが空の場合、処理される操作はそれぞれの変換タイプに依存します。制限はありません。

指定可能な値: [ "add", "bind", "compare", "delete", "extended", "modify", "modifydn", "search" ]

ソースを表示

• 配列: 文字列

{
    "description":"Specifies operations on which transformations never apply. Example: When one transformation type normally processes ADD and MODIFY operation, it is possible to exclude MODIFY and thus to make the transformation only process ADD operation. When the list is empty, the operation processed depend on each type of transformation with no restriction. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "extended",
        "modify",
        "modifydn",
        "search"
    ]
}

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

型: array

適用する変換を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the transformations that are applied. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

400レスポンス

ERROR

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

先頭に戻る