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

Reverse Update of Consumable Resource

post

/service/updateResource

Updates existing resources of the services with new resources provided in the input. The services to be updated can be filtered using the criteria.

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

The service filtering criteria can include these properties:

  • id
  • filterAssignAndRefState
  • filterServiceState
  • filterConfigurationState

Request

Query Parameters
  • The depth of the expansion.
    Default Value: 0
  • The additional details to include in the response.
  • The fields to include in the response.
  • Filter on assignment and reference states with comma separated values. Valid values are ASSIGNED,PENDING_ASSIGN,REFERENCED,PENDING_REFERENCED. Ex:If ASSIGNED,REFERENCED is provided in filter then only resources with these assignment states are updated with new resources. Default includes all above mentioned states.
  • Filter on configuration state with comma separated values. Valid values are COMPLETED, IN_PROGRESS, DESIGNED, ISSUED. Ex:If COMPLETED is provided in filter then only latest service configuration with these states are considered for updates.
  • Filter on service states with comma separated values. Valid values are ACTIVE, DESIGNED, INACTIVE. Ex:If ACTIVE is provided in filter then only services with these states are considered for updates. By default updates happen only for ACTIVE,DESIGNED,INACTIVE. Services with states TERMINATED,CANCELLED,PENDING_CANCEL, PENDING_DISCONNECT and CANCELPENDINGDISCONNECT are not considered for updates.
  • Optional Service ID's , comma separated values, on which resource updates to be made.
Supported Media Types
Request Body - application/json ()
The existing resources of the services will be updated with new resources.
Root Schema : schema
Type: array
Show Source
Nested Schema : UpdateConsumableResource
Type: object
Show Source
  • 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.
Back to Top

Response

Supported Media Types

200 Response

The services were updated successfully.
Body ()
Root Schema : schema
Type: array
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
  • Details about the specification.
  • The date and time when the specification ends.
  • 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.
  • 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.
  • 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
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
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
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 : ResourceServiceRef
The resource reference on a service.
Match All
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" ]
    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
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", "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

This example shows how to update the resource details for all services 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/serviceInventoryManagement/version/service/updateResource -H 'content-type: application/json' -H credentials -d @resourceupdate.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".
  • resourceupdate.json is the JSON file that specifies the resource to update.

Example of Request Body

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

[
{
"oldResourceId":"{{BI-ld}}-300007",
"newResourceId":"{{BI-ld}}-75001",
"entityClass":"LogicalDevice"
},
{
"oldResourceId":"{{BI-FI}}-FlowIdentifier%230",
"newResourceId":"{{BI-FI}}-FlowIdentifier%231",
"entityClass":"FlowIdentifier"
},
{
"oldResourceId":"{{BI-Eq}}-5",
"newResourceId":"{{BI-Eq}}-12",
"entityClass":"Equipment"
},
{
"oldResourceId":"{{BI-LDA}}-75001",
"newResourceId":"{{BI-LDA}}-2",
"entityClass":"LogicalDeviceAccount"
},
{
"newResourceId":"4",
"oldResourceId":"3",
"entityClass":"GeographicSite"
},
{
"newResourceId":"1",
"oldResourceId":"75001",
"entityClass":"Party"
},
{
"newResourceId":"{{BI-pd}}-75003",
"oldResourceId":"{{BI-pd}}-5",
"entityClass":"PhysicalDevice"
},
{
"newResourceId":"{{BI-PC}}-75001-7",
"oldResourceId":"{{BI-PC}}-75001-8",
"entityClass":"PhysicalConnector"
}
]

Example of Response Body

This example shows the contents of the response body in JSON format.

[
   {
    "id": "225005",
    "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/225005",
    "category": "CFS",
    "hasStarted": true,
    "isServiceEnabled": true,
    "name": "BroadbandCFS",
    "serviceDate": "2021-03-25T09:03:21.286Z",
    "supportingResource": [
        {
            "id": "4-1",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/4-1",
            "name": "PD1",
            "@referredType": "PhysicalDevice",
            "consumerName": "BroadbandCFS",
            "assignmentState": "ASSIGNED"
        },
        {
            "id": "8-3",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/8-3",
            "name": "Equipment",
            "@referredType": "Equipment",
            "consumerName": "BroadbandCFS",
            "assignmentState": "PENDING_UNASSIGN"
        },
        {
            "id": "8-150035",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/8-150035",
            "@referredType": "Equipment",
            "consumerName": "BroadbandCFS",
            "assignmentState": "PENDING_ASSIGN"
        },
        {
            "id": "29-150006",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/29-150006",
            "name": "CNA2",
            "@referredType": "CustomNetworkAddress",
            "consumerName": "BroadbandCFS",
            "assignmentState": "ASSIGNED"
        },
        {
            "id": "22-75011",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/22-75011",
            "name": "LDA",
            "@referredType": "LogicalDeviceAccount",
            "consumerName": "BroadbandCFS",
            "assignmentState": "PENDING_UNASSIGN"
        },
        {
            "id": "22-1",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/22-1",
            "name": "LDA1",
            "@referredType": "LogicalDeviceAccount",
            "consumerName": "BroadbandCFS",
            "assignmentState": "PENDING_ASSIGN"
        },
        {
            "id": "12-150011",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/12-150011",
            "name": "CO2",
            "@referredType": "CustomObject",
            "consumerName": "BroadbandCFS",
            "assignmentState": "PENDING_UNASSIGN"
        },
        {
            "id": "12-1",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/12-1",
            "name": "CO1",
            "@referredType": "CustomObject",
            "consumerName": "BroadbandCFS",
            "assignmentState": "PENDING_ASSIGN"
        },
        {
            "id": "20-1-2",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/20-1-2",
            "@referredType": "DeviceInterface",
            "consumerName": "BroadbandCFS",
            "assignmentState": "PENDING_ASSIGN"
        },
        {
            "id": "21-80765",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/21-80765",
            "name": "80765",
            "@referredType": "TelephoneNumber",
            "consumerName": "BroadbandCFS",
            "assignmentState": "PENDING_ASSIGN"
        },
        {
            "id": "1-75023",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/1-75023",
            "name": "LD_Pipe_Resource_651220",
            "@referredType": "LogicalDevice",
            "consumerName": "VDSLRFS",
            "assignmentState": "ASSIGNED"
        },
        {
            "id": "26-12.11.0.2 - Global IP Address Domain",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/26-12.11.0.2+-+Global+IP+Address+Domain",
            "@referredType": "IPV4Address",
            "consumerName": "VDSLRFS",
            "assignmentState": "ASSIGNED"
        },
        {
            "id": "24-12.11.0.0-24 - Global IP Address Domain",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/24-12.11.0.0-24 - Global IP Address Domain",
            "@referredType": "IPSubnet",
            "consumerName": "VDSLRFS",
            "referenceState": "REFERENCED"
        },
        {
            "id": "28-NAD-FI#FlowIdentifier#0",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/28-NAD-FI%23FlowIdentifier%230",
            "name": "0",
            "@referredType": "FlowIdentifier",
            "consumerName": "VDSLRFS",
            "referenceState": "REFERENCED"
        }
    ],
    "startDate": "2021-03-25T09:03:21.128Z",
    "relatedParty": [
        {
            "id": "75002",
            "href": "http://hostname:port/InventoryRSOpenAPI/party/75002",
            "name": "Party_Automated_634866",
            "referenceType": "Reference",
            "consumerName": "BroadbandCFS",
            "referenceState": "REFERENCED"
        }
    ],
    "serviceCharacteristic": [
        {
            "name": "serviceRelType",
            "valueType": "ALPHANUMERIC",
            "value": "P-C",
            "serviceName": "BroadbandCFS"
        },
        {
            "name": "serviceRel",
            "valueType": "ALPHANUMERIC",
            "value": "VDSLRFS",
            "serviceName": "BroadbandCFS"
        },
        {
            "name": "category",
            "valueType": "ALPHANUMERIC",
            "value": "CFS",
            "serviceName": "BroadbandCFS"
        },
        {
            "name": "category",
            "valueType": "ALPHANUMERIC",
            "value": "CFS",
            "serviceName": "VDSLRFS",
            "configItemName": "Email_Access_CFS",
            "configItemDisplayName": "Email_Access_CFS"
        },
        {
            "name": "UserName",
            "valueType": "ALPHANUMERIC",
            "value": "REST",
            "serviceName": "Email"
        },
        {
            "name": "MaxNumberOfAccounts",
            "valueType": "ALPHANUMERIC",
            "value": "2",
            "serviceName": "Email"
        }
    ],
    "serviceRelationship": [
        {
            "relationshipType": "P-C",
            "service": {
                "id": "75005",
                "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/75005"
            }
        }
    ],
    "supportingService": [
        {
            "id": "75005",
            "href": "http://hostname:port/InventoryRSOpenAPI/serviceInventoryManagement/version/service/75005",
            "name": "VDSLRFS"
        }
    ],
    "serviceSpecification": {
        "id": "Broadband_Internet_REST_Junit_CFS",
        "href": "http://hostname:port/InventoryRSOpenAPI/specification/Broadband_Internet_REST_Junit_CFS",
        "name": "Broadband_Internet_REST_Junit_CFS",
        "version": "1",
        "entityType": "Service",
        "startDate": "2021-03-23T18:30:01.000Z",
        "endDate": "2038-01-19T03:14:07.000Z"
    },
    "state": "active",
    "place": [
        {
            "id": "1",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/1",
            "name": "CustomerLocation",
            "@referredType": "GeographicLocation",
            "referenceType": "Reference",
            "consumerName": "BroadbandCFS",
            "referenceState": "PENDING_REFERENCE"
        },
        {
            "id": "150004",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/150004",
            "name": "Place_Automated_490303",
            "@referredType": "GeographicSite",
            "referenceType": "Reference",
            "consumerName": "BroadbandCFS",
            "referenceState": "PENDING_REFERENCE"
        }
    ]
}
]
Back to Top