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

Create a Physical Port

post

/physicalPort

Creates a Physical Ports with the given details. The following fields are mandatory fields for successful PhysicalPort creation.

  • @type
  • name
  • resourceSpecification
  • physicalDeviceRef (or) equipmentRef

Optionally quantity queryParam can be used for bulk creation of ports.

To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain minimum details of id and @type. The created Physical Port will be shown in the response along with the location URL, except when "fields=none" is provided in the request.

Request

Query Parameters
Supported Media Types
Request Body - application/json ()
The physical port to be created.
Root Schema : schema
A physical port.
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 : roles
Type: array
The list of physical port inventory roles.
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

201 Response

The physical ports were created successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : schema
A physical port.
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 : roles
Type: array
The list of physical port inventory roles.
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 create a physical port with the given specification by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X POST "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/physicalPort -H 'content-type: application/json' -H credentials -d @ppcreate.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.
  • credentials is the base64 encoding of the user ID and password joined by a single colon (ID:password). See "Authentication and Authorization".
  • ppcreate.json is the JSON file that specifies the physical port to create.

Example of Request Body

This shows an example of the contents of the ppcreate.json file sent as the request body. 

{
    "@type": "PhysicalDevice",
    "name": "Video Card",
    "description": "Physical Card for Video Subscription",
    "resourceCharacteristic": [
        {
            "name": "videoDeviceModelNumber",
            "valueType": "ALPHANUMERIC",
            "value": "WC0022"
        }
    ],
    "resourceSpecification": {
        "id": "Video Subscription Card"
    },
    "serialNumber": "020UGFW0D2002091"
}

Example of Response Body

This example shows the contents of the response body in JSON format. The ID is auto-generated and included in the response, because the input specification indicates auto-generation. 

{
    "id": "4-1725002",
    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/4-1725002",
    "@type": "PhysicalDevice",
    "@baseType": "PhysicalResource",
    "name": "Video Card",
    "description": "Physical Card for Video Subscription",
    "version": "1",
    "lifecycleState": "INSTALLED",
    "lifecycleSubState": "UNASSIGNED",
    "startDate": "2020-01-06T11:55:02.200Z",
    "endDate": "2038-01-19T08:44:07.000Z",
    "resourceCharacteristic": [
        {
            "name": "videoDeviceHDCapable",
            "valueType": "BOOLEAN",
            "value": "false"
        },
        {
            "name": "videoDeviceOnPlant",
            "valueType": "BOOLEAN",
            "value": "true"
        },
        {
            "name": "videoDeviceModelNumber",
            "valueType": "ALPHANUMERIC",
            "value": "WC0022"
        },
        {
            "name": "videoDeviceIsPPVEnabled",
            "valueType": "BOOLEAN",
            "value": "true"
        },
        {
            "name": "videoDeviceCreditLimit",
            "valueType": "NUMERIC",
            "value": "100"
        }
    ],
    "resourceSpecification": {
        "id": "Video Subscription Card",
        "href": "http://hostname:port/InventoryRSOpenAPI/specification/Video Subscription Card",
        "name": "Video Subscription Card",
        "version": "1",
        "entityType": "PhysicalDevice",
        "startDate": "2019-12-17T00:00:01.000Z",
        "endDate": "2038-01-19T08:44:07.000Z"
    },
    "serialNumber": "020UGFW0D2002091"
}
Back to Top