1. REST API for Oracle Communications Unified Inventory Management
  2. Tasks
  3. Service

Get Services

get

/service

Gets all services that match the search criteria specified in the query parameters.

Attribute selection is enabled for all first-level attributes.

The includeAll query parameter is required to list all services, including CFS and RFS. The default includes only CFS.

The criteria can include these properties:

  • name
  • description
  • state
  • serviceSpecification.name
  • category
  • supportingResource.id
  • relatedParty.id
  • externalIdentity.externalManagementDomain
  • externalIdentity.externalName
  • externalIdentity.externalObjectId

These criteria operators can be used on the filtering properties. Equals operator is supported for all filtering properties. RegEx operator is supported only on service characteristic searches. Operators can be string literals or URL-encoded format.

  • .eq (OR) = (OR) %3D%3D

    For example: state=active (OR) state==active (OR) state%3D%3Dactive (OR) state.eq=active

  • .regex (with ^)

    For example: name.regex=^broadband (OR) name*=^broadband (OR) name*=%5Ebroadband

  • .regex (with $)

    For Example: name.regex=broadband$ (OR) name*=broadband$ (OR) name*=broadband%24

  • .regex (with ^.*)

    For example: name.regex=^.*broadband (OR) name*=^.*broadband (OR) name*=%5E.*broadband

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.

Optionally, use the sort parameter to sort the search results.

Usage: sort=(Direction)Fields

where Direction is '-' for descending order, and '+' for ascending order. For example: sort=-id,name

These fields can be sorted:

  • id
  • name
  • description
  • serviceSpecification.name

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The services were retrieved successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Service
Type: object
Service Class.
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 : 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
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.
Show Source
Nested Schema : PlaceServiceRef
The place reference on a service.
Match All
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
  • Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]
    The list of valid values for assignment state.
  • The name of the service consumer.
  • Allowed Values: [ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]
    The list of valid values for reference state.
  • Allowed Values: [ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ]
    Valid values for the list of supported reference types.
  • The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'.
Nested Schema : RelatedPartyServiceRef
The party reference on a service.
Match All
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 : 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 : ServiceRelationship
Type: object
Describes links with services of the same category (useful for bundled services).
Show Source
Nested Schema : ResourceServiceRef
The resource reference on a service.
Match All
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : ResourceServiceRef-allOf[1]
Type: object
Show Source

206 Response

A range of services were returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Service
Type: object
Service Class.
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 : 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
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.
Show Source
Nested Schema : PlaceServiceRef
The place reference on a service.
Match All
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
  • Allowed Values: [ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]
    The list of valid values for assignment state.
  • The name of the service consumer.
  • Allowed Values: [ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]
    The list of valid values for reference state.
  • Allowed Values: [ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ]
    Valid values for the list of supported reference types.
  • The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'.
Nested Schema : RelatedPartyServiceRef
The party reference on a service.
Match All
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 : 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 : ServiceRelationship
Type: object
Describes links with services of the same category (useful for bundled services).
Show Source
Nested Schema : ResourceServiceRef
The resource reference on a service.
Match All
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : ResourceServiceRef-allOf[1]
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", "InventoryGroup", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPv4Address", "IPv6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party", "ServiceConfigurationVersion" ]
    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", "InventoryGroup", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPv4Address", "IPv6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party", "ServiceConfigurationVersion" ]
    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", "InventoryGroup", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPv4Address", "IPv6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party", "ServiceConfigurationVersion" ]
    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 weren'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", "GeographicLocation", "GeographicSite", "GeographicAddress", "InventoryGroup", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPv4Address", "IPv6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party", "ServiceConfigurationVersion" ]
    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", "InventoryGroup", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPv4Address", "IPv6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party", "ServiceConfigurationVersion" ]
    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 for all services 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/service?sort=-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.
  • name is the name of the flow identifier to get.

Example of Response Body

This example shows the contents of the response body in JSON format. It shows only the customer facing services (CFS), in descending order of ID. For a complete list of services, you'd include the query parameter ???includeAll=true??? in the cURL command. 

[
   {
      "id": "450005",
      "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/450005",
      "category": "CFS",
      "description": "Email CFS",
      "hasStarted": true,
      "isServiceEnabled": false,
      "name": "EmaiLCFS",
      "serviceDate": "2019-11-27T16:05:01.442Z",
      "supportingResource": [
         {
            "id": "22-300001",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/22-300001",
            "name": "BALU EMAIL ACCOUNT",
            "@referredType": "LogicalDeviceAccount",
            "consumerName": "Email RFS",
            "assignmentState": "ASSIGNED"
         },
         {
            "id": "1-675003",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/1-675003",
            "name": "Email LD",
            "@referredType": "LogicalDevice",
            "consumerName": "Email RFS",
            "referenceState": "REFERENCED"
         }
      ],
      "startDate": "2019-11-27T15:58:21.066Z",
      "relatedParty": [
         {
            "id": "225002",
            "href": "http://hostname:port/InventoryRSOpenAPI/party/225002",
            "name": "Snow White",
            "role": "Customer",
            "referenceType": "Association",
            "consumerName": "EmaiLCFS"
         }
      ],
      "serviceCharacteristic": [
         {
            "name": "serviceRelType1",
            "valueType": "ALPHANUMERIC",
            "value": "relies-on",
            "serviceName": "EmaiLCFS"
         },
         {
            "name": "category",
            "valueType": "ALPHANUMERIC",
            "value": "CFS",
            "serviceName": "EmaiLCFS"
         },
         {
            "name": "serviceRel1",
            "valueType": "ALPHANUMERIC",
            "value": "BroadbandCFS",
            "serviceName": "EmaiLCFS"
         }
      ],
      "serviceRelationship": [
         {
            "relationshipType": "relies-on",
            "service": {
               "id": "450001",
               "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/450001"
            }
         }
      ],
      "supportingService": [
         {
            "id": "450006",
            "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/450006",
            "name": "Email RFS"
         }
      ],
      "serviceSpecification": {
         "id": "Email_CFS",
         "href": "http://hostname:port/InventoryRSOpenAPI/specification/Email_CFS",
         "name": "Email_CFS",
         "version": "1",
         "entityType": "Service",
         "startDate": "2019-11-27T00:00:01.000Z",
         "endDate": "2038-01-19T08:44:07.000Z"
      },
      "state": "inactive",
      "place": [
         {
            "id": "HYD",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/HYD",
            "name": "HYD",
            "referenceType": "ResourceNetworkLocation",
            "consumerName": "Email RFS",
            "resourceName": "Email LD"
         }
      ]
   }
]
Back to Top