1. REST API for Unified Inventory Management
  2. Tasks
  3. Service
  4. Bundle

Get a Bundle Service by ID

get

/bundle/{id}

Gets the bundle service that matches the specified ID.

Attribute selection is enabled for all first-level attributes.

Optionally, use the expand parameter to specify any service relationships (or) supporting services (expand=supportingService,serviceRelationship)that you want to see details for. By default, you'll just see links for these.

Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The bundle service was retrieved successfully.
Body ()
Root Schema : schema
Type: object
Bundle Service.
Show Source
Nested Schema : items
Type: array
A list of items (Service [*]).
Show Source
Nested Schema : schema
Type: object
Service Class.
Show Source
Nested Schema : BusinessInteractionRef
Type: object
Show Source
Nested Schema : ExternalIdentity
Type: object
An external identity.
Show Source
Nested Schema : place
Type: array
The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources.
Show Source
Nested Schema : relatedParty
Type: array
A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.
Show Source
Nested Schema : serviceCharacteristic
Type: array
A list of characteristics that characterize this service (ServiceCharacteristic [*])
Show Source
Nested Schema : serviceOrderItem
Type: array
A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service.
Show Source
Nested Schema : serviceRelationship
Type: array
A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory (useful for describing relies-on, relies-from between CFS for example).
Show Source
Nested Schema : Specification
Type: object
A specification.
Show Source
  • The boolean value to indicate if id has to be auto-generated or entered manually by user.
  • characteristics
    List of characteristics including hard attributes defined for the specification. Currently characteristics will be displayed only for Network/Pipe/PL/LD/PD/Equipment required for NPD. Only available hard attributes as per design studio layout are displayed.
  • Details about the specification.
  • The display name of the specification.
  • The date and time when the specification ends.
  • 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.
  • The URI for the specification.
  • The ID of the specification, which is the same as the name of the specification.
  • The name of the specification.
  • PageLayout
    Layout information for Create and Edit Pages
  • The date and time when the specification starts.
  • The version of the specification, which is always 1.
Nested Schema : supportingResource
Type: array
A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS.
Show Source
Nested Schema : supportingService
Type: array
A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).
Show Source
Nested Schema : PlaceServiceRef
The place reference on a service.
Match All
The place reference on a service.
The place reference on a service.
Show Source
Nested Schema : PlaceRef
Type: object
A place to associate with the resource/service.
Show Source
Nested Schema : PlaceServiceRef-allOf[1]
Type: object
Show Source
Nested Schema : placeCharacteristic
Type: array
The list of characteristics for the place.
Show Source
Nested Schema : Characteristic
Type: object
A characteristic of an object or entity represented by a name-value pair.
Show Source
Nested Schema : value
Type: object
The value of the characteristic.
Nested Schema : RelatedPartyServiceRef
The party reference on a service.
Match All
The party reference on a service.
The party reference on a service.
Show Source
Nested Schema : RelatedPartyRef
Type: object
A related party, which defines a party or party role linked to a specific entity.
Show Source
Nested Schema : RelatedPartyServiceRef-allOf[1]
Type: object
Show Source
Nested Schema : partyCharacteristic
Type: array
The list of characteristics for the party.
Show Source
Nested Schema : ServiceCharacteristic
The service characteristic details.
Match All
The service characteristic details.
The service characteristic details.
Show Source
Nested Schema : ServiceCharacteristic-allOf[1]
Type: object
Show Source
Nested Schema : RelatedServiceOrderItem
Type: object
The service order item which triggered service creation/change/termination.
Show Source
Nested Schema : ServiceRelationship
Type: object
Describes links with services of the same category (useful for bundled services).
Show Source
Nested Schema : serviceRelationshipCharacteristic
Type: array
Show Source
Nested Schema : characteristics
Type: array
List of characteristics including hard attributes defined for the specification. Currently characteristics will be displayed only for Network/Pipe/PL/LD/PD/Equipment required for NPD. Only available hard attributes as per design studio layout are displayed.
Show Source
Nested Schema : PageLayout
Type: object
Layout information for Create and Edit Pages
Show Source
Nested Schema : CharacteristicSpecification
Type: object
A characteristic of an object or entity represented by a name-value pair.
Show Source
Nested Schema : controlType
Match One Schema
Show Source
Nested Schema : DropDownCharSpec
Type: object
List of attributes applicable only if Characteristic is of type dropdown.
Show Source
Nested Schema : TextCharSpec
Type: object
List of attributes applicable only if Characteristic is of control type text.
Show Source
Nested Schema : URLCharSpec
Type: object
List of attributes applicable only if Characteristic is of control type URL.
Show Source
Nested Schema : CalendarCharSpec
Type: object
List of attributes applicable only if Characteristic is of control type Calendar.
Show Source
Nested Schema : NumericCharSpec
Type: object
List of attributes applicable only if Characteristic is of control type Numeric.
Show Source
Nested Schema : CheckboxCharSpec
Type: object
List of attributes applicable only if Characteristic is of control type Checkbox.
Show Source
Nested Schema : enumerationOptions
Type: array
The list of options.
Show Source
Nested Schema : Enumerations
Type: object
Show Source
Nested Schema : SectionLayoutArr
Type: array
Show Source
Nested Schema : SectionLayout
Type: object
Show Source
Nested Schema : elements
Type: array
The elements of the section.
Show Source
Nested Schema : localizedSectionNames
Type: array
The localized name of the section. This is for internal usage.
Show Source
Nested Schema : localizedSectionToolTip
Type: array
Localized Tool Tip of the section. This is for internal usage.
Show Source
Nested Schema : RowLayoutArr
Type: array
Show Source
Nested Schema : ComponentSpecification
Type: object
Show Source
Nested Schema : localizedDisplayNames
Type: array
The localized display names of the element. This is for internal usage.
Show Source
Nested Schema : localizedToolTips
Type: array
The localized tool tips of the element. This is for internal usage.
Show Source
Nested Schema : LocalizedSpec
Type: object
Show Source
Nested Schema : ResourceServiceRef
The resource reference on a service.
Match All
The resource reference on a service.
The resource reference on a service.
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
  • 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.
  • Read Only: true
    Reference of the supporting resource.
  • Unique identifier of the supporting resource.
  • Name of the resource supporting the service.
Nested Schema : ResourceServiceRef-allOf[1]
Type: object
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : externalIdentity
Type: object
Read Only: true
The external identity details for the federated resource.
Match All
The external identity details for the federated resource.
Show Source
Nested Schema : place
Type: array
The list of associated geographic places.
Show Source
Nested Schema : resourceCharacteristic
Type: array
The list of characteristics for the resource.
Show Source
Nested Schema : resourceRelationship
Type: array
The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
Show Source
Nested Schema : ResourceRelationship
Type: object
A relationship to a resource.
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", "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
    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", "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
    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", "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
    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

404 Response

The resources wasn't found.
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", "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
    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", "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
    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 get the details of a bundle service with a given id by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X GET "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/bundle/ID" -H credentials

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".
  • ID is the ID of the bundle service to get.

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the full details for the service with ID 450004. 
{
    "id": "450004",
    "state": "COMPLETED",
    "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/v3/bundle/450004",
    "items": [
        {
    "id": "676002",
    "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/v3/service/676002",
    "businessInteraction": {
        "id": "451003",
        "state": "COMPLETED"
    },
    "category": "CFS",
    "hasStarted": true,
    "isServiceEnabled": true,
    "name": "BroadbandCFS1",
    "serviceDate": "2022-05-08T22:29:39.604Z",
    "startDate": "2022-05-08T22:29:39.218Z",
    "relatedParty": [
        {
            "id": "3",
            "href": "http://hostname:port/InventoryRSOpenAPI/party/3",
            "name": "place1",
            "role": "BATRoleSpec",
            "referenceType": "Association",
            "consumerName": "BroadbandCFS",
            "partyCharacteristic": []
        }
    ],
   "serviceCharacteristic": [
   {
   "name": "serviceRelType",
   "valueType": "ALPHANUMERIC",
   "value": "CFS",
   "serviceName": " BroadbandCFS1",
   "serviceSpecName": "Broadband_Internet_REST_Junit_CFS"
   },
   {
   "name": "serviceRel",
   "valueType": "ALPHANUMERIC",
   "value": "CFS",
   "serviceName": "BroadbandCFS1",
   "serviceSpecName": "Broadband_Internet_REST_Junit_CFS"
   }
  ],
   "serviceType": "Broadband Internet CFS Service",
   "supportingService": [
   {
     "id": "450002",
     "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/450002",
     "name": "DOCSISRFS"
   }
   ], 
   "serviceSpecification": {
      "id": "Broadband_Internet_Access_CFS",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/Broadband_Internet_Access_CFS",
      "name": "Broadband_Internet_Access_CFS",
      "version": "1",
      "entityType": "Service",
      "startDate": "2022-05-08T22:29:39.604Z",
      "endDate": "2022-05-08T22:29:39.604Z"
   },
    "state": "active",
    "place": [
        {
            "id": "3",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/3",
            "name": "place1",
            "@referredType": "GeographicLocation",
            "role": "BATRoleSpec",
            "referenceType": "Association",
            "consumerName": "BroadbandCFS1"
        }
    ],
    "externalIdentity": {
        "externalObjectId": "376921",
        "externalName": "extName1",
        "externalManagementDomain": "extMgmtDom1"
    }
}
,
{
    "id": "676003",
    "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/v3/service/676003",
    "businessInteraction": {
        "id": "451004",
        "state": "COMPLETED"
    },
    "category": "CFS",
    "hasStarted": true,
    "isServiceEnabled": true,
    "name": "BroadbandCFS2",
    "serviceDate": "2022-05-08T22:29:39.604Z",
    "startDate": "2022-05-08T22:29:39.218Z",
    "relatedParty": [
        {
            "id": "3",
            "href": "http://hostname:port/InventoryRSOpenAPI/party/3",
            "name": "place1",
            "role": "BATRoleSpec",
            "referenceType": "Association",
            "consumerName": "BroadbandCFS2",
            "partyCharacteristic": []
        }
    ],
   "serviceCharacteristic": [
   {
   "name": "serviceRelType",
   "valueType": "ALPHANUMERIC",
   "value": "CFS",
   "serviceName": " BroadbandCFS2",
   "serviceSpecName": "Broadband_Internet_REST_Junit_CFS"
   },
   {
   "name": "serviceRel",
   "valueType": "ALPHANUMERIC",
   "value": "CFS",
   "serviceName": "BroadbandCFS2",
   "serviceSpecName": "Broadband_Internet_REST_Junit_CFS"
   }
  ],
   "serviceType": "Broadband Internet CFS Service",
   "supportingService": [
   {
     "id": "450002",
     "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/450002",
     "name": "DOCSISRFS"
   }
   ], 
   "serviceSpecification": {
      "id": "Broadband_Internet_Access_CFS",
      "href": "http://hostname:port/InventoryRSOpenAPI/specification/Broadband_Internet_Access_CFS",
      "name": "Broadband_Internet_Access_CFS",
      "version": "1",
      "entityType": "Service",
      "startDate": "2022-05-08T22:29:39.604Z",
      "endDate": "2022-05-08T22:29:39.604Z"
   },
    "state": "active",
    "place": [
        {
            "id": "3",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/3",
            "name": "place1",
            "@referredType": "GeographicLocation",
            "role": "BATRoleSpec",
            "referenceType": "Association",
            "consumerName": "BroadbandCFS2"
        }
    ],
    "externalIdentity": {
        "externalObjectId": "376922",
        "externalName": "extName2",
        "externalManagementDomain": "extMgmtDom2"
    }
}
    ]
}
Back to Top