Jump to

• Request
• Response

Get an Inclusion Profile by ID

get

/api/discovery/Includes/{id}

Gets the inclusion profile that matches the specified ID.

Request

Path Parameters

• id(required): integer
  The discovery profile ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The properties of the specified inclusion profile.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/discoveryIncludesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the specified inclusion profile.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The properties of the specified inclusion profile.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/discoveryIncludesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the specified inclusion profile.

Show Source

• Array of: object discoveryIncludesRead

{
    "description":"The properties of the specified inclusion profile.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/discoveryIncludesRead"
    }
}

Nested Schema : discoveryIncludesRead

Type: object

Show Source

• BaseDN: string
  The LDAP base domain name.

  Example: DC=localdomain,DC=local
• CDPSeeds: string
  The CDP seeds. For example, 10.10.10.1,hostname,172.16.10.1.

  Example: oracle.doceng.json.BetterJsonNull@4e26040f
• CIDR: string
  The type of range expansion. Allowed Values:

  • 1: Glob expansion
  • 2: CIDR expansion

  Example: oracle.doceng.json.BetterJsonNull@5065bdac
• CIDRFlag: string
  Whether to use CIDR (Enabled) or not (Disabled).

  Example: oracle.doceng.json.BetterJsonNull@9a07409
• DeviceZoneID: object DeviceZoneID
  The device zone name and ID.
• DeviceZoneName: string
  The device zone name.

  Example: Default First Zone
• Hops: integer
  The number of iterations for CDP discovery.

  Example: oracle.doceng.json.BetterJsonNull@477bea57
• IPRange: string
  The IP Range (for example, 10.*.0-9.1,2,3,4 for glob expansion; 172.16.10.0/24 for CIDR expansion).

  Example: 10.*.0-9.1
• ProfileID: integer
  The discovery profile ID for individual CRUD operations.

  Example: 3
• ProfileName: string
  The discovery profile name.

  Example: Example Active Directory Scan
• ProfileStatus:
  The profile status. The allowed values are:

  • Enabled
  • Disabled

  Example: Disabled
• ProfileStatusIcon: string
  The profile status icon.

  Example: OrbRed.png
• ProfileStatusID: integer
  The profile status ID. Either 0 (disabled) or 1 (enabled).

  Example: 0
• ProfileType: string
  The profile type. Allowed Values:

  • Ping Scan
  • Seed Scan>
  • LDAP Scan
  • CDP Scan

  Example: LDAP Scan
• ProfileTypeID: integer
  The profile type ID. Allowed Values:

  • 1: Ping Scan
  • 2: Seed Scan
  • 3: LDAP Scan
  • 4: CDP Scan

  Example: 3
• Query: string
  The LDAP query text to produce server names.

  Example: (objectClass=computer)
• Seeds: string
  The seeds. For example, 10.10.10.1,hostname,172.16.10.1.

  Example: oracle.doceng.json.BetterJsonNull@6705b763
• ServerName: string
  The LDAP server FQDN host or IP address.

  Example: ldap.localdomain.local
• ServerPort: integer
  The LDAP server port (TCP only).

  Example: 389
• UserDN: string
  The LDAP base user name.

  Example: monolith@localhost
• UserPass: string
  The LDAP base user password.

  Example: password

{
    "type":"object",
    "properties":{
        "ProfileTypeID":{
            "description":"The profile type ID.\nAllowed Values:\n<ul><li><b>1</b>: Ping Scan</li>\n<li><b>2</b>: Seed Scan</li>\n<li><b>3</b>: LDAP Scan</li>\n<li><b>4</b>: CDP Scan</li></ul>",
            "type":"integer",
            "example":"3"
        },
        "DeviceZoneID":{
            "description":"The device zone name and ID.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The device zone ID.",
                    "type":"integer",
                    "example":"1"
                },
                "name":{
                    "description":"The device zone name associated with the specified <b>id</b>.",
                    "type":"string",
                    "example":"Default First Zone"
                }
            }
        },
        "CDPSeeds":{
            "description":"The CDP seeds. For example, <b>10.10.10.1,hostname,172.16.10.1</b>.",
            "type":"string",
            "nullable":true,
            "example":null
        },
        "Seeds":{
            "description":"The seeds. For example, <b>10.10.10.1,hostname,172.16.10.1</b>.",
            "type":"string",
            "example":null
        },
        "Hops":{
            "description":"The number of iterations for CDP discovery.",
            "type":"integer",
            "nullable":true,
            "example":null
        },
        "ServerName":{
            "description":"The LDAP server FQDN host or IP address.",
            "type":"string",
            "example":"ldap.localdomain.local"
        },
        "ServerPort":{
            "description":"The LDAP server port (TCP only).",
            "type":"integer",
            "example":389
        },
        "BaseDN":{
            "description":"The LDAP base domain name.",
            "type":"string",
            "example":"DC=localdomain,DC=local"
        },
        "UserDN":{
            "description":"The LDAP base user name.",
            "type":"string",
            "example":"monolith@localhost"
        },
        "UserPass":{
            "description":"The LDAP base user password.",
            "type":"string",
            "example":"password"
        },
        "Query":{
            "description":"The LDAP query text to produce server names.",
            "type":"string",
            "example":"(objectClass=computer)"
        },
        "IPRange":{
            "description":"The IP Range (for example, 10.*.0-9.1,2,3,4 for glob expansion; 172.16.10.0/24 for CIDR expansion).",
            "type":"string",
            "example":"10.*.0-9.1"
        },
        "CIDR":{
            "description":"The type of range expansion.\nAllowed Values:\n<ul><li><b>1</b>: Glob expansion</li>\n<li><b>2</b>: CIDR expansion</li></ul>",
            "type":"string",
            "example":null
        },
        "CIDRFlag":{
            "description":"Whether to use CIDR (<b>Enabled</b>) or not (<b>Disabled</b>).",
            "type":"string",
            "nullable":true,
            "example":null
        },
        "ProfileID":{
            "description":"The discovery profile ID for individual CRUD operations.",
            "type":"integer",
            "example":"3"
        },
        "ProfileName":{
            "description":"The discovery profile name.",
            "type":"string",
            "example":"Example Active Directory Scan"
        },
        "ProfileStatusID":{
            "description":"The profile status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"0"
        },
        "ProfileStatusIcon":{
            "description":"The profile status icon.",
            "type":"string",
            "example":"OrbRed.png"
        },
        "ProfileStatus":{
            "description":"The profile status. The allowed values are:\n<ul><li>Enabled</li>\n<li>Disabled</li></ul>",
            "example":"Disabled"
        },
        "ProfileType":{
            "description":"The profile type.\nAllowed Values:\n<ul><li>Ping Scan</li>\n<li>Seed Scan></li>\n<li>LDAP Scan</li>\n<li>CDP Scan</li></ul>",
            "type":"string",
            "example":"LDAP Scan"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        }
    }
}

Nested Schema : DeviceZoneID

Type: object

The device zone name and ID.

Show Source

• id: integer
  The device zone ID.

  Example: 1
• name: string
  The device zone name associated with the specified id.

  Example: Default First Zone

{
    "description":"The device zone name and ID.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The device zone ID.",
            "type":"integer",
            "example":"1"
        },
        "name":{
            "description":"The device zone name associated with the specified <b>id</b>.",
            "type":"string",
            "example":"Default First Zone"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top