Add, Search, Compare or Delete RDBMS Workflow Element
post
/rest/v1/admin
Add, Search, Compare or Delete RDBMS Workflow Element
Request
Supported Media Types
- application/json
RDBMS Workflow Element that needs to be created
Root Schema : RDBMS 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 RDBMS 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 : RDBMS Workflow Element Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-cache-invalidation-interval(optional):
string
Default Value:
60000ms
The lifetime of cached objects. This property is used when the cache invalidation property is set to 'ttl-cache-invalidation-policy'. -
ds-cfg-cache-invalidation-policy(optional):
string
Default Value:
no-expiry-cache-invalidation-policy
Allowed Values:[ "no-expiry-cache-invalidation-policy", "ttl-cache-invalidation-policy" ]
The policy that must be used to invalidate the cached data. -
ds-cfg-cache-size(optional):
integer(int32)
Default Value:
1000
The number of database records to be cached. -
ds-cfg-caching-scheme(optional):
string
Default Value:
none
Allowed Values:[ "full", "hard-weak", "none", "soft", "soft-weak", "weak" ]
Select the scheme that must be used to cache database records. "none" is the recommended default. -
ds-cfg-enabled:
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-java-class:
string
Default Value:
com.oracle.dps.server.workflowelement.rdbms.RDBMSWorkflowElement
Specifies the fully-qualified name of the Java class that provides the RDBMS Workflow Element implementation. -
ds-cfg-password-attribute(optional):
string
Specifies the attribute type used to hold user passwords.
-
ds-cfg-password-storage-scheme(optional):
string
Specifies the names of the password storage schemes that are used to encode clear-text passwords for this password policy.
-
ds-cfg-rdbms-extension:
string
An RDBMS Extension contains the login details for connecting to the database. The Extension maintains a Connection Pool which is shared by all workflow elements referencing the extension.
-
ds-cfg-suffix:
string
suffix DN of all entries stored by this workflow element
-
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
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : RDBMS 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 : RDBMS Workflow Element SearchResultEntry
Type:
Show Source
object
-
attributes:
object RDBMS Workflow Element Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : RDBMS Workflow Element Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-cache-invalidation-interval(optional):
string
Default Value:
60000ms
The lifetime of cached objects. This property is used when the cache invalidation property is set to 'ttl-cache-invalidation-policy'. -
ds-cfg-cache-invalidation-policy(optional):
string
Default Value:
no-expiry-cache-invalidation-policy
Allowed Values:[ "no-expiry-cache-invalidation-policy", "ttl-cache-invalidation-policy" ]
The policy that must be used to invalidate the cached data. -
ds-cfg-cache-size(optional):
integer(int32)
Default Value:
1000
The number of database records to be cached. -
ds-cfg-caching-scheme(optional):
string
Default Value:
none
Allowed Values:[ "full", "hard-weak", "none", "soft", "soft-weak", "weak" ]
Select the scheme that must be used to cache database records. "none" is the recommended default. -
ds-cfg-enabled:
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-java-class:
string
Default Value:
com.oracle.dps.server.workflowelement.rdbms.RDBMSWorkflowElement
Specifies the fully-qualified name of the Java class that provides the RDBMS Workflow Element implementation. -
ds-cfg-password-attribute(optional):
string
Specifies the attribute type used to hold user passwords.
-
ds-cfg-password-storage-scheme(optional):
string
Specifies the names of the password storage schemes that are used to encode clear-text passwords for this password policy.
-
ds-cfg-rdbms-extension:
string
An RDBMS Extension contains the login details for connecting to the database. The Extension maintains a Connection Pool which is shared by all workflow elements referencing the extension.
-
ds-cfg-suffix:
string
suffix DN of all entries stored by this workflow element
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
201 Response
Created
Root Schema : RDBMS 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 : RDBMS Workflow Element SearchResultEntry
Type:
Show Source
object
-
attributes:
object RDBMS Workflow Element Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : RDBMS Workflow Element Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-cache-invalidation-interval(optional):
string
Default Value:
60000ms
The lifetime of cached objects. This property is used when the cache invalidation property is set to 'ttl-cache-invalidation-policy'. -
ds-cfg-cache-invalidation-policy(optional):
string
Default Value:
no-expiry-cache-invalidation-policy
Allowed Values:[ "no-expiry-cache-invalidation-policy", "ttl-cache-invalidation-policy" ]
The policy that must be used to invalidate the cached data. -
ds-cfg-cache-size(optional):
integer(int32)
Default Value:
1000
The number of database records to be cached. -
ds-cfg-caching-scheme(optional):
string
Default Value:
none
Allowed Values:[ "full", "hard-weak", "none", "soft", "soft-weak", "weak" ]
Select the scheme that must be used to cache database records. "none" is the recommended default. -
ds-cfg-enabled:
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-java-class:
string
Default Value:
com.oracle.dps.server.workflowelement.rdbms.RDBMSWorkflowElement
Specifies the fully-qualified name of the Java class that provides the RDBMS Workflow Element implementation. -
ds-cfg-password-attribute(optional):
string
Specifies the attribute type used to hold user passwords.
-
ds-cfg-password-storage-scheme(optional):
string
Specifies the names of the password storage schemes that are used to encode clear-text passwords for this password policy.
-
ds-cfg-rdbms-extension:
string
An RDBMS Extension contains the login details for connecting to the database. The Extension maintains a Connection Pool which is shared by all workflow elements referencing the extension.
-
ds-cfg-suffix:
string
suffix DN of all entries stored by this workflow element
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
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