Jump to

• Request
• Response

Add, Search, Compare or Delete RDBMS Table

post

/rest/v1/admin

Add, Search, Compare or Delete RDBMS Table

Request

Supported Media Types

• application/json

Body ()

RDBMS Table that needs to be created

Root Schema : RDBMS Table POSTRequest

Type: object

Show Source

• 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 Table 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.

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "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"
            ]
        },
        "dn":{
            "description":"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.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/RDBMS Table Properties"
        },
        "base":{
            "description":"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",
            "type":"string"
        },
        "scope":{
            "description":"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.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"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.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"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.",
            "type":"string"
        }
    }
}

Nested Schema : RDBMS Table Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-cascade-delete-on-relation(optional): boolean
  Default Value: false

  whether deletes should be cascaded or not
• ds-cfg-db-schema-name(optional): string
  Name of the RDBMS Schema
• ds-cfg-db-sequence-name(optional): string
  This configuration parameter specifies the database sequence to generate primary key field value in case if the database does not support identity.
• ds-cfg-db-table-name: string
  Name of the RDBMS Table
• ds-cfg-join-rule(optional): string
  join rules
• ds-cfg-join-type(optional): string
  Allowed Values: [ "many-to-one", "one-to-many", "one-to-one" ]

  Type of join between this table and the table implied by the join condition
• ds-cfg-outer-join-required(optional): boolean
  Default Value: true

  whether we should do an outer join or not
• ds-cfg-primary-key-field: array ds-cfg-primary-key-field
  primary key field
• ds-cfg-primary-key-storability: boolean
  Default Value: true

  This configuration parameter decides whether the Primary Key of this table can contain user provided values. If set to "True", values can be inserted into this column by end-users. In case of auto-generated Primary Keys, set this parameter to "false"
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-primary-key-field",
        "ds-cfg-primary-key-storability",
        "ds-cfg-db-table-name"
    ],
    "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-primary-key-field":{
            "description":"primary key field ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-join-type":{
            "description":"Type of join between this table and the table implied by the join condition ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one"
            ]
        },
        "ds-cfg-primary-key-storability":{
            "description":"This configuration parameter decides whether the Primary Key of this table can contain user provided values. If set to \"True\", values can be inserted into this column by end-users. In case of auto-generated Primary Keys, set this parameter to \"false\" ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-sequence-name":{
            "description":"This configuration parameter specifies the database sequence to generate primary key field value in case if the database does not support identity. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-join-rule":{
            "description":"join rules ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-db-table-name":{
            "description":"Name of the RDBMS Table ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-cascade-delete-on-relation":{
            "description":"whether deletes should be cascaded or not ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-schema-name":{
            "description":"Name of the RDBMS Schema ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-outer-join-required":{
            "description":"whether we should do an outer join or not ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

Nested Schema : controls

Type: array

LDAP controls to be sent to server for the LDAP operation.

Show Source

• Array of: string

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

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

• Array of: string

{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-primary-key-field

Type: array

primary key field

Show Source

• Array of: string

{
    "description":"primary key field ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : RDBMS Table SuccessResponse

Type: object

Show Source

• 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.

{
    "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/RDBMS Table SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object RDBMS Table SearchResultEntry

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

Nested Schema : RDBMS Table SearchResultEntry

Type: object

Show Source

• attributes: object RDBMS Table Properties
• dn: string
  LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/RDBMS Table Properties"
        }
    }
}

Nested Schema : RDBMS Table Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-cascade-delete-on-relation(optional): boolean
  Default Value: false

  whether deletes should be cascaded or not
• ds-cfg-db-schema-name(optional): string
  Name of the RDBMS Schema
• ds-cfg-db-sequence-name(optional): string
  This configuration parameter specifies the database sequence to generate primary key field value in case if the database does not support identity.
• ds-cfg-db-table-name: string
  Name of the RDBMS Table
• ds-cfg-join-rule(optional): string
  join rules
• ds-cfg-join-type(optional): string
  Allowed Values: [ "many-to-one", "one-to-many", "one-to-one" ]

  Type of join between this table and the table implied by the join condition
• ds-cfg-outer-join-required(optional): boolean
  Default Value: true

  whether we should do an outer join or not
• ds-cfg-primary-key-field: array ds-cfg-primary-key-field
  primary key field
• ds-cfg-primary-key-storability: boolean
  Default Value: true

  This configuration parameter decides whether the Primary Key of this table can contain user provided values. If set to "True", values can be inserted into this column by end-users. In case of auto-generated Primary Keys, set this parameter to "false"
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-primary-key-field",
        "ds-cfg-primary-key-storability",
        "ds-cfg-db-table-name"
    ],
    "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-primary-key-field":{
            "description":"primary key field ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-join-type":{
            "description":"Type of join between this table and the table implied by the join condition ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one"
            ]
        },
        "ds-cfg-primary-key-storability":{
            "description":"This configuration parameter decides whether the Primary Key of this table can contain user provided values. If set to \"True\", values can be inserted into this column by end-users. In case of auto-generated Primary Keys, set this parameter to \"false\" ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-sequence-name":{
            "description":"This configuration parameter specifies the database sequence to generate primary key field value in case if the database does not support identity. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-join-rule":{
            "description":"join rules ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-db-table-name":{
            "description":"Name of the RDBMS Table ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-cascade-delete-on-relation":{
            "description":"whether deletes should be cascaded or not ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-schema-name":{
            "description":"Name of the RDBMS Schema ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-outer-join-required":{
            "description":"whether we should do an outer join or not ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-primary-key-field

Type: array

primary key field

Show Source

• Array of: string

{
    "description":"primary key field ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

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

201 Response

Created

Body ()

Root Schema : RDBMS Table ADDResponse

Type: object

Show Source

• 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.

{
    "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/RDBMS Table SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

• Array of: object RDBMS Table SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RDBMS Table SearchResultEntry"
    }
}

Nested Schema : RDBMS Table SearchResultEntry

Type: object

Show Source

• attributes: object RDBMS Table Properties
• dn: string
  LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/RDBMS Table Properties"
        }
    }
}

Nested Schema : RDBMS Table Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-cascade-delete-on-relation(optional): boolean
  Default Value: false

  whether deletes should be cascaded or not
• ds-cfg-db-schema-name(optional): string
  Name of the RDBMS Schema
• ds-cfg-db-sequence-name(optional): string
  This configuration parameter specifies the database sequence to generate primary key field value in case if the database does not support identity.
• ds-cfg-db-table-name: string
  Name of the RDBMS Table
• ds-cfg-join-rule(optional): string
  join rules
• ds-cfg-join-type(optional): string
  Allowed Values: [ "many-to-one", "one-to-many", "one-to-one" ]

  Type of join between this table and the table implied by the join condition
• ds-cfg-outer-join-required(optional): boolean
  Default Value: true

  whether we should do an outer join or not
• ds-cfg-primary-key-field: array ds-cfg-primary-key-field
  primary key field
• ds-cfg-primary-key-storability: boolean
  Default Value: true

  This configuration parameter decides whether the Primary Key of this table can contain user provided values. If set to "True", values can be inserted into this column by end-users. In case of auto-generated Primary Keys, set this parameter to "false"
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-primary-key-field",
        "ds-cfg-primary-key-storability",
        "ds-cfg-db-table-name"
    ],
    "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-primary-key-field":{
            "description":"primary key field ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-join-type":{
            "description":"Type of join between this table and the table implied by the join condition ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one"
            ]
        },
        "ds-cfg-primary-key-storability":{
            "description":"This configuration parameter decides whether the Primary Key of this table can contain user provided values. If set to \"True\", values can be inserted into this column by end-users. In case of auto-generated Primary Keys, set this parameter to \"false\" ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-sequence-name":{
            "description":"This configuration parameter specifies the database sequence to generate primary key field value in case if the database does not support identity. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-join-rule":{
            "description":"join rules ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-db-table-name":{
            "description":"Name of the RDBMS Table ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-cascade-delete-on-relation":{
            "description":"whether deletes should be cascaded or not ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-schema-name":{
            "description":"Name of the RDBMS Schema ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-outer-join-required":{
            "description":"whether we should do an outer join or not ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-primary-key-field

Type: array

primary key field

Show Source

• Array of: string

{
    "description":"primary key field ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

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

204 Response

No content

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• 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

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

Back to Top