Jump to

• Request
• Response

Get Device Interfaces by Logical Device

get

/logicalDevice/{id}/deviceInterfaces

Gets all device interfaces that match the search criteria specified in the query parameters.

Attribute selection is enabled for all first-level attributes.

The filtering criteria can include:

• interfaceNumber
• vendorInterfaceNumber
• customerInterfaceNumber
• roles.roleName
• rateCode

For information about the filter operators, see Get Resources.

Optionally, use the expand parameter to specify any resource relationships (resourceRelationship.PARENT, resourceRelationship.CHILD, resourceRelationship.ASSOCIATES, resourceRelationship.INVOLVE, resourceRelationship.MAPPEDTO, resourceRelationship.ASSIGN) that you want to see details for. By default, you'll just see links for these.

Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.

For information about sorting details, see Get Resources.

Request

Path Parameters

• id(required): string
  The ID of the logical device.

Query Parameters

• depth: integer
  The depth of the expansion.

  Default Value: 0
• expand: string
  The additional details to include in the response.
• fields: string
  The fields to include in the response.
• limit: integer
  The number of items to return.

  Default Value: 200
• offset: integer
  The number of items to skip before starting to collect the result set.

  Default Value: 0
• sort: string
  The fields to sort.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The device interfaces were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: DeviceInterface
  A device interface.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DeviceInterface"
    }
}

Nested Schema : DeviceInterface

A device interface.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object DeviceInterface-allOf[1]

{
    "description":"A device interface.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "rateCode":{
                    "type":"string",
                    "description":"The technology and transmission bit rate supported by the interface.",
                    "readOnly":true
                },
                "bitRate":{
                    "type":"string",
                    "description":"The bitrate speed of transmission identified by the rate code.",
                    "readOnly":true
                },
                "interfaceNumber":{
                    "type":"string",
                    "description":"A value intended to uniquely identify this device interface from all other instances. Oracle Communications product software does not ensure the uniqueness of interfaceNumber values."
                },
                "customerInterfaceNumber":{
                    "type":"string",
                    "description":"The customer defined name for the device interface. Per the SID, this is the number of this particular device interface using a naming methodology defined by the customer."
                },
                "vendorInterfaceNumber":{
                    "type":"string"
                },
                "logicalDeviceRef":{
                    "$ref":"#/components/schemas/LogicalDevice"
                },
                "parentDeviceInterfaceRef":{
                    "$ref":"#/components/schemas/DeviceInterface"
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of device interface roles."
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe" ]

  The list of valid values for the resource type.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : DeviceInterface-allOf[1]

Type: object

Show Source

• bitRate: string
  Read Only: true

  The bitrate speed of transmission identified by the rate code.
• customerInterfaceNumber: string
  The customer defined name for the device interface. Per the SID, this is the number of this particular device interface using a naming methodology defined by the customer.
• interfaceNumber: string
  A value intended to uniquely identify this device interface from all other instances. Oracle Communications product software does not ensure the uniqueness of interfaceNumber values.
• logicalDeviceRef: schema
  A logical device.
• parentDeviceInterfaceRef: DeviceInterface
  A device interface.
• rateCode: string
  Read Only: true

  The technology and transmission bit rate supported by the interface.
• roles: array roles
  The list of device interface roles.
• vendorInterfaceNumber: string

{
    "type":"object",
    "properties":{
        "rateCode":{
            "type":"string",
            "description":"The technology and transmission bit rate supported by the interface.",
            "readOnly":true
        },
        "bitRate":{
            "type":"string",
            "description":"The bitrate speed of transmission identified by the rate code.",
            "readOnly":true
        },
        "interfaceNumber":{
            "type":"string",
            "description":"A value intended to uniquely identify this device interface from all other instances. Oracle Communications product software does not ensure the uniqueness of interfaceNumber values."
        },
        "customerInterfaceNumber":{
            "type":"string",
            "description":"The customer defined name for the device interface. Per the SID, this is the number of this particular device interface using a naming methodology defined by the customer."
        },
        "vendorInterfaceNumber":{
            "type":"string"
        },
        "logicalDeviceRef":{
            "$ref":"#/components/schemas/LogicalDevice"
        },
        "parentDeviceInterfaceRef":{
            "$ref":"#/components/schemas/DeviceInterface"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of device interface roles."
        }
    }
}

Nested Schema : schema

A logical device.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A logical device.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "vendorName":{
                    "type":"string",
                    "description":"The vendor name for the logical device."
                },
                "modelNumber":{
                    "type":"string",
                    "description":"The model number for the logical device."
                },
                "partNumber":{
                    "type":"string",
                    "description":"The part number for the logical device."
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "serviceLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "deviceIdentifier":{
                    "type":"string",
                    "description":"The name of the device identifier."
                },
                "capacityConsumed":{
                    "type":"string",
                    "description":"The capacity of the logical device consumed."
                },
                "totalCapacity":{
                    "type":"string",
                    "description":"Total capacity of the logical device."
                },
                "percentageConsumed":{
                    "type":"string",
                    "description":"Percentage of the logical device's capacity consumed."
                },
                "deviceInterfaces":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of device interfaces for the logical device."
                },
                "logicalDeviceAccounts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of logical device accounts associated with the logical device."
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of logical device roles."
                }
            }
        }
    ]
}

Nested Schema : roles

Type: array

The list of device interface roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of device interface roles."
}

Nested Schema : type

Type: object

Show Source

• capacityConsumed: string
  The capacity of the logical device consumed.
• deviceIdentifier: string
  The name of the device identifier.
• deviceInterfaces: string (uri)
  The URI for the list of device interfaces for the logical device.
• logicalDeviceAccounts: string (uri)
  The URI for the list of logical device accounts associated with the logical device.
• modelNumber: string
  The model number for the logical device.
• networkLocation: object PlaceRef
  A place to associate with the resource/service.
• partNumber: string
  The part number for the logical device.
• percentageConsumed: string
  Percentage of the logical device's capacity consumed.
• roles: array roles
  The list of logical device roles.
• serviceLocation: object PlaceRef
  A place to associate with the resource/service.
• totalCapacity: string
  Total capacity of the logical device.
• vendorName: string
  The vendor name for the logical device.

{
    "type":"object",
    "properties":{
        "vendorName":{
            "type":"string",
            "description":"The vendor name for the logical device."
        },
        "modelNumber":{
            "type":"string",
            "description":"The model number for the logical device."
        },
        "partNumber":{
            "type":"string",
            "description":"The part number for the logical device."
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "serviceLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "deviceIdentifier":{
            "type":"string",
            "description":"The name of the device identifier."
        },
        "capacityConsumed":{
            "type":"string",
            "description":"The capacity of the logical device consumed."
        },
        "totalCapacity":{
            "type":"string",
            "description":"Total capacity of the logical device."
        },
        "percentageConsumed":{
            "type":"string",
            "description":"Percentage of the logical device's capacity consumed."
        },
        "deviceInterfaces":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of device interfaces for the logical device."
        },
        "logicalDeviceAccounts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of logical device accounts associated with the logical device."
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of logical device roles."
        }
    }
}

Nested Schema : PlaceRef

Type: object

A place to associate with the resource/service.

Show Source

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : roles

Type: array

The list of logical device roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of logical device roles."
}

Nested Schema : Role

Type: object

A role.

Show Source

• roleName: string
  The name of the role.
• roleType: string
  Allowed Values: [ "NONE", "TECHNOLOGY", "FUNCTION", "TOPOLOGY", "TARGET" ]

  The type of role.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

206 Response

A range of device interfaces were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: DeviceInterface
  A device interface.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DeviceInterface"
    }
}

Nested Schema : DeviceInterface

A device interface.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object DeviceInterface-allOf[1]

{
    "description":"A device interface.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "rateCode":{
                    "type":"string",
                    "description":"The technology and transmission bit rate supported by the interface.",
                    "readOnly":true
                },
                "bitRate":{
                    "type":"string",
                    "description":"The bitrate speed of transmission identified by the rate code.",
                    "readOnly":true
                },
                "interfaceNumber":{
                    "type":"string",
                    "description":"A value intended to uniquely identify this device interface from all other instances. Oracle Communications product software does not ensure the uniqueness of interfaceNumber values."
                },
                "customerInterfaceNumber":{
                    "type":"string",
                    "description":"The customer defined name for the device interface. Per the SID, this is the number of this particular device interface using a naming methodology defined by the customer."
                },
                "vendorInterfaceNumber":{
                    "type":"string"
                },
                "logicalDeviceRef":{
                    "$ref":"#/components/schemas/LogicalDevice"
                },
                "parentDeviceInterfaceRef":{
                    "$ref":"#/components/schemas/DeviceInterface"
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of device interface roles."
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe" ]

  The list of valid values for the resource type.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : DeviceInterface-allOf[1]

Type: object

Show Source

• bitRate: string
  Read Only: true

  The bitrate speed of transmission identified by the rate code.
• customerInterfaceNumber: string
  The customer defined name for the device interface. Per the SID, this is the number of this particular device interface using a naming methodology defined by the customer.
• interfaceNumber: string
  A value intended to uniquely identify this device interface from all other instances. Oracle Communications product software does not ensure the uniqueness of interfaceNumber values.
• logicalDeviceRef: schema
  A logical device.
• parentDeviceInterfaceRef: DeviceInterface
  A device interface.
• rateCode: string
  Read Only: true

  The technology and transmission bit rate supported by the interface.
• roles: array roles
  The list of device interface roles.
• vendorInterfaceNumber: string

{
    "type":"object",
    "properties":{
        "rateCode":{
            "type":"string",
            "description":"The technology and transmission bit rate supported by the interface.",
            "readOnly":true
        },
        "bitRate":{
            "type":"string",
            "description":"The bitrate speed of transmission identified by the rate code.",
            "readOnly":true
        },
        "interfaceNumber":{
            "type":"string",
            "description":"A value intended to uniquely identify this device interface from all other instances. Oracle Communications product software does not ensure the uniqueness of interfaceNumber values."
        },
        "customerInterfaceNumber":{
            "type":"string",
            "description":"The customer defined name for the device interface. Per the SID, this is the number of this particular device interface using a naming methodology defined by the customer."
        },
        "vendorInterfaceNumber":{
            "type":"string"
        },
        "logicalDeviceRef":{
            "$ref":"#/components/schemas/LogicalDevice"
        },
        "parentDeviceInterfaceRef":{
            "$ref":"#/components/schemas/DeviceInterface"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of device interface roles."
        }
    }
}

Nested Schema : schema

A logical device.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A logical device.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "vendorName":{
                    "type":"string",
                    "description":"The vendor name for the logical device."
                },
                "modelNumber":{
                    "type":"string",
                    "description":"The model number for the logical device."
                },
                "partNumber":{
                    "type":"string",
                    "description":"The part number for the logical device."
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "serviceLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "deviceIdentifier":{
                    "type":"string",
                    "description":"The name of the device identifier."
                },
                "capacityConsumed":{
                    "type":"string",
                    "description":"The capacity of the logical device consumed."
                },
                "totalCapacity":{
                    "type":"string",
                    "description":"Total capacity of the logical device."
                },
                "percentageConsumed":{
                    "type":"string",
                    "description":"Percentage of the logical device's capacity consumed."
                },
                "deviceInterfaces":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of device interfaces for the logical device."
                },
                "logicalDeviceAccounts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of logical device accounts associated with the logical device."
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of logical device roles."
                }
            }
        }
    ]
}

Nested Schema : roles

Type: array

The list of device interface roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of device interface roles."
}

Nested Schema : type

Type: object

Show Source

• capacityConsumed: string
  The capacity of the logical device consumed.
• deviceIdentifier: string
  The name of the device identifier.
• deviceInterfaces: string (uri)
  The URI for the list of device interfaces for the logical device.
• logicalDeviceAccounts: string (uri)
  The URI for the list of logical device accounts associated with the logical device.
• modelNumber: string
  The model number for the logical device.
• networkLocation: object PlaceRef
  A place to associate with the resource/service.
• partNumber: string
  The part number for the logical device.
• percentageConsumed: string
  Percentage of the logical device's capacity consumed.
• roles: array roles
  The list of logical device roles.
• serviceLocation: object PlaceRef
  A place to associate with the resource/service.
• totalCapacity: string
  Total capacity of the logical device.
• vendorName: string
  The vendor name for the logical device.

{
    "type":"object",
    "properties":{
        "vendorName":{
            "type":"string",
            "description":"The vendor name for the logical device."
        },
        "modelNumber":{
            "type":"string",
            "description":"The model number for the logical device."
        },
        "partNumber":{
            "type":"string",
            "description":"The part number for the logical device."
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "serviceLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "deviceIdentifier":{
            "type":"string",
            "description":"The name of the device identifier."
        },
        "capacityConsumed":{
            "type":"string",
            "description":"The capacity of the logical device consumed."
        },
        "totalCapacity":{
            "type":"string",
            "description":"Total capacity of the logical device."
        },
        "percentageConsumed":{
            "type":"string",
            "description":"Percentage of the logical device's capacity consumed."
        },
        "deviceInterfaces":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of device interfaces for the logical device."
        },
        "logicalDeviceAccounts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of logical device accounts associated with the logical device."
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of logical device roles."
        }
    }
}

Nested Schema : PlaceRef

Type: object

A place to associate with the resource/service.

Show Source

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : roles

Type: array

The list of logical device roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of logical device roles."
}

Nested Schema : Role

Type: object

A role.

Show Source

• roleName: string
  The name of the role.
• roleType: string
  Allowed Values: [ "NONE", "TECHNOLOGY", "FUNCTION", "TOPOLOGY", "TARGET" ]

  The type of role.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

400 Response

The request isn't valid.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

401 Response

You aren't authorized to make this request.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

403 Response

The request is forbidden.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

404 Response

The device interfaces weren't found.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

500 Response

An internal server error occurred.

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).

Show Source

• code: string
  The error code.
• entityType: string
  Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]

  The list of valid values for an entity class.
• message: array message
  The text that provides more details about the error as well as corrective actions.
• reason: string
  The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
• referenceError: string
  The URL pointing to the documentation that describes the error.
• status: string
  The HTTP error code extension, such as 400-2.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

Back to Top