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

Update a EquipmentHolder

patch

/equipmentHolder/{id}

Updates the Equipment Holder 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.ASSOCIATES, resourceRelationship.INVOLVE) 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 equipment Holder 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 equipment Holder to be updated.
Root Schema : schema
An equipment holder resource.
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
  • The network-facing managed element name for the resource. This name is how the resource is referred to by the NMS (Network Management System) or EMS (Element Management System). This attribute is not currently supported in UIM.
Back to Top

Response

Supported Media Types

200 Response

The equipment Holder was updated successfully.
Body ()
Root Schema : schema
An equipment holder resource.
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
  • The network-facing managed element name for the resource. This name is how the resource is referred to by the NMS (Network Management System) or EMS (Element Management System). This attribute is not currently supported in UIM.

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 an equipment holder 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/equipmentHolder/ID" -H credentials @eqHolderPatch.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 equipment holder to be updated.
  • eqHolderPatch.json is the JSON file with updated values.

Example of Request Body

This shows an example of the contents of the eqHolderPatch.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": "IPNetwork",
    "description": "Motorola Generic Slot Holder"
}

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

{
    "op": "add",
    "path": "/description",
    "value": "Motorola Generic Slot Holder"
}

Example of Response Body

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

{
   "id": "11-750001-675001",
   "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/11-750001-675001",
   "@type": "EquipmentHolder",
   "@baseType": "PhysicalResource",
   "description": "Motorola Generic Slot Holder",
   "version": "1",
   "lifecycleState": "INSTALLED",
   "lifecycleSubState": "UNASSIGNED",
   "startDate": "2020-01-08T14:55:10.841Z",
   "endDate": "2038-01-19T08:44:07.000Z",
   "resourceRelationship": [
      {
         "type": "ASSOCIATES",
         "resourceRef": {
            "id": "8-750002",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/8-750002",
            "@type": "Equipment"
         }
      },
      {
         "type": "ASSOCIATES",
         "resourceRef": {
            "id": "8-750001",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/8-750001",
            "@type": "Equipment"
         }
      }
   ],
   "resourceSpecification": {
      "id": "Motorola_540274_Generic_Slot",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/Motorola_540274_Generic_Slot",
      "name": "Motorola_540274_Generic_Slot",
      "version": "1",
      "entityType": "EquipmentHolder",
      "startDate": "2020-01-08T00:00:01.000Z",
      "endDate": "2038-01-19T08:44:07.000Z"
   },
   "nativeEMSName": "1"
}
Back to Top