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

Reverse Update of Consumable Resource

post

/service/updateResource

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

Use the includeAll parameter to update all services, including CFS and RFS. The default includes only CFS.

The service filtering criteria can include the following properties:

  • id
  • filterAssignAndRefState
  • filterServiceState
  • filterConfigurationState

Request

Query Parameters
  • The depth of the expansion.
  • 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. For example, if ASSIGNED,REFERENCED is provided in filter, only the resources with these assignment states are updated with the new resources. Default includes all the above mentioned states.
  • Filter on configuration state with comma separated values. Valid values are COMPLETED, IN_PROGRESS, DESIGNED, ISSUED. For example, 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. For example, if ACTIVE is provided in the filter then only services with these states are considered for the update. By default, the 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 IDs with comma separated values, on which the resource updates are required.
Supported Media Types
Request Body - application/json ()
The service that is to be created
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 are updated 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
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 : 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
  • Allowed Values: [ "DeviceInterface", "Equipment", "EquipmentHolder", "LogicalDevice", "LogicalDeviceAccount", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPNetwork", "IPSubnet", "NetworkAddressDomain", "FlowIdentifier", "CustomObject", "CustomNetworkAddress" ]
    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
Nested Schema : validFor
Type: object
Read Only: true
The time period during which the relationship is valid.
Match All
Show Source
Nested Schema : TimePeriod
Type: object
A time period.
Show Source

400 Response

The request is not 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 are not 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