Jump to

• Request
• Response

Find Transformations Workflow Element by DN

get

/rest/v1/admin/{dn}

Returns an Transformations Workflow Element by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be fetched.

Query Parameters

• attributes: array
  Collection Format: multi

  List of attributes to be fetched for the entry.

  • [0]: string

  {
      "name":"attributes",
      "in":"query",
      "description":"List of attributes to be fetched for the entry.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• controls: array
  Collection Format: multi

  LDAP controls to be sent to server for search operation.

  • [0]: string

  {
      "name":"controls",
      "in":"query",
      "description":"LDAP controls to be sent to server for search operation.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• filter: string
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
• scope: string
  Scope for the LDAP search operation.

  Allowed Values: [ "base", "sub", "one" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Transformations Workflow Element GetSuccessResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  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",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "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"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object Transformations Workflow Element SearchResultEntry

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

Nested Schema : Transformations Workflow Element SearchResultEntry

Type: object

Show Source

• attributes: object Transformations Workflow Element 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/Transformations Workflow Element Properties"
        }
    }
}

Nested Schema : Transformations Workflow Element Properties

Type: object

Show Source

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

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

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

• Array of: string

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

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: [ "add", "bind", "compare", "delete", "extended", "modify", "modifydn", "search" ]

Show Source

• Array of: string

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

Nested Schema : ds-cfg-transformation

Type: array

Specifies the transformations that are applied.

Show Source

• Array of: string

{
    "description":"Specifies the transformations that are applied. ",
    "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"
    }
}

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