Add, Search, Compare or Delete Transformations Workflow Element
post
/rest/v1/admin
Add, Search, Compare or Delete Transformations Workflow Element
Request
Supported Media Types
- application/json
Transformations Workflow Element that needs to be created
Root Schema : Transformations Workflow Element POSTRequest
Type:
Show Source
object
-
assertion(optional):
string
Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
-
attributes(optional):
object Transformations Workflow Element Properties
-
base(optional):
string
Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
-
controls(optional):
array controls
LDAP controls to be sent to server for the LDAP operation.
-
dn(optional):
string
LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
-
filter(optional):
string
Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
-
msgType:
string
Allowed Values:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]
The REST message type -
requiredAttributes(optional):
array requiredAttributes
List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
-
scope(optional):
string
Allowed Values:
[ "base", "sub", "one" ]
Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
Nested Schema : Transformations Workflow Element Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-enabled:
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-entry-match-filter(optional):
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(optional):
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(optional):
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:
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:
string
Defines the next workflow element in the chain of workflow elements.
-
ds-cfg-transformation:
array ds-cfg-transformation
Specifies the transformations that are applied.
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : controls
Type:
array
LDAP controls to be sent to server for the LDAP operation.
Show Source
Nested Schema : requiredAttributes
Type:
array
List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
Show Source
Nested Schema : ds-cfg-entry-parent-suffix
Type:
array
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.
Show Source
Nested Schema : ds-cfg-excluded-operation
Type:
array
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.
Allowed Values:
Show Source
[
"add",
"bind",
"compare",
"delete",
"extended",
"modify",
"modifydn",
"search"
]
Nested Schema : ds-cfg-transformation
Type:
array
Specifies the transformations that are applied.
Show Source
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Transformations Workflow Element SuccessResponse
Type:
Show Source
object
-
compareResult(optional):
boolean
Indicates the result of LDAP compare operation.
-
msgType:
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:
array searchResultEntries
Number of search result entries returned after the LDAP operation.
-
totalResults:
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : searchResultEntries
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : Transformations Workflow Element SearchResultEntry
Type:
Show Source
object
-
attributes:
object Transformations Workflow Element Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : Transformations Workflow Element Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-enabled:
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-entry-match-filter(optional):
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(optional):
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(optional):
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:
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:
string
Defines the next workflow element in the chain of workflow elements.
-
ds-cfg-transformation:
array ds-cfg-transformation
Specifies the transformations that are applied.
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-entry-parent-suffix
Type:
array
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.
Show Source
Nested Schema : ds-cfg-excluded-operation
Type:
array
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.
Allowed Values:
Show Source
[
"add",
"bind",
"compare",
"delete",
"extended",
"modify",
"modifydn",
"search"
]
Nested Schema : ds-cfg-transformation
Type:
array
Specifies the transformations that are applied.
Show Source
201 Response
Created
Root Schema : Transformations Workflow Element ADDResponse
Type:
Show Source
object
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
The REST message type -
searchResultEntries:
array searchResultEntries
-
totalResults:
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : Transformations Workflow Element SearchResultEntry
Type:
Show Source
object
-
attributes:
object Transformations Workflow Element Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : Transformations Workflow Element Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-enabled:
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-entry-match-filter(optional):
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(optional):
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(optional):
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:
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:
string
Defines the next workflow element in the chain of workflow elements.
-
ds-cfg-transformation:
array ds-cfg-transformation
Specifies the transformations that are applied.
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-entry-parent-suffix
Type:
array
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.
Show Source
Nested Schema : ds-cfg-excluded-operation
Type:
array
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.
Allowed Values:
Show Source
[
"add",
"bind",
"compare",
"delete",
"extended",
"modify",
"modifydn",
"search"
]
Nested Schema : ds-cfg-transformation
Type:
array
Specifies the transformations that are applied.
Show Source
204 Response
No content
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object
-
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