Jump to

• Request
• Response

Find Workflow by DN

get

/rest/v1/admin/{dn}

Returns an Workflow 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 : Workflow 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/Workflow SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object Workflow SearchResultEntry

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

Nested Schema : Workflow SearchResultEntry

Type: object

Show Source

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

Nested Schema : Workflow Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-access-control-group(optional): string
  Specifies the access control group used by the Workflow.
• ds-cfg-base-dn(optional): string
  Read Only: true

  Specifies the base DN of the data targeted by the Workflow .
• ds-cfg-criticality(optional): string
  Default Value: true

  Allowed Values: [ "false", "partial", "true" ]

  The criticality determines the behavior to adopt when one of the workflow elements belonging to a workflow returns an UNAVAILABLE result code during the execution of a search operation.
• ds-cfg-enabled: boolean
  Indicates whether the Workflow is enabled for use in the server.
• ds-cfg-filters-to-exclude(optional): array ds-cfg-filters-to-exclude
  The filters to exclude are filters of a filter and apply to the search filters specified in the search operation. It is specified as search filters and scope(optional) separated by # e.g. (objectClass=*)#sub. In case of no scope mentioned it will take default value one as scope.
• ds-cfg-filters-to-include(optional): array ds-cfg-filters-to-include
  The filters to include are filters of a filter and apply to the search filters specified in the search operation. It is specified as search filters and scope(optional) separated by # e.g. (objectClass=*)#sub. In case of no scope mentioned it will take default value sub as scope.
• ds-cfg-virtual-aci-mode(optional): boolean
  Default Value: false

  Indicates whether the Workflow uses the virtual acis.
• ds-cfg-workflow-element: string
  Specifies the root Workflow Element in the Workflow .
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-workflow-element",
        "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-filters-to-include":{
            "description":"The filters to include are filters of a filter and apply to the search filters specified in the search operation. It is specified as search filters and scope(optional) separated by # e.g. (objectClass=*)#sub. In case of no scope mentioned it will take default value sub as scope. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-virtual-aci-mode":{
            "description":"Indicates whether the Workflow uses the virtual acis. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-workflow-element":{
            "description":"Specifies the root Workflow Element in the Workflow . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-criticality":{
            "description":"The criticality determines the behavior to adopt when one of the workflow elements belonging to a workflow returns an UNAVAILABLE result code during the execution of a search operation. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        },
        "ds-cfg-access-control-group":{
            "description":"Specifies the access control group used by the Workflow. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN of the data targeted by the Workflow . ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-filters-to-exclude":{
            "description":"The filters to exclude are filters of a filter and apply to the search filters specified in the search operation. It is specified as search filters and scope(optional) separated by # e.g. (objectClass=*)#sub. In case of no scope mentioned it will take default value one as scope. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-filters-to-exclude

Type: array

The filters to exclude are filters of a filter and apply to the search filters specified in the search operation. It is specified as search filters and scope(optional) separated by # e.g. (objectClass=*)#sub. In case of no scope mentioned it will take default value one as scope.

Show Source

• Array of: string

{
    "description":"The filters to exclude are filters of a filter and apply to the search filters specified in the search operation. It is specified as search filters and scope(optional) separated by # e.g. (objectClass=*)#sub. In case of no scope mentioned it will take default value one as scope. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-filters-to-include

Type: array

The filters to include are filters of a filter and apply to the search filters specified in the search operation. It is specified as search filters and scope(optional) separated by # e.g. (objectClass=*)#sub. In case of no scope mentioned it will take default value sub as scope.

Show Source

• Array of: string

{
    "description":"The filters to include are filters of a filter and apply to the search filters specified in the search operation. It is specified as search filters and scope(optional) separated by # e.g. (objectClass=*)#sub. In case of no scope mentioned it will take default value sub as scope. ",
    "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