Jump to

• Request
• Response
• Examples

Create Logical Devices

post

/logicalDevice

Creates one or more logical devices with the given details. To create multiple logical devices, include the quantity parameter set to the number to create. When creating multiple logical devices, they will all have the same details.

The following fields are mandatory fields for successful creation:

• @type
• name
• resourceSpecification

To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. ResourceRef should contain the minimum details of id and @type. When creating multiple logical devices, only PARENT and INVOLVE relationship types can be provided. The created logical device will be shown in the response along with the location URL, except when "fields=none" is provided in the request.

Request

Query Parameters

• fields: string
  The fields to include in the response.
• quantity: integer
  The number of resources to create.

Supported Media Types

• application/json

Request Body - application/json ()

The logical device to create.

Root Schema : schema

A logical device.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A logical device.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "vendorName":{
                    "type":"string",
                    "description":"The vendor name for the logical device."
                },
                "modelNumber":{
                    "type":"string",
                    "description":"The model number for the logical device."
                },
                "partNumber":{
                    "type":"string",
                    "description":"The part number for the logical device."
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "serviceLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "deviceIdentifier":{
                    "type":"string",
                    "description":"The name of the device identifier."
                },
                "capacityConsumed":{
                    "type":"string",
                    "description":"The capacity of the logical device consumed."
                },
                "totalCapacity":{
                    "type":"string",
                    "description":"Total capacity of the logical device."
                },
                "percentageConsumed":{
                    "type":"string",
                    "description":"Percentage of the logical device's capacity consumed."
                },
                "deviceInterfaces":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of device interfaces for the logical device."
                },
                "logicalDeviceAccounts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of logical device accounts associated with the logical device."
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of logical device roles."
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  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.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : type

Type: object

Show Source

• capacityConsumed: string
  The capacity of the logical device consumed.
• deviceIdentifier: string
  The name of the device identifier.
• deviceInterfaces: string (uri)
  The URI for the list of device interfaces for the logical device.
• logicalDeviceAccounts: string (uri)
  The URI for the list of logical device accounts associated with the logical device.
• modelNumber: string
  The model number for the logical device.
• networkLocation: object PlaceRef
  A place to associate with the resource/service.
• partNumber: string
  The part number for the logical device.
• percentageConsumed: string
  Percentage of the logical device's capacity consumed.
• roles: array roles
  The list of logical device roles.
• serviceLocation: object PlaceRef
  A place to associate with the resource/service.
• totalCapacity: string
  Total capacity of the logical device.
• vendorName: string
  The vendor name for the logical device.

{
    "type":"object",
    "properties":{
        "vendorName":{
            "type":"string",
            "description":"The vendor name for the logical device."
        },
        "modelNumber":{
            "type":"string",
            "description":"The model number for the logical device."
        },
        "partNumber":{
            "type":"string",
            "description":"The part number for the logical device."
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "serviceLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "deviceIdentifier":{
            "type":"string",
            "description":"The name of the device identifier."
        },
        "capacityConsumed":{
            "type":"string",
            "description":"The capacity of the logical device consumed."
        },
        "totalCapacity":{
            "type":"string",
            "description":"Total capacity of the logical device."
        },
        "percentageConsumed":{
            "type":"string",
            "description":"Percentage of the logical device's capacity consumed."
        },
        "deviceInterfaces":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of device interfaces for the logical device."
        },
        "logicalDeviceAccounts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of logical device accounts associated with the logical device."
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of logical device roles."
        }
    }
}

Nested Schema : PlaceRef

Type: object

A place to associate with the resource/service.

Show Source

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : roles

Type: array

The list of logical device roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of logical device roles."
}

Nested Schema : Role

Type: object

A role.

Show Source

• roleName: string
  The name of the role.
• roleType: string
  Allowed Values: [ "NONE", "TECHNOLOGY", "FUNCTION", "TOPOLOGY", "TARGET" ]

  The type of role.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The logical devices were created successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: schema
  A logical device.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LogicalDevice"
    }
}

Nested Schema : schema

A logical device.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A logical device.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "vendorName":{
                    "type":"string",
                    "description":"The vendor name for the logical device."
                },
                "modelNumber":{
                    "type":"string",
                    "description":"The model number for the logical device."
                },
                "partNumber":{
                    "type":"string",
                    "description":"The part number for the logical device."
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "serviceLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "deviceIdentifier":{
                    "type":"string",
                    "description":"The name of the device identifier."
                },
                "capacityConsumed":{
                    "type":"string",
                    "description":"The capacity of the logical device consumed."
                },
                "totalCapacity":{
                    "type":"string",
                    "description":"Total capacity of the logical device."
                },
                "percentageConsumed":{
                    "type":"string",
                    "description":"Percentage of the logical device's capacity consumed."
                },
                "deviceInterfaces":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of device interfaces for the logical device."
                },
                "logicalDeviceAccounts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of logical device accounts associated with the logical device."
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of logical device roles."
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

A base resource Class.

Show Source

• @baseType: string
  Read Only: true

  Allowed Values: [ "PhysicalResource", "LogicalResource" ]

  The list of valid values for the type of base resource.
• @type: string
  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.
• category: string
  The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
• description: string
  A free-text description for the resource.
• endOperatingDate: string (date-time)
  The date and time when the resource is no longer effective.
• externalIdentity: object externalIdentity
  Read Only: true

  The external identity details for the federated resource.
• href: string (uri)
  Read Only: true

  The URI for the resource class.
• id: string
  The ID of the resource.
• lifecycleState: string
  Allowed Values: [ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED" ]

  The list of valid values for inventory state.
• lifecycleSubState: string
  Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]

  The list of valid values for assignment state.
• name: string
  The name of the resource.
• place: array place
  The list of associated geographic places.
• resourceCharacteristic: array resourceCharacteristic
  The list of characteristics for the resource.
• resourceRelationship: array resourceRelationship
  The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
• resourceSpecification: object Specification
  A specification.
• resourceStatus: string
  Allowed Values: [ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]

  The list of valid values for resource status type, which indicates if entity has reservations.
• resourceVersion: string
  Read Only: true

  A field that identifies the version of a resource instance.
• startOperatingDate: string (date-time)
  Read Only: true

  The starting date and time when the resource becomes effective.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : type

Type: object

Show Source

• capacityConsumed: string
  The capacity of the logical device consumed.
• deviceIdentifier: string
  The name of the device identifier.
• deviceInterfaces: string (uri)
  The URI for the list of device interfaces for the logical device.
• logicalDeviceAccounts: string (uri)
  The URI for the list of logical device accounts associated with the logical device.
• modelNumber: string
  The model number for the logical device.
• networkLocation: object PlaceRef
  A place to associate with the resource/service.
• partNumber: string
  The part number for the logical device.
• percentageConsumed: string
  Percentage of the logical device's capacity consumed.
• roles: array roles
  The list of logical device roles.
• serviceLocation: object PlaceRef
  A place to associate with the resource/service.
• totalCapacity: string
  Total capacity of the logical device.
• vendorName: string
  The vendor name for the logical device.

{
    "type":"object",
    "properties":{
        "vendorName":{
            "type":"string",
            "description":"The vendor name for the logical device."
        },
        "modelNumber":{
            "type":"string",
            "description":"The model number for the logical device."
        },
        "partNumber":{
            "type":"string",
            "description":"The part number for the logical device."
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "serviceLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "deviceIdentifier":{
            "type":"string",
            "description":"The name of the device identifier."
        },
        "capacityConsumed":{
            "type":"string",
            "description":"The capacity of the logical device consumed."
        },
        "totalCapacity":{
            "type":"string",
            "description":"Total capacity of the logical device."
        },
        "percentageConsumed":{
            "type":"string",
            "description":"Percentage of the logical device's capacity consumed."
        },
        "deviceInterfaces":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of device interfaces for the logical device."
        },
        "logicalDeviceAccounts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of logical device accounts associated with the logical device."
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of logical device roles."
        }
    }
}

Nested Schema : PlaceRef

Type: object

A place to associate with the resource/service.

Show Source

• @referredType: string
  Allowed Values: [ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]

  The list of valid values for place referred type.
• href: string (uri)
  The URI for the place.
• id: string
  The ID of the place.
• name: string
  The name of the place.
• referrerRole: string
  The role of the associated resource.
• role: string
  The role of the place.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : roles

Type: array

The list of logical device roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of logical device roles."
}

Nested Schema : Role

Type: object

A role.

Show Source

• roleName: string
  The name of the role.
• roleType: string
  Allowed Values: [ "NONE", "TECHNOLOGY", "FUNCTION", "TOPOLOGY", "TARGET" ]

  The type of role.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

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", "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: 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", "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: 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", "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: 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", "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: 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

Examples

Create a Single Logical Device

This example shows how to create a single logical device with a 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/logicalDevice -H 'content-type: application/json' -H credentials -d @ldcreate.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".
• ldcreate.json is the JSON file that specifies the logical device to create.

Example of Request Body

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

{
   "@type": "LogicalDevice",
      "@baseType": "LogicalResource",
      "name": "IP Phone",
      "resourceRelationship": [
         {
            "type": "INVOLVE",
            "resourceRef": {
               "id": "24-192.168.8.0-29 ? ABC_Inc_Pvt",
               "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-192.168.8.0-29 - ABC_Inc_Pvt",
               "@type": "IPSubnet"
            }
         }
      ],
      "resourceSpecification": {
         "id": "IP_Phone",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/IP_Phone",
         "name": "IP_Phone"
      }
}

Example of Response Body

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

{
   "id": "1-975001",
   "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/1-975001",
   "@type": "LogicalDevice",
   "@baseType": "LogicalResource",
   "name": "IP Phone",
   "version": "1",
   "lifecycleState": "INSTALLED",
   "lifecycleSubState": "UNASSIGNED",
   "startDate": "2020-01-09T15:00:39.407Z",
   "endDate": "2038-01-19T08:44:07.000Z",
   "resourceRelationship": [
       {
           "type": "INVOLVE",
           "resourceRef": {
               "id": "24-192.168.8.0-29 ? ABC_Inc_Pvt",
               "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-192.168.8.0-29 - ABC_Inc_Pvt",
               "@type": "IPSubnet"
           },
           "validFor": {
               "startDate": "2020-01-09T15:00:40.124Z",
               "endDate": "2038-01-19T08:44:07.000Z"
           }
      }        
   ],
   "resourceSpecification": {
      "id": "IP_Phone",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/IP_Phone",
      "name": "IP_Phone",
      "version": "1",
      "entityType": "LogicalDevice",
      "startDate": "2020-01-07T00:00:01.000Z",
      "endDate": "2038-01-19T08:44:07.000Z"
   }
}

Create Multiple Logical Devices

This example shows how to create multiple logical devices 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/logicalDevice?quantity=qty -H 'content-type: application/json' -H credentials -d @ldcreate.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".
• qty is the number of logical devices to create.
• ldcreate.json is the JSON file that specifies the logical device details.

Example of Request Body

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

{
   "@type": "LogicalDevice",
      "@baseType": "LogicalResource",
      "name": "IP Phone",
      "resourceRelationship": [
         {
            "type": "INVOLVE",
            "resourceRef": {
               "id": "24-192.168.8.0-29 ? ABC_Inc_Pvt",
               "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-192.168.8.0-29 - ABC_Inc_Pvt",
               "@type": "IPSubnet"
            }
         }
      ],
      "resourceSpecification": {
         "id": "IP_Phone",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/IP_Phone",
         "name": "IP_Phone"
      }
}

Example of Response Body

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

[
   {
      "id": "1-975004",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/1-975004",
      "@type": "LogicalDevice",
      "@baseType": "LogicalResource",
      "name": "IP Phone",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2020-01-09T15:19:39.235Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceRelationship": [
         {
            "type": "INVOLVE",
            "resourceRef": {
               "id": "24-192.168.8.0-29 ? ABC_Inc_Pvt",
               "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-192.168.8.0-29 - ABC_Inc_Pvt",
               "@type": "IPSubnet"
            },
            "validFor": {
               "startDate": "2020-01-09T15:19:39.365Z",
               "endDate": "2038-01-19T08:44:07.000Z"
            }
         }
      ],
        "resourceSpecification": {
            "id": "IP_Phone",
            "href": "http://hostname:port/InventoryRSOpenAPI/specification/IP_Phone",
            "name": "IP_Phone",
            "version": "1",
            "entityType": "LogicalDevice",
            "startDate": "2020-01-07T00:00:01.000Z",
            "endDate": "2038-01-19T08:44:07.000Z"
        }
    },
    {
        "id": "1-975003",
        "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/1-975003",
        "@type": "LogicalDevice",
        "@baseType": "LogicalResource",
        "name": "IP Phone",
        "version": "1",
        "lifecycleState": "INSTALLED",
        "lifecycleSubState": "UNASSIGNED",
        "startDate": "2020-01-09T15:19:39.233Z",
        "endDate": "2038-01-19T08:44:07.000Z",
        "resourceRelationship": [
            {
                "type": "INVOLVE",
                "resourceRef": {
                    "id": "24-192.168.8.0-29 ? ABC_Inc_Pvt",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-192.168.8.0-29 - ABC_Inc_Pvt",
                    "@type": "IPSubnet"
                },
                "validFor": {
                    "startDate": "2020-01-09T15:19:39.374Z",
                    "endDate": "2038-01-19T08:44:07.000Z"
                }
            }
        ],
        "resourceSpecification": {
            "id": "IP_Phone",
            "href": "http://hostname:port/InventoryRSOpenAPI/specification/IP_Phone",
            "name": "IP_Phone",
            "version": "1",
            "entityType": "LogicalDevice",
            "startDate": "2020-01-07T00:00:01.000Z",
            "endDate": "2038-01-19T08:44:07.000Z"
        }
    }
]

Back to Top