Jump to

• Request
• Response

Get Impacted Components for the Physical Device Resource outage

get

/impactAnalysis/physicalDeviceImpacts/{id}

Retrieves a list of impacted components associated with the specified logical device resource outage.

Request

Path Parameters

• id(required): string
  The ID of the Physical Device to fetch the impacts of Physical Device outage.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The outage impacts were retrieved successfully.

Body ()

Root Schema : PhysicalDeviceOutageImpacts

Type: object

Details of entities impacted by an outage of physical device.

Show Source

• impacts: array impacts
  List of impacted entities by an outage of physical device.
• physicalDeviceId: string
  Unique identifier of the impacted physical device.
• physicalDeviceName: string
  Name of the impacted physical device.

{
    "type":"object",
    "description":"Details of entities impacted by an outage of physical device.",
    "properties":{
        "physicalDeviceId":{
            "type":"string",
            "description":"Unique identifier of the impacted physical device."
        },
        "physicalDeviceName":{
            "type":"string",
            "description":"Name of the impacted physical device."
        },
        "impacts":{
            "type":"array",
            "description":"List of impacted entities by an outage of physical device.",
            "items":{
                "$ref":"#/components/schemas/OutageImpactEntity"
            }
        }
    }
}

Nested Schema : impacts

Type: array

List of impacted entities by an outage of physical device.

Show Source

• Array of: object OutageImpactEntity
  Detailed information about an entity impacted by an outage.

{
    "type":"array",
    "description":"List of impacted entities by an outage of physical device.",
    "items":{
        "$ref":"#/components/schemas/OutageImpactEntity"
    }
}

Nested Schema : OutageImpactEntity

Type: object

Detailed information about an entity impacted by an outage.

Show Source

• connectivityIdentifier: string
  Read Only: true

  The identifier of impacted Connectivity.
• description: string
  A free-text description for the Impacted Entity Item.
• entityType: string
  Allowed Values: [ "PIPE", "CONNECTIVITY", "SERVICE", "EQUIPMENT", "PHYSICAL DEVICE", "LOGICAL DEVICE", "LOCATION", "NETWORK", "FLOWIDENTIFIER" ]

  Entity type of the impacted entity.
• flowIdentifierDomain: string
  Domain of the impacted flow identifier.
• flowIdentifierIdentifier: integer
  Identifier of the impacted flow identifier.
• href: string (uri)
  Read Only: true

  The URI for the Impacted Entity Item.
• id: string
  Read Only: true

  The ID of the impacted entity.
• impactType: string
  Read Only: true

  Type of the impact, DIRECT or INDIRECT.
• latitude: number (double)
  The latitude of the impacted location.
• longitude: number (double)
  The longitude of the impacted location.
• name: string
  Read Only: true

  The name of the impacted entity.
• rateCode: string
  The ratecode of the impacted Connectivity.
• relatedParty: array relatedParty
  List of parties related to the impacted entity.
• specName: string
  Read Only: true

  The name of the specification.
• technology: string
  The technology of the impacted Connectivity.

{
    "type":"object",
    "description":"Detailed information about an entity impacted by an outage.",
    "properties":{
        "connectivityIdentifier":{
            "type":"string",
            "description":"The identifier of impacted Connectivity.",
            "readOnly":true
        },
        "id":{
            "type":"string",
            "description":"The ID of the impacted entity.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the impacted entity.",
            "readOnly":true
        },
        "entityType":{
            "$ref":"#/components/schemas/ImpactedItemTypeEnum"
        },
        "href":{
            "type":"string",
            "description":"The URI for the Impacted Entity Item.",
            "format":"uri",
            "readOnly":true
        },
        "specName":{
            "type":"string",
            "description":"The name of the specification.",
            "readOnly":true
        },
        "technology":{
            "type":"string",
            "description":"The technology of the impacted Connectivity."
        },
        "rateCode":{
            "type":"string",
            "description":"The ratecode of the impacted Connectivity."
        },
        "latitude":{
            "format":"double",
            "type":"number",
            "description":"The latitude of the impacted location."
        },
        "longitude":{
            "format":"double",
            "type":"number",
            "description":"The longitude of the impacted location."
        },
        "impactType":{
            "type":"string",
            "description":"Type of the impact, DIRECT or INDIRECT.",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the Impacted Entity Item."
        },
        "flowIdentifierDomain":{
            "type":"string",
            "description":"Domain of the impacted flow identifier."
        },
        "flowIdentifierIdentifier":{
            "type":"integer",
            "description":"Identifier of the impacted flow identifier."
        },
        "relatedParty":{
            "type":"array",
            "description":"List of parties related to the impacted entity.",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyRef"
            }
        }
    }
}

Nested Schema : relatedParty

Type: array

List of parties related to the impacted entity.

Show Source

• Array of: object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.

{
    "type":"array",
    "description":"List of parties related to the impacted entity.",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyRef"
    }
}

Nested Schema : RelatedPartyRef

Type: object

A related party, which defines a party or party role linked to a specific entity.

Show Source

• @referredType(required): string
  Concrete Type of the Party, in case of dis-ambiguity. Default is 'Party'.
• href: string (uri)
  The URI for the related party.
• id(required): string
  The ID of the related party.
• name: string
  The name of the related party.
• role: string
  The role of the related party.

{
    "type":"object",
    "description":"A related party, which defines a party or party role linked to a specific entity.",
    "required":[
        "id",
        "@referredType"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the related party."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the related party."
        },
        "name":{
            "type":"string",
            "description":"The name of the related party."
        },
        "role":{
            "type":"string",
            "description":"The role of the related party."
        },
        "@referredType":{
            "type":"string",
            "description":"Concrete Type of the Party, in case of dis-ambiguity. Default  is 'Party'."
        }
    }
}

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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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 resources 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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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