REST API for Oracle Unified Directory Administration

• compareResult: boolean
  Indicates the result of LDAP compare operation.
• msgType(required): string
  Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

  The REST message type
• searchResultEntries(required): array searchResultEntries

  Number of search result entries returned after the LDAP operation.

• totalResults(required): integer(int32)
  Specifies the number of entries created, and returned.

Copy{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "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"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

• Array of: object Transformations Workflow Element SearchResultEntry

Copy{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Transformations Workflow Element SearchResultEntry"
    }
}

• attributes(required): object Transformations Workflow Element Properties
• dn(required): string
  LDAP DN of the entry to be created

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

• cn: string
  CN (common name) of the entry
• ds-cfg-enabled(required): boolean
  Indicates whether the Workflow Element is enabled for use in the server.
• ds-cfg-entry-match-filter: string
  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.
• ds-cfg-entry-parent-suffix: array ds-cfg-entry-parent-suffix

  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.

• ds-cfg-excluded-operation: array ds-cfg-excluded-operation

  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.

• ds-cfg-java-class(required): string
  Default Value: org.opends.server.workflowelement.transformations.TransformationsWorkflowElement

  Specifies the fully-qualified name of the Java class that provides the Transformations Workflow Element implementation.
• ds-cfg-next-workflow-element(required): string
  Defines the next workflow element in the chain of workflow elements.
• ds-cfg-transformation(required): array ds-cfg-transformation

  Specifies the transformations that are applied.

• objectclass(required): array objectclass

  Objectclass(es) which this entry belongs to.

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

• Array of: string

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

• Array of: string

Copy{
    "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"
    ]
}

• Array of: string

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

• Array of: string

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

• msgType(required): string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

  The REST message type
• searchResultEntries(required): array searchResultEntries
• totalResults(required): integer(int32)
  Specifies the number of entries created, and returned.

Copy{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Transformations Workflow Element SearchResultEntry"
            }
        }
    }
}

• Array of: object Transformations Workflow Element SearchResultEntry

Copy{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Transformations Workflow Element SearchResultEntry"
    }
}

• attributes(required): object Transformations Workflow Element Properties
• dn(required): string
  LDAP DN of the entry to be created

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

• cn: string
  CN (common name) of the entry
• ds-cfg-enabled(required): boolean
  Indicates whether the Workflow Element is enabled for use in the server.
• ds-cfg-entry-match-filter: string
  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.
• ds-cfg-entry-parent-suffix: array ds-cfg-entry-parent-suffix

  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.

• ds-cfg-excluded-operation: array ds-cfg-excluded-operation

  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.

• ds-cfg-java-class(required): string
  Default Value: org.opends.server.workflowelement.transformations.TransformationsWorkflowElement

  Specifies the fully-qualified name of the Java class that provides the Transformations Workflow Element implementation.
• ds-cfg-next-workflow-element(required): string
  Defines the next workflow element in the chain of workflow elements.
• ds-cfg-transformation(required): array ds-cfg-transformation

  Specifies the transformations that are applied.

• objectclass(required): array objectclass

  Objectclass(es) which this entry belongs to.

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

• Array of: string

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

• Array of: string

Copy{
    "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"
    ]
}

• Array of: string

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

• Array of: string

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

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

  The REST message type

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