REST API for Unified Inventory Management

Reserve Resources under a single Reservation Number

post

/resourceReservation

Reserves all the resources under a single reservation number.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

reservation api resource

Show Source

expiryDate: string (date)

The expiry date of the reservation

Example: 2024-08-22
reason: string

Reason for the reservation
reservationNumber: string

Reservation number of the entities got reserved
reservationType(required): string

Allowed Values: [ "Longterm", "Shortterm" ]

ReservationType of the reservation
reservedFor(required): string

Name of whom the resource is reserved for
reservedForType(required): string

Allowed Values: [ "Area", "CSR", "Customer", "Order", "Project", "Service", "ServiceSpec", "Subscriber" ]

ReservedForType of the Reservation
resourceItems: array resourceItems
startDate(required): string (date)

The start date of the reservation

Example: 2024-08-22

{
    "type":"object",
    "description":"reservation api resource",
    "required":[
        "reservedForType",
        "reservedFor",
        "reservationType",
        "startDate"
    ],
    "properties":{
        "reservationNumber":{
            "type":"string",
            "description":"Reservation number of the entities got reserved"
        },
        "reservedForType":{
            "$ref":"#/components/schemas/ReservedForType",
            "description":"ReservedForType of the reservation"
        },
        "reservedFor":{
            "type":"string",
            "description":"Name of whom the resource is reserved for"
        },
        "reservationType":{
            "$ref":"#/components/schemas/ReservationType",
            "description":"ReservationType of the Reservation"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The start date of the reservation",
            "example":"2024-08-22"
        },
        "expiryDate":{
            "type":"string",
            "format":"date",
            "description":"The expiry date of the reservation",
            "example":"2024-08-22"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the reservation"
        },
        "resourceItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceReservationItem"
            }
        }
    }
}

Nested Schema : resourceItems

Type: array

Show Source

Array of: object ResourceReservationItem

id and type of resource

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

Nested Schema : ResourceReservationItem

Type: object

id and type of resource

Show Source

id(required): string

id of the resource
name: string

name of the resource

{
    "type":"object",
    "description":"id and type of resource",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the resource"
        },
        "name":{
            "type":"string",
            "description":"name of the resource"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Resource reservations created successfully

Root Schema : schema

Type: array

Show Source

Array of: object schema

resource reservation api resource

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

Nested Schema : schema

Type: object

resource reservation api resource

Show Source

@type: string

Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress", "Pipe", "PipeTerminationPoint", "Connectivity" ]

The list of valid values for the resource type.
expiryDate: string (date)

The expiry date of the reservation

Example: 2024-08-22
name: string

name of the resource
reason: string

Reason for the reservation
reservationNumber(required): string

reservation number of the resource's reservation
reservationType(required): string

Allowed Values: [ "Longterm", "Shortterm" ]

ReservationType of the reservation
reservedFor: string

Name of whom the resource is reserved for
reservedForType: string

Allowed Values: [ "Area", "CSR", "Customer", "Order", "Project", "Service", "ServiceSpec", "Subscriber" ]

ReservedForType of the Reservation
resourceId(required): string

id of the resource
startDate(required): string (date)

The start date of the reservation

Example: 2024-08-22

{
    "type":"object",
    "description":"resource reservation api resource",
    "required":[
        "reservationNumber",
        "resourceId",
        "reservationType",
        "startDate"
    ],
    "properties":{
        "reservationNumber":{
            "type":"string",
            "description":"reservation number of the resource's reservation"
        },
        "resourceId":{
            "type":"string",
            "description":"id of the resource"
        },
        "name":{
            "type":"string",
            "description":"name of the resource"
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum",
            "description":"type of the resource"
        },
        "reservedForType":{
            "$ref":"#/components/schemas/ReservedForType"
        },
        "reservedFor":{
            "type":"string",
            "description":"Name of whom the resource is reserved for"
        },
        "reservationType":{
            "$ref":"#/components/schemas/ReservationType"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The start date of the reservation",
            "example":"2024-08-22"
        },
        "expiryDate":{
            "type":"string",
            "format":"date",
            "description":"The expiry date of the reservation",
            "example":"2024-08-22"
        },
        "reason":{
            "type":"string",
            "description":"Reason for the reservation"
        }
    }
}

400 Response

The request isn't valid.

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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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.

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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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.

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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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"
    }
}

404 Response

The resources wasn't found.

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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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.

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", "GeographicPlace", "GeographicLocation", "GeographicSite", "GeographicAddress", "GeographicAddressRange", "PropertyAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "NetworkEdge", "NetworkNode", "NetworkEntityCode", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "PipeTerminationPoint", "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"
    }
}

Examples

This example shows how to create a resource reservation 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/resourceReservation

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".

Example of Request Body

This shows an example of the contents of the the request body.

{

    "reservationNumber": "1725001",

    "resourceId": "28-BATFlowIdentifierSpec#0",

    "reservationType": "LONGTERM",

    "expiryDate": "09-30-2024",

    "startDate": "09-17-2024",

    "reason": "ReservationReason"

}