1. REST API for Unified Inventory Management
  2. Tasks
  3. Reconfigure Network Resources
  4. Rehome

Get rehome activity by Name

get

/rehome/{projectName}/{activityName}

Gets the rehome activity details that matches the specified project and activity Name.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The rehome activity was returned successfully.
Body ()
Root Schema : schema
Type: object
Rehome Project Class.
Show Source
Nested Schema : RehomeActivity
Type: object
Rehome activity is used to change the terminations of Connectivity or Pipe. Pipe and connectivity trails riding on the rehomed connectivity require design changes to reflect new interface and cross-connect assignments.
Show Source
Nested Schema : activityItems
Type: array
Show Source
Nested Schema : impactedItems
Type: array
Show Source
Nested Schema : RehomeActivityItem
Type: object
Rehome activity item captures details of the connectivity or pipe to be rehomed.
Show Source
  • changedEntity
    Connectivity or Pipe to be rehomed.
  • Comments related to failure of rehome activity items, if any.
  • source
    Source Interface or Port on which the connectivity/pipe is currently terminated.
  • Allowed Values: [ "PENDING", "READY", "IN_PROGRESS", "ABORTED", "ERROR", "FAILED", "PENDING_COMPLETE", "COMPLETED", "PENDING_PROCESS", "PENDING_ABORT" ]
    The list of valid values for Activity State.
  • target
    Target Interface or Port on which the connectivity/pipe needs to be terminated.
Nested Schema : changedEntity
Connectivity or Pipe to be rehomed.
Match One Schema
Show Source
Nested Schema : source
Source Interface or Port on which the connectivity/pipe is currently terminated.
Match One Schema
Show Source
Nested Schema : target
Target Interface or Port on which the connectivity/pipe needs to be terminated.
Match One Schema
Show Source
Nested Schema : schema
A pipe resource.
Match All
Show Source
Nested Schema : schema
A Connectivity resource.
Match All
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : LogicalResource-allOf[1]
Type: object
Nested Schema : type
Type: object
Show Source
Nested Schema : CapacityConsumed
Type: object
Consumed capacity of pipe.
Show Source
Nested Schema : CapacityProvided
Type: object
A capacity provided.
Show Source
Nested Schema : CapacityRequired
Type: object
Required capacity of pipe.
Show Source
Nested Schema : pipeDirectionalityRef
Type: array
The list of pipe directionalities.
Show Source
Nested Schema : PipeEnablement
Type: object
Segment details that are enabling current Connectivity.
Show Source
Nested Schema : roles
Type: array
The list of pipe inventory roles.
Show Source
Nested Schema : PipeDirectionality
Type: object
A Pipe Directionality .
Show Source
Nested Schema : pipeSegmentRef
Type: array
The list of pipe segments.
Show Source
Nested Schema : Segment
Type: object
Segment details that are enabling current Connectivity.
Show Source
Nested Schema : flowIdentifiers
Type: array
Show Source
Nested Schema : segmentRef
Match One Schema
Show Source
Nested Schema : schema
A flow identifier.
Match All
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : schema
A network address domain.
Match All
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : RelatedPartyRef
Type: object
A related party, which defines a party or party role linked to a specific entity.
Show Source
Nested Schema : Role
Type: object
A role.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : PlaceRef
Type: object
A place to associate with the resource/service.
Show Source
Nested Schema : ConnectivityDesign
Type: object
Gives the details of latest connectivity design version.
Show Source
Nested Schema : asideFlowIdentifiers
Type: array
Show Source
Nested Schema : paths
Type: array
Show Source
Nested Schema : zsideFlowIdentifiers
Type: array
Show Source
Nested Schema : ConnectivityPath
Type: object
Paths that are enabling current Connectivity.
Show Source
Nested Schema : segments
Type: array
Show Source
Nested Schema : schema
A physical port.
Match All
Show Source
Nested Schema : schema
A device interface.
Match All
Show Source
Nested Schema : PhysicalResource
Type: object
The base class for physical resources.
Match All
Show Source
Nested Schema : PhysicalResource-allOf[1]
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : schema
An equipment resource.
Match All
Show Source
Nested Schema : schema
A physical device resource.
Match All
Show Source
Nested Schema : roles
Type: array
The list of physical port inventory roles.
Show Source
Nested Schema : type
Type: object
Show Source
  • Read Only: true
    The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.
  • Read Only: true
    The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware.
  • PlaceRef
    A place to associate with the resource/service.
  • Read Only: true
    The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.
  • Read Only: true
    The URI for the list of physical connector instances provided by the equipment instance.
  • Read Only: true
    The URI for the physical port instances provided by the equipment instance.
  • roles
    The list of equipment inventory roles.
  • Read Only: true
    The name of the equipment manufacturer.
Nested Schema : roles
Type: array
The list of equipment inventory roles.
Show Source
Nested Schema : type
Type: object
Show Source
  • PlaceRef
    A place to associate with the resource/service.
  • The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address.
  • Read Only: true
    The URI for the list of physical connector instances provided by the physical device instance.
  • The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System).
  • Read Only: true
    The URI for the list of physical ports provided by the physical device instance.
  • roles
    The list of physical device inventory roles.
Nested Schema : roles
Type: array
The list of physical device inventory roles.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : schema
A logical device.
Match All
Show Source
Nested Schema : roles
Type: array
The list of device interface roles.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : roles
Type: array
The list of logical device roles.
Show Source
Nested Schema : ImpactedItem
Type: object
Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.
Show Source
  • If impacted connectivity/pipe design does not have any gap, then the action is VIEW DESIGN. If impacted connectivity/pipe design is not completed due to gap, then the action is RESOLVE GAP. If impacted item is service then the action is VIEW SERVICE.
  • changedEntity
    Impacted Connectivity or Pipe after rehome or groom.
  • Parent activity item due to which this item got imapacted.
  • schema
    Service Class.
  • Allowed Values: [ "PENDING", "READY", "IN_PROGRESS", "ABORTED", "ERROR", "FAILED", "PENDING_COMPLETE", "COMPLETED", "PENDING_PROCESS", "PENDING_ABORT" ]
    The list of valid values for Activity State.
Nested Schema : changedEntity
Impacted Connectivity or Pipe after rehome or groom.
Match One Schema
Show Source
Nested Schema : schema
Type: object
Service Class.
Show Source
Nested Schema : BusinessInteractionRef
Type: object
Show Source
Nested Schema : ExternalIdentity
Type: object
An external identity.
Show Source
Nested Schema : place
Type: array
The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources.
Show Source
Nested Schema : relatedParty
Type: array
A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.
Show Source
Nested Schema : serviceCharacteristic
Type: array
A list of characteristics that characterize this service (ServiceCharacteristic [*])
Show Source
Nested Schema : serviceOrderItem
Type: array
A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service.
Show Source
Nested Schema : serviceRelationship
Type: array
A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).
Show Source
Nested Schema : Specification
Type: object
A specification.
Show Source
  • Details about the specification.
  • The date and time when the specification ends.
  • 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.
  • The URI for the specification.
  • The ID of the specification, which is the same as the name of the specification.
  • The name of the specification.
  • The date and time when the specification starts.
  • The version of the specification, which is always 1.
Nested Schema : supportingResource
Type: array
A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS.
Show Source
Nested Schema : supportingService
Type: array
A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).
Show Source
Nested Schema : PlaceServiceRef
The place reference on a service.
Match All
Show Source
Nested Schema : PlaceServiceRef-allOf[1]
Type: object
Show Source
Nested Schema : placeCharacteristic
Type: array
The list of characteristics for the place.
Show Source
Nested Schema : Characteristic
Type: object
A characteristic of an object or entity represented by a name-value pair.
Show Source
Nested Schema : value
Type: object
The value of the characteristic.
Nested Schema : RelatedPartyServiceRef
The party reference on a service.
Match All
Show Source
Nested Schema : RelatedPartyServiceRef-allOf[1]
Type: object
Show Source
Nested Schema : partyCharacteristic
Type: array
The list of characteristics for the party.
Show Source
Nested Schema : ServiceCharacteristic
The service characteristic details.
Match All
Show Source
Nested Schema : ServiceCharacteristic-allOf[1]
Type: object
Show Source
Nested Schema : RelatedServiceOrderItem
Type: object
The service order item which triggered service creation/change/termination.
Show Source
Nested Schema : ServiceRelationship
Type: object
Describes links with services of the same category (useful for bundled services).
Show Source
Nested Schema : serviceRelationshipCharacteristic
Type: array
Show Source
Nested Schema : ResourceServiceRef
The resource reference on a service.
Match All
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
  • 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.
  • Read Only: true
    Reference of the supporting resource.
  • Unique identifier of the supporting resource.
  • Name of the resource supporting the service.
Nested Schema : ResourceServiceRef-allOf[1]
Type: object
Show Source

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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

404 Response

The rehome project wasn'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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

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
  • The error code.
  • 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
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source
Back to Top

Examples

This example shows how to get the details of a rehome project with the given projectname and activityname by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X GET "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/rehome/projectname/activityname" -H 'content-type: application/json' -H credentials

where:

  • hostname is the URL for the UIM REST server.
  • port is the port for the UIM REST server.
  • version is the version of the API you're using.
  • credentials is the base64 encoding of the user ID and password joined by a single colon (ID:password). See "Authentication and Authorization".
  • projectname is the name of the rehome project.
  • activityname is the name of the rehome activity.

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "id": "34-TestRehome_InterIntra3_I",
    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/rehome/34-TestRehome_InterIntra3_I/33-TestRehomeActivity_InterIntra3_I",
    "projectName": "TestRehome_InterIntra3_I",
    "status": "CREATED",
    "activity": {
        "id": "33-TestRehomeActivity_InterIntra3_I",
        "activityName": "TestRehomeActivity_InterIntra3_I",
        "status": "COMPLETED",
        "activityItems": [
            {
                "changedEntity": {
                    "id": "31-248",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/31-248",
                    "@type": "Connectivity",
                    "connectivityIdentifier": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
                },
                "source": {
                    "id": "20-DS3-75759-1",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/20-DS3-75759-1",
                    "@type": "DeviceInterface"
                },
                "target": {
                    "id": "20-DS3-75791-1",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/20-DS3-75791-1",
                    "@type": "DeviceInterface"
                },
                "status": "COMPLETED",
                "comments": ""
            }
        ],
        "impactedItems": [
            {
                "action": "VIEW_DESIGN",
                "changedEntity": {
                    "id": "31-248",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/31-248",
                    "@type": "Connectivity",
                    "connectivityIdentifier": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
                },
                "status": "COMPLETED",
                "parentChangeItem": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
            },
            {
                "action": "VIEW_DESIGN",
                "changedEntity": {
                    "id": "31-278",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/31-278",
                    "@type": "Connectivity",
                    "connectivityIdentifier": "FRSCTX3A_I.002 / PLANTX3A_I.003 / DS1 / T1 / 1"
                },
                "status": "COMPLETED",
                "parentChangeItem": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
            },
            {
                "action": "VIEW_DESIGN",
                "changedEntity": {
                    "id": "30-315",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/30-315",
                    "@type": "Pipe"
                },
                "status": "COMPLETED",
                "parentChangeItem": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
            }
        ]
    }
}
Back to Top