1. REST API for Unified Inventory Management
  2. Tasks
  3. Resource
  4. Physical Connector

Update a Physical Connector

patch

/physicalConnector/{id}

Updates the Physical Connector that matches the specified ID. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that ID and ResourceSpecification cannot be updated and must not be provided in the PATCH requests.

Merge Patch:

All attributes provided in the request will be updated with the given values.

JSON Patch:

This operation performs sequential updates on individual attributes.

Attribute selection is enabled for all first-level attributes.

Optionally, use the expand parameter to specify any resource relationships (resourceRelationship.INVOLVE) or equipmentRef, physicalDeviceRef 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.

Request

Path Parameters
Query Parameters
Supported Media Types
Request Body - application/json-patch+json ()
The physical connector to be updated.
Root Schema : schema
Type: array
Show Source
Nested Schema : PatchDocument
Type: object
A JSON PATCH document.
Show Source
Nested Schema : value
Type: object
The value to use with the operation.
Request Body - application/merge-patch+json ()
The physical connector to be updated.
Root Schema : schema
A physical connector.
Match All
Show Source
Nested Schema : PhysicalResource
Type: object
The base class for physical resources.
Match All
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : PhysicalResource-allOf[1]
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : Equipment
An equipment resource.
Match All
Show Source
Nested Schema : schema
A physical device resource.
Match All
Show Source
Nested Schema : Equipment-allOf[1]
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 : PlaceRef
Type: object
A place to associate with the resource/service.
Show Source
Nested Schema : roles
Type: array
The list of equipment inventory roles.
Show Source
Nested Schema : Role
Type: object
A role.
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
Back to Top

Response

Supported Media Types

200 Response

The physical connector was updated successfully.
Body ()
Root Schema : schema
A physical connector.
Match All
Show Source
Nested Schema : PhysicalResource
Type: object
The base class for physical resources.
Match All
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : PhysicalResource-allOf[1]
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : Equipment
An equipment resource.
Match All
Show Source
Nested Schema : schema
A physical device resource.
Match All
Show Source
Nested Schema : Equipment-allOf[1]
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 : PlaceRef
Type: object
A place to associate with the resource/service.
Show Source
Nested Schema : roles
Type: array
The list of equipment inventory roles.
Show Source
Nested Schema : Role
Type: object
A role.
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

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

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 update the details of a physical connector for a given ID by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X PATCH "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/physicalConnector/ID" -H credentials @pcPatch.json

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.
  • ID is the ID of the physical connector to be updated.
  • pcPatch.json is the JSON file with updated values.

Example of Request Body

This shows an example of the contents of the pcPatch.json file sent as the request body for the MERGE patch.

Note:

The MERGE patch requests should not have ID and Resource-Specification attributes in the requests as they cannot be updated. 

{
    "@type": "PhysicalConnector",
    "name": "Module_1_USBConnector_1"
}

This shows an example of the contents of the pcPatch.json file sent as the request body for the JSON patch. 

{
    "op": "replace",
    "path": "/name",
    "value": "Module_1_USBConnector_1"
}

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the physical connector details for a given ID.

{
   "id": "9-750003-1875083",
   "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/9-750003-1875083",
   "@type": "PhysicalConnector",
   "@baseType": "PhysicalResource",
   "name": "Module_1_USBConnector_1",
   "description": "Port for Module1",
   "version": "1",
   "lifecycleState": "INSTALLED",
   "lifecycleSubState": "UNASSIGNED",
   "startDate": "2020-01-10T10:23:20.342Z",
   "endDate": "2038-01-19T08:44:07.000Z",
   "resourceSpecification": {
      "id": "USB",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/USB",
      "name": "USB",
      "version": "1",
      "entityType": "PhysicalConnector",
      "startDate": "2020-01-10T00:00:01.000Z",
      "endDate": "2038-01-19T08:44:07.000Z"
   },
   "equipmentRef": {
      "id": "8-750003",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/8-750003",
      "@type": "Equipment"
   }
}
Back to Top