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

Create Telephone Numbers

post

/telephoneNumber

Creates a telephone number with given details. The operation also supports creation of a range of TelephoneNumbers, for which rangeFrom and rangeTo query params canbe given. The following fields are mandatory fields for successful Telephone Number creation.

  • @type
  • name
  • telephoneNumber or rangeFrom
  • resourceSpecification

To create a resource relationship, resourceRelationship.type and resourceRelationship.resourceRef are mandatory. The created Telephone Number 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 telephone number to be created.
Root Schema : schema
A telephone number.
Match All
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : LogicalResource-allOf[1]
Type: object
Nested Schema : type
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

The telephone numbers were created successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : schema
A telephone number.
Match All
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : LogicalResource-allOf[1]
Type: object
Nested Schema : type
Type: object
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

Create a Single Telephone Number

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

Example of Request Body

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

{
   "@type": "TelephoneNumber",
   "@baseType": "LogicalResource",
   "resourceSpecification": {
      "id": "US_TelephoneNumber",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/US_TelephoneNumber",
      "name": "US_TelephoneNumber"
   },
   "telephoneNumber": "5555551234" 
}

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": "21-5555551234",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/21-5555551234",
      "@type": "TelephoneNumber",
      "@baseType": "LogicalResource",
      "name": "5555551234",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2020-01-16T16:44:46.312Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "US_TelephoneNumber",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/US_TelephoneNumber",
         "name": "US_TelephoneNumber",
         "version": "1",
         "entityType": "TelephoneNumber",
         "startDate": "2020-01-07T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "telephoneNumber": "5555551234"
   }
]

Create a Range of Telephone Numbers

This example shows how to create a range of telephone numbers with the same 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/telephoneNumber -H 'content-type: application/json' -H credentials -d @tncreate.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, such as v1.0.0.
  • credentials is the base64 encoding of the user ID and password joined by a single colon (ID:password). See "Authentication and Authorization".
  • tncreate.json is the JSON file that specifies the telephone number to create.

Example of Request Body

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

{
   "@type": "TelephoneNumber",
   "@baseType": "LogicalResource",
   "resourceSpecification": {
      "id": "US_TelephoneNumber",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/US_TelephoneNumber",
      "name": "US_TelephoneNumber"
   },
   "telephoneNumber": "5555551234"
}

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": "21-5555551234",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/21-5555551234",
      "@type": "TelephoneNumber",
      "@baseType": "LogicalResource",
      "name": "5555551234",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2020-01-16T16:45:57.045Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "US_TelephoneNumber",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/US_TelephoneNumber",
         "name": "US_TelephoneNumber",
         "version": "1",
         "entityType": "TelephoneNumber",
         "startDate": "2020-01-07T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "telephoneNumber": "5555551234"
   },
   {
      "id": "21-5555551235",
      "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/21-5555551235",
      "@type": "TelephoneNumber",
      "@baseType": "LogicalResource",
      "name": "55555511235",
      "version": "1",
      "lifecycleState": "INSTALLED",
      "lifecycleSubState": "UNASSIGNED",
      "startDate": "2020-01-16T16:45:57.049Z",
      "endDate": "2038-01-19T08:44:07.000Z",
      "resourceSpecification": {
         "id": "US_TelephoneNumber",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/US_TelephoneNumber",
         "name": "US_TelephoneNumber",
         "version": "1",
         "entityType": "TelephoneNumber",
         "startDate": "2020-01-07T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "telephoneNumber": "5555551235"
   }
]
Back to Top