Get rehome activity by Name
get
/rehome/{projectName}/{activityName}
Gets the rehome activity details that matches the specified project and activity Name.
Request
Path Parameters
-
activityName(required): string
The name of the activity to get.
-
projectName(required): string
The name of the project to get.
Query Parameters
-
depth: integer
Minimum Value:
0
Maximum Value:10
The depth of the expansion.Default Value:0
-
expand: string
The additional details to include in the response.
-
fields: string
The fields to include in the response.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The rehome activity was returned successfully.
Root Schema : schema
Type:
object
Rehome Project Class.
Show Source
-
activity: object
RehomeActivity
Rehome activity is used to change the terminations of Connectivity or Pipe. Pipe and connectivity trails riding on the rehomed connectivity require design changes to reflect new interface and cross-connect assignments.
-
description: string
A free-text description for the project.
-
href: string
(uri)
Read Only:
true
The URI for the RehomeProject class. -
id: string
Read Only:
true
The ID of the project. -
projectName: string
The name of the project.
-
status: string
Allowed Values:
[ "CREATED", "COMPLETED", "IN_PROGRESS" ]
The list of valid values for Project State.
Nested Schema : RehomeActivity
Type:
object
Rehome activity is used to change the terminations of Connectivity or Pipe. Pipe and connectivity trails riding on the rehomed connectivity require design changes to reflect new interface and cross-connect assignments.
Show Source
-
activityItems: array
activityItems
-
activityName: string
The name of the activity.
-
id: string
The ID of the Activity.
-
impactedItems: array
impactedItems
-
status: string
Allowed Values:
[ "PENDING", "READY", "IN_PROGRESS", "ABORTED", "ERROR", "FAILED", "PENDING_COMPLETE", "COMPLETED", "PENDING_PROCESS", "PENDING_ABORT" ]
The list of valid values for Activity State.
Nested Schema : activityItems
Type:
Show Source
array
-
Array of:
object RehomeActivityItem
Rehome activity item captures details of the connectivity or pipe to be rehomed.
Nested Schema : impactedItems
Type:
Show Source
array
-
Array of:
object ImpactedItem
Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.
Nested Schema : RehomeActivityItem
Type:
object
Rehome activity item captures details of the connectivity or pipe to be rehomed.
Show Source
-
changedEntity:
changedEntity
Connectivity or Pipe to be rehomed.
-
comments: string
Comments related to failure of rehome activity items, if any.
-
source:
source
Source Interface or Port on which the connectivity/pipe is currently terminated.
-
status: string
Allowed Values:
[ "PENDING", "READY", "IN_PROGRESS", "ABORTED", "ERROR", "FAILED", "PENDING_COMPLETE", "COMPLETED", "PENDING_PROCESS", "PENDING_ABORT" ]
The list of valid values for Activity State. -
target:
target
Target Interface or Port on which the connectivity/pipe needs to be terminated.
Nested Schema : source
Source Interface or Port on which the connectivity/pipe is currently terminated.
Match One Schema
Show Source
Nested Schema : target
Target Interface or Port on which the connectivity/pipe needs to be terminated.
Match One Schema
Show Source
Nested Schema : schema
A pipe resource.
Match All
A pipe resource.
A pipe resource.
Show Source
-
object
allOf
LogicalResource
The base class for logical resources.
-
object
type
Nested Schema : schema
A Connectivity resource.
Match All
A Connectivity resource.
A Connectivity resource.
Show Source
-
object
allOf
LogicalResource
The base class for logical resources.
-
object
type
Nested Schema : LogicalResource
Type:
object
The base class for logical resources.
Match All
The base class for logical resources.
The base class for logical resources.
Show Source
-
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type" }
A base resource Class. -
object
LogicalResource-allOf[1]
Nested Schema : Discriminator: @type
Type:
object
A base resource Class.
Show Source
-
@baseType: string
Read Only:
true
Allowed Values:[ "PhysicalResource", "LogicalResource" ]
The list of valid values for the type of base resource. -
@type: string
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. -
category: string
The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource.
-
description: string
A free-text description for the resource.
-
endOperatingDate: string
(date-time)
The date and time when the resource is no longer effective.
-
externalIdentity: object
externalIdentity
Read Only:
true
The external identity details for the federated resource. -
href: string
(uri)
Read Only:
true
The URI for the resource class. -
id: string
The ID of the resource.
-
lifecycleState: string
Allowed Values:
[ "END_OF_LIFE", "INSTALLED", "PENDING_INSTALL", "PENDING_REMOVE", "PENDING_UNAVAILABLE", "PENDING_AVAILABLE", "PLANNED", "UNAVAILABLE", "PENDING_DISCONNECT", "DISCONNECTED", "IN_DESIGN" ]
The list of valid values for inventory state. -
lifecycleSubState: string
Allowed Values:
[ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]
The list of valid values for assignment state. -
name: string
The name of the resource.
-
place: array
place
The list of associated geographic places.
-
resourceCharacteristic: array
resourceCharacteristic
The list of characteristics for the resource.
-
resourceRelationship: array
resourceRelationship
The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc.
-
resourceSpecification: object
Specification
A specification.
-
resourceStatus: string
Allowed Values:
[ "Standby", "Alarm", "Available", "Reserved", "Unknown", "Suspended" ]
The list of valid values for resource status type, which indicates if entity has reservations. -
resourceVersion: string
Read Only:
true
A field that identifies the version of a resource instance. -
startOperatingDate: string
(date-time)
Read Only:
true
The starting date and time when the resource becomes effective.
Nested Schema : LogicalResource-allOf[1]
Type:
object
Nested Schema : type
Type:
Show Source
object
-
aendTerminationPoint: string
(uri)
The URI for aterminationPoint of the pipe.
-
allowSecondaryEnablement: boolean
To allow SecondaryEnablement for a pipe or not.
-
capacityConsumedRef: object
CapacityConsumed
Consumed capacity of pipe.
-
capacityProvidedRef: object
CapacityProvided
A capacity provided.
-
capacityRequiredRef: object
CapacityRequired
Required capacity of pipe.
-
channelSpacing: string
The channelSpacing of pipe.
-
gridType: string
Allowed Values:
[ "FIXED", "FLEX_GRID", "NONE" ]
The GridType of the pipe. Valid values are NONE, FIXED, FLEX_GRID. -
isVersioned: boolean
To denote whether pipe is versioned or not.
-
medium: string
Allowed Values:
[ "WIRELESS", "METALLIC", "FIBER", "SOFTWARE", "UNKNOWN", "NONE" ]
The Medium of the pipe. Valid values are NONE, WIRELESS, METALLIC, FIBER, SOFTWARE, UNKNOWN. -
parentPipeRef:
schema
A pipe resource.
-
pipeDirectionalityRef: array
pipeDirectionalityRef
The list of pipe directionalities.
-
primaryPathEnabled: object
PipeEnablement
Segment details that are enabling current Connectivity.
-
roles: array
roles
The list of pipe inventory roles.
-
secondaryPathEnabled: object
PipeEnablement
Segment details that are enabling current Connectivity.
-
totalConsumedCapacity: string
The total consumed capacity.
-
transmissionSignalType: string
Allowed Values:
[ "ELECTRICAL", "ELECTROMAGNETIC", "OPTICAL", "UNKNOWN", "NONE" ]
The TransmissionSignalType of the pipe. Valid values are NONE, ELECTRICAL, ELECTROMAGNETIC, OPTICAL, UNKNOWN. -
zendTerminationPoint: string
(uri)
The URI for zterminationPoint of the pipe.
Nested Schema : CapacityConsumed
Type:
object
Consumed capacity of pipe.
Show Source
-
capacityConsumed: string
Capacity consumed.
-
id: string
The id of the CapacityConsumed.
-
name: string
The name of the CapacityConsumed.
-
percentConsumed: string
Consumed capacity percentage.
Nested Schema : CapacityProvided
Type:
object
A capacity provided.
Show Source
-
capacityType: string
Capacity type of capacity provided.
-
consumablePercentage: string
Percentage of capacity that can be consumable.
-
totalAmount: string
Total amount of capacity provided.
-
unitOfMeasure: string
Unit of measure valid are Gbps,Kbps,Mbps,bps.
Nested Schema : CapacityRequired
Type:
object
Required capacity of pipe.
Show Source
-
capacityType: string
Capacity type of required capacity.
-
quantity: integer
Percentage of capacity that can be consumable.
-
requiredAmount: string
Required amount of capacity.
-
unitOfMeasure: string
Unit of measure valid are Gbps,Kbps,Mbps,bps.
Nested Schema : pipeDirectionalityRef
Type:
array
The list of pipe directionalities.
Show Source
-
Array of:
object PipeDirectionality
A Pipe Directionality .
Nested Schema : PipeEnablement
Type:
object
Segment details that are enabling current Connectivity.
Show Source
-
originatingTerminationPoint: string
The id of the originatingTerminationPoint.
-
pipeSegmentRef: array
pipeSegmentRef
The list of pipe segments.
-
terminatingTerminationPoint: string
The id of the terminatingTerminationPoint.
Nested Schema : roles
Type:
array
The list of pipe inventory roles.
Show Source
-
Array of:
object Role
A role.
Nested Schema : PipeDirectionality
Type:
object
A Pipe Directionality .
Show Source
-
directionalityType: string
Allowed Values:
[ "ROUTING", "SIGNAL" ]
The directionalityType of the pipe. -
pipeDirection: string
Allowed Values:
[ "BI_DIRECTIONAL", "UNI_DIRECTIONAL", "UNKNOWN" ]
The direction of the pipe. -
terminationDirectType1: string
Allowed Values:
[ "SINK", "SOURCE", "UNKNOWN" ]
The DirectType of the termination1. Valid values are SINK, SOURCE, UNKNOWN. -
terminationDirectType2: string
Allowed Values:
[ "SINK", "SOURCE", "UNKNOWN" ]
The DirectType of the termination2. Valid values are SINK, SOURCE, UNKNOWN. -
terminationId1: string
The ID of the termination1.
-
terminationId2: string
The ID of the termination2.
-
terminationName1: string
The name of the termination1.
-
terminationName2: string
The name of the termination2.
Nested Schema : pipeSegmentRef
Type:
array
The list of pipe segments.
Show Source
-
Array of:
object Segment
Segment details that are enabling current Connectivity.
Nested Schema : Segment
Type:
object
Segment details that are enabling current Connectivity.
Show Source
-
aendLocation: string
A side Location.
-
asideInterface: object
LogicalResource
The base class for logical resources.
-
asidePhysicalPort: object
LogicalResource
The base class for logical resources.
-
asideTerminationPoint: string
The id of Termination point.
-
flowIdentifiers: array
flowIdentifiers
-
gapAccepted: boolean
Use this attribute to accept gap. Default Reason for accepting gap is auto-generated as "GAP OK"
-
interconnectionType: string
Allowed Values:
[ "CROSS_CONNECT", "PHYSICAL_JUMPER" ]
The list of valid values for InterConnectionType. -
isGap: boolean
Identifies if it is a gap or not.
-
lifeCycleBinding: string
Allowed Values:
[ "INTERFACE_BOUND", "TRAIL_BOUND", "HARDWIRED" ]
The list of valid values for InterConnectionLifeCycleBinding. -
segmentNumber: string
Segment number.
-
segmentRef:
segmentRef
-
zendLocation: string
Z side Location.
-
zsideInterface: object
LogicalResource
The base class for logical resources.
-
zsidePhysicalPort: object
LogicalResource
The base class for logical resources.
-
zsideTerminationPoint: string
The id of Termination point.
Nested Schema : schema
A flow identifier.
Match All
A flow identifier.
A flow identifier.
Show Source
-
object
allOf
LogicalResource
The base class for logical resources.
-
object
type
Nested Schema : type
Type:
Show Source
object
-
domain:
schema
A network address domain.
-
identifier: integer
The ID of the flow identifier.
-
identifierPrefix: string
Prefix for the Identifier.
-
lowerIdentifierValue: integer
The Lower ID of the flow identifier Range.
-
resourcePoolName: string
The Resource Pool Name of flow Identifier.
-
stackingLevel: integer
The stacking level of the flow identifier.
-
upperIdentifierValue: integer
The Upper ID of the flow identifier Range.
Nested Schema : schema
A network address domain.
Match All
A network address domain.
A network address domain.
Show Source
-
object
allOf
LogicalResource
The base class for logical resources.
-
object
type
Nested Schema : type
Type:
Show Source
object
-
managedBy: object
RelatedPartyRef
A related party, which defines a party or party role linked to a specific entity.
-
name: string
The name of the network address domain. It also indicates the ID of the domain.
-
networkAddressType: string
The type of network address, either IP Subnet or flow identifier.
-
ownedBy: object
RelatedPartyRef
A related party, which defines a party or party role linked to a specific entity.
Nested Schema : RelatedPartyRef
Type:
object
A related party, which defines a party or party role linked to a specific entity.
Show Source
-
@referredType: string
Concrete Type of the Party, in case of dis-ambiguity. Default is 'Party'.
-
href: string
(uri)
The URI for the related party.
-
id: string
The ID of the related party.
-
name: string
The name of the related party.
-
role: string
The role of the related party.
Nested Schema : Role
Type:
object
A role.
Show Source
-
roleName: string
The name of the role.
-
roleType: string
Allowed Values:
[ "NONE", "TECHNOLOGY", "FUNCTION", "TOPOLOGY", "TARGET" ]
The type of role.
Nested Schema : type
Type:
Show Source
object
-
ALocation: object
schema
A place to associate with the resource/service.
-
assignedToService: string
(uri)
The service (if any) to which the connectivity is assigned.
-
bitRate: string
The bit rate is based on the rate code applied to the connectivity.
-
capacityAvailable: string
Percentage of capacity that can be consumed.
-
connectivityDesign: object
ConnectivityDesign
Gives the details of latest connectivity design version.
-
connectivityIdentifier: string
A unique identifier of Connectivity.
-
consumablePercent: integer
Percentage of capacity that can be consumed.
-
function: string
The function that applies to connectivity. Functions apply only to connectivities that have rate codes that define them as facilities.
-
functionDisplayName: string
Read Only:
true
The display name of the function. -
identificationFormat: string
Allowed Values:
[ "LOCATION_BASED", "SERVICE_BASED", "CUSTOM_IDENTIFICATION" ]
The list of valid values for Connectivity identifier format. -
isAssignContiguousSerialNumber: boolean
Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block.
-
quantity: integer
The number of Connectivity entities to be created.
-
rateCode: string
The rate code that applies to connectivity.
-
serialNumber: integer
A number that uniquely identifies the connectivity within the context of other facilities that share the same A Network/Entity Location, Z Network/Entity Location, Rate Code, and Technology values.
-
technology: string
The technology that applies to connectivity.
-
ZLocation: object
schema
A place to associate with the resource/service.
Nested Schema : schema
Type:
object
A place to associate with the resource/service.
Show Source
-
@referredType: string
Allowed Values:
[ "GeographicAddress", "GeographicLocation", "GeographicSite", "PropertyLocation", "NetworkEntityCode" ]
The list of valid values for place referred type. -
href: string
(uri)
The URI for the place.
-
id: string
The ID of the place.
-
name: string
The name of the place.
-
referrerRole: string
The role of the associated resource.
-
role: string
The role of the place.
Nested Schema : ConnectivityDesign
Type:
object
Gives the details of latest connectivity design version.
Show Source
-
aendLocation: object
schema
A place to associate with the resource/service.
-
asideFlowIdentifiers: array
asideFlowIdentifiers
-
asideInterface: object
LogicalResource
The base class for logical resources.
-
asideTerminationPointId: string
The id of Termination point on A side.
-
connectivityDesignVersion: integer
The version number of connectivity design.
-
paths: array
paths
-
startDate: string
(date-time)
The starting date and time when the connectivity design becomes effective.
-
status: string
Allowed Values:
[ "IN_PROGRESS", "DESIGNED", "ISSUED", "COMPLETED", "PENDING_CANCEL", "CANCELLED" ]
The list of valid values for configuration state. -
terminateAtFlowInterfaceOnAside: boolean
This should be true if A side needs to be terminated at Flow Interface.
-
terminateAtFlowInterfaceOnZside: boolean
This should be true if Z side needs to be terminated at Flow Interface.
-
zendLocation: object
schema
A place to associate with the resource/service.
-
zsideFlowIdentifiers: array
zsideFlowIdentifiers
-
zsideInterface: object
LogicalResource
The base class for logical resources.
-
zsideTerminationPointId: string
The id of Termination point on Z side.
Nested Schema : paths
Type:
Show Source
array
-
Array of:
object ConnectivityPath
Paths that are enabling current Connectivity.
Nested Schema : ConnectivityPath
Type:
object
Paths that are enabling current Connectivity.
Show Source
-
label: string
Path label like Path1, Path2.
-
segments: array
segments
Nested Schema : segments
Type:
Show Source
array
-
Array of:
object Segment
Segment details that are enabling current Connectivity.
Nested Schema : schema
A physical port.
Match All
A physical port.
A physical port.
Show Source
-
object
allOf
PhysicalResource
The base class for physical resources.
-
object
type
Nested Schema : schema
A device interface.
Match All
A device interface.
A device interface.
Show Source
-
object
allOf
LogicalResource
The base class for logical resources.
-
object
type
Nested Schema : PhysicalResource
Type:
object
The base class for physical resources.
Match All
The base class for physical resources.
The base class for physical resources.
Show Source
-
object
Discriminator: @type
Discriminator:
{ "propertyName":"@type" }
A base resource Class. -
object
PhysicalResource-allOf[1]
Nested Schema : PhysicalResource-allOf[1]
Type:
Show Source
object
-
serialNumber: string
The serial number for the physical resource.
Nested Schema : type
Type:
Show Source
object
-
customerPortName: string
The customer-specific name for the port.
-
equipmentRef:
schema
An equipment resource.
-
physicalDeviceRef:
schema
A physical device resource.
-
portNumber: integer
A non-zero integer that uniquely identifies this physical port instance from all other instances.
-
roles: array
roles
The list of physical port inventory roles.
-
vendorPortName: string
The vendor-specific name for the port.
Nested Schema : schema
An equipment resource.
Match All
An equipment resource.
An equipment resource.
Show Source
-
object
allOf
PhysicalResource
The base class for physical resources.
-
object
type
Nested Schema : schema
A physical device resource.
Match All
A physical device resource.
A physical device resource.
Show Source
-
object
allOf
PhysicalResource
The base class for physical resources.
-
object
type
Nested Schema : roles
Type:
array
The list of physical port inventory roles.
Show Source
-
Array of:
object Role
A role.
Nested Schema : type
Type:
Show Source
object
-
category: string
Read Only:
true
The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD. -
modelNumber: string
Read Only:
true
The manufacturer-allocated number used to identify the general type and/or category of the hardware. This, in combination with the part number, identifies different types of hardware. -
networkLocation: object
schema
A place to associate with the resource/service.
-
partNumber: string
Read Only:
true
The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware. -
physicalConnectors: string
(uri)
Read Only:
true
The URI for the list of physical connector instances provided by the equipment instance. -
physicalPorts: string
(uri)
Read Only:
true
The URI for the physical port instances provided by the equipment instance. -
roles: array
roles
The list of equipment inventory roles.
-
vendorName: string
Read Only:
true
The name of the equipment manufacturer.
Nested Schema : roles
Type:
array
The list of equipment inventory roles.
Show Source
-
Array of:
object Role
A role.
Nested Schema : type
Type:
Show Source
object
-
networkLocation: object
schema
A place to associate with the resource/service.
-
physicalAddress: string
The physical address of the device, such as a MAC address. This may correlate to the physical address of a media interface on the device. If the device has more than one physical address, this is considered the primary physical address.
-
physicalConnectors: string
(uri)
Read Only:
true
The URI for the list of physical connector instances provided by the physical device instance. -
physicalLocation: string
The physical location of a resource. This value is a common and agreed upon location identification between the OSS (Operational Support System) and the NMS (Network Management System) or EMS (Element Management System).
-
physicalPorts: string
(uri)
Read Only:
true
The URI for the list of physical ports provided by the physical device instance. -
roles: array
roles
The list of physical device inventory roles.
Nested Schema : roles
Type:
array
The list of physical device inventory roles.
Show Source
-
Array of:
object Role
A role.
Nested Schema : type
Type:
Show Source
object
-
bitRate: string
Read Only:
true
The bitrate speed of transmission identified by the rate code. -
childDeviceInterfaces: array
childDeviceInterfaces
-
customerInterfaceNumber: string
The customer defined name for the device interface. Per the SID, this is the number of this particular device interface using a naming methodology defined by the customer.
-
interfaceNumber: string
A value intended to uniquely identify this device interface from all other instances. Oracle Communications product software does not ensure the uniqueness of interfaceNumber values.
-
logicalDeviceRef:
schema
A logical device.
-
parentDeviceInterfaceRef:
schema
A device interface.
-
rateCode: string
Read Only:
true
The technology and transmission bit rate supported by the interface. -
roles: array
roles
The list of device interface roles.
-
vendorInterfaceNumber: string
Nested Schema : schema
A logical device.
Match All
A logical device.
A logical device.
Show Source
-
object
allOf
LogicalResource
The base class for logical resources.
-
object
type
Nested Schema : roles
Type:
array
The list of device interface roles.
Show Source
-
Array of:
object Role
A role.
Nested Schema : type
Type:
Show Source
object
-
capacityConsumed: string
The capacity of the logical device consumed.
-
childDeviceInterfaces: array
childDeviceInterfaces
-
deviceIdentifier: string
The name of the device identifier.
-
deviceInterfaces: string
(uri)
The URI for the list of device interfaces for the logical device.
-
logicalDeviceAccounts: string
(uri)
The URI for the list of logical device accounts associated with the logical device.
-
modelNumber: string
The model number for the logical device.
-
networkLocation: object
schema
A place to associate with the resource/service.
-
partNumber: string
The part number for the logical device.
-
percentageConsumed: string
Percentage of the logical device's capacity consumed.
-
roles: array
roles
The list of logical device roles.
-
serviceLocation: object
schema
A place to associate with the resource/service.
-
totalCapacity: string
Total capacity of the logical device.
-
vendorName: string
The vendor name for the logical device.
Nested Schema : roles
Type:
array
The list of logical device roles.
Show Source
-
Array of:
object Role
A role.
Nested Schema : ImpactedItem
Type:
object
Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.
Show Source
-
action: string
If impacted connectivity/pipe design does not have any gap, then the action is VIEW DESIGN. If impacted connectivity/pipe design is not completed due to gap, then the action is RESOLVE GAP. If impacted item is service then the action is VIEW SERVICE.
-
changedEntity:
changedEntity
Impacted Connectivity or Pipe after rehome or groom.
-
parentChangeItem: string
Parent activity item due to which this item got imapacted.
-
serviceChangeEntity: object
schema
Service Class.
-
status: string
Allowed Values:
[ "PENDING", "READY", "IN_PROGRESS", "ABORTED", "ERROR", "FAILED", "PENDING_COMPLETE", "COMPLETED", "PENDING_PROCESS", "PENDING_ABORT" ]
The list of valid values for Activity State.
Nested Schema : changedEntity
Impacted Connectivity or Pipe after rehome or groom.
Match One Schema
Show Source
Nested Schema : schema
Type:
object
Service Class.
Show Source
-
businessInteraction: object
BusinessInteractionRef
-
category: string
Indicates if it is customer facing or resource facing service.
-
description: string
A free-text description for the service.
-
effectiveDate: string
(date-time)
The date and time when the service changes goes to activate.
-
endDate: string
(date-time)
The date and time when the service is no longer effective.
-
externalIdentity: object
ExternalIdentity
An external identity.
-
hasStarted: boolean
Read Only:
true
Flag indicates that service is started. -
href: string
Read Only:
true
The URI for the service class. -
id: string
Read Only:
true
The ID of the service. -
isServiceEnabled: boolean
Read Only:
true
If FALSE, this particular Service has NOT been enabled for use -
name: string
The name of the service.
-
place: array
place
The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources.
- relatedParty: array relatedParty
-
serviceCharacteristic: array
serviceCharacteristic
A list of characteristics that characterize this service (ServiceCharacteristic [*])
-
serviceDate: string
(date-time)
Read Only:
true
Date and time when the service was created (whatever its status). -
serviceOrderItem: array
serviceOrderItem
A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service.
-
serviceRelationship: array
serviceRelationship
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).
-
serviceSpecification: object
Specification
A specification.
-
serviceType: string
The business type of the service.
-
startDate: string
(date-time)
The date and time when the service is started.
-
state: string
Allowed Values:
[ "designed", "inactive", "active", "terminated", "pendingCancel", "cancelled", "pendingDisconnect", "cancelPendingDisconnect" ]
Valid values for the lifecycle state of the service. -
supportingResource: array
supportingResource
A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS.
-
supportingService: array
supportingService
A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS).
Nested Schema : BusinessInteractionRef
Type:
Show Source
object
-
id: string
The id of Business Interaction
-
state: string
The state of Business Interaction
Nested Schema : ExternalIdentity
Type:
object
An external identity.
Show Source
-
externalArrangement: string
Allowed Values:
[ "LEASED_IN", "FEDERATED", "LEASED_OUT", "SHARED" ]
The type of federation model between UIM and the external party for the given entity. -
externalManagementDomain: string
The external system, domain name, party, or participant in a federation solution.
-
externalName: string
The business-meaningful name of the business entity.
-
externalObjectId: string
The ID for a business entity.
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
-
Array of:
PlaceServiceRef
The place reference on a service.
Nested Schema : serviceCharacteristic
Type:
array
A list of characteristics that characterize this service (ServiceCharacteristic [*])
Show Source
-
Array of:
ServiceCharacteristic
The service characteristic details.
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
-
Array of:
object RelatedServiceOrderItem
The service order item which triggered service creation/change/termination.
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
-
Array of:
object ServiceRelationship
Describes links with services of the same category (useful for bundled services).
Nested Schema : Specification
Type:
object
A specification.
Show Source
-
autoGenId: boolean
The boolean value to indicate if id has to be auto-generated or entered manually by user.
-
characteristics: array
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.
-
description: string
Details about the specification.
-
displayName: string
The display name of the specification.
-
endDate: string
(date-time)
The date and time when the specification ends.
-
entityType: string
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. -
href: string
(uri)
The URI for the specification.
-
id(required): string
The ID of the specification, which is the same as the name of the specification.
-
name: string
The name of the specification.
-
pageEditLayout: object
PageLayout
Layout information for Create and Edit Pages
-
startDate: string
(date-time)
The date and time when the specification starts.
-
version: string
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
-
Array of:
ResourceServiceRef
The resource reference on a service.
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
-
Array of:
object schema
Service Class.
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
-
object
schema
A place to associate with the resource/service.
-
object
PlaceServiceRef-allOf[1]
Nested Schema : PlaceServiceRef-allOf[1]
Type:
Show Source
object
-
assignmentState: string
Allowed Values:
[ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]
The list of valid values for assignment state. -
configItemDisplayName: string
The config item display name of the place which is editable from UI.
-
configItemId: string
The config item id of the place.
-
configItemName: string
The config item name of the place.
-
consumerName: string
The name of the service consumer.
-
latitude: string
Latitude of the place.
-
longitude: string
Longitude of the place.
-
placeCharacteristic: array
placeCharacteristic
The list of characteristics for the place.
-
placeSpecification: object
Specification
A specification.
-
referenceState: string
Allowed Values:
[ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]
The list of valid values for reference state. -
referenceType: string
Allowed Values:
[ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ]
Valid values for the list of supported reference types. -
resourceName: string
The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'.
Nested Schema : placeCharacteristic
Type:
array
The list of characteristics for the place.
Show Source
-
Array of:
object Characteristic
A characteristic of an object or entity represented by a name-value pair.
Nested Schema : Characteristic
Type:
object
A characteristic of an object or entity represented by a name-value pair.
Show Source
-
@schemaLocation: string
(uri)
The URI for the JSON Schema file that defines additional attributes and relationships.
-
@type: string
The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the valueType is an object.
-
code: string
The enumeration code in case of enum type characteristics.
-
displayName: string
The display label of the charatcteristic.
-
name(required): string
The name of the characteristic.
-
value(required): object
value
The value of the characteristic.
-
valueType: string
Allowed Values:
[ "ALPHANUMERIC", "NUMERIC", "BOOLEAN", "DATE", "OBJECT", "URL" ]
The data type for the characteristics's value.
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
-
object
RelatedPartyRef
A related party, which defines a party or party role linked to a specific entity.
-
object
RelatedPartyServiceRef-allOf[1]
Nested Schema : RelatedPartyServiceRef-allOf[1]
Type:
Show Source
object
-
configItemDisplayName: string
The config item display name of the party which is editable from UI.
-
configItemId: string
The config item id of the party.
-
configItemName: string
The config item name of the party.
-
consumerName: string
The name of the service consumer.
-
partyCharacteristic: array
partyCharacteristic
The list of characteristics for the party.
-
partySpecification: object
Specification
A specification.
-
referenceState: string
Allowed Values:
[ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]
The list of valid values for reference state. -
referenceType: string
Allowed Values:
[ "Association", "Assignment", "Reference", "ResourceNetworkLocation", "ResourceAssociation" ]
Valid values for the list of supported reference types.
Nested Schema : partyCharacteristic
Type:
array
The list of characteristics for the party.
Show Source
-
Array of:
object Characteristic
A characteristic of an object or entity represented by a name-value pair.
Nested Schema : ServiceCharacteristic
The service characteristic details.
Match All
The service characteristic details.
The service characteristic details.
Show Source
-
object
Characteristic
A characteristic of an object or entity represented by a name-value pair.
-
object
ServiceCharacteristic-allOf[1]
Nested Schema : ServiceCharacteristic-allOf[1]
Type:
Show Source
object
-
configItemDisplayName: string
The config item display name of the service characteristic which is editable from UI.
-
configItemId: string
The config item id of the service characteristic.
-
configItemName: string
The config item name of the service characteristic.
-
configItemPath: string
The path of the config item's property. Its value can be get from design studio catridges where this property was designed.
-
isDesignParameter: boolean
Default Value:
false
If TRUE, this will be considered as a design parameter and not as a service characteristic. In this case, serviceSpecName or configItemPath are not mandatory. -
serviceName: string
The name of the service consumer.
-
serviceSpecName: string
The specification name of service.Required only for creation of the service.
Nested Schema : RelatedServiceOrderItem
Type:
object
The service order item which triggered service creation/change/termination.
Show Source
-
itemAction: string
Allowed Values:
[ "add", "modify", "delete", "noChange" ]
Valid values for the lifecycle state of the orderItemAction. -
itemId: string
Identifier of the order item where the service was managed.
-
role: string
Role of the service order item for this service.
-
serviceOrderHref: string
Reference of the related entity.
-
serviceOrderId: string
Unique identifier of a related entity.
Nested Schema : ServiceRelationship
Type:
object
Describes links with services of the same category (useful for bundled services).
Show Source
-
relationshipType(required): string
The type of relationship (e.g. depends on, enables)
-
service(required): object
schema
Service Class.
-
serviceRelationshipCharacteristic: array
serviceRelationshipCharacteristic
Nested Schema : serviceRelationshipCharacteristic
Type:
Show Source
array
-
Array of:
ServiceCharacteristic
The service characteristic details.
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
-
Array of:
object CharacteristicSpecification
A characteristic of an object or entity represented by a name-value pair.
Nested Schema : PageLayout
Type:
object
Layout information for Create and Edit Pages
Show Source
-
pageName: string
Name of the panel chosed in Layout
-
sections: array
SectionLayoutArr
Nested Schema : CharacteristicSpecification
Type:
object
A characteristic of an object or entity represented by a name-value pair.
Show Source
-
controlType:
controlType
-
displayName: string
The display name of the characteristic.
-
isHardAttribute: boolean
-
isRequired: boolean
The requirement of the element
-
name(required): string
The name of the characteristic.
-
primitiveType: string
Allowed Values:
[ "BOOLEAN", "DATE", "DATETIME", "DECIMAL", "DOUBLE", "FLOAT", "HEXBINARY", "INTEGER", "LONG", "STRING", "TIME" ]
The data type for the characteristics's value. -
valueChangeListener: boolean
Indicates if it is parent char and there are dependent chars when value is enterted for this char.
Nested Schema : controlType
Match One Schema
Show Source
-
object
DropDownCharSpec
List of attributes applicable only if Characteristic is of type dropdown.
-
object
TextCharSpec
List of attributes applicable only if Characteristic is of control type text.
-
object
URLCharSpec
List of attributes applicable only if Characteristic is of control type URL.
-
object
CalendarCharSpec
List of attributes applicable only if Characteristic is of control type Calendar.
-
object
NumericCharSpec
List of attributes applicable only if Characteristic is of control type Numeric.
-
object
CheckboxCharSpec
List of attributes applicable only if Characteristic is of control type Checkbox.
Nested Schema : DropDownCharSpec
Type:
object
List of attributes applicable only if Characteristic is of type dropdown.
Show Source
-
@type: string
Allowed Values:
[ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]
The list of valid values for the control type. -
defaultValue: string
The default value from the enumeration options.
-
enumerationOptions: array
enumerationOptions
The list of options.
-
options: string
Allowed Values:
[ "ENUMERATIONS", "ENTITYLINK", "QUERY" ]
The dropdown option for the element. -
sort: string
Allowed Values:
[ "ALPHANUMERIC", "NUMERIC" ]
The sorting order of the enumeration options.
Nested Schema : TextCharSpec
Type:
object
List of attributes applicable only if Characteristic is of control type text.
Show Source
-
@type: string
Allowed Values:
[ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]
The list of valid values for the control type. -
case: string
Allowed Values:
[ "MIXED", "UPPER", "LOWER" ]
The case of the characteristic. -
defaultValue: string
The default value of the characteristic.
-
defaultValueLocalized: string
The localized default value of the characteristic.
-
displayMask: string
The displayMask of the characteristic.
-
editMask: string
The editMask of the characteristic.
-
isReadOnly: boolean
Indicates if element is read only.
-
isSensitive: boolean
Indicates if element is to be hidden.
-
maxLength: integer
The maximum length of the characteristic.
-
minLength: integer
The minimum length of the characteristic.
Nested Schema : URLCharSpec
Type:
object
List of attributes applicable only if Characteristic is of control type URL.
Show Source
-
@type: string
Allowed Values:
[ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]
The list of valid values for the control type. -
defaultValue: string
The default value of the URL char
-
isReadOnly: boolean
The readOnly of the URL char
Nested Schema : CalendarCharSpec
Type:
object
List of attributes applicable only if Characteristic is of control type Calendar.
Show Source
-
@type: string
Allowed Values:
[ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]
The list of valid values for the control type. -
defaultValue: string
The default value of the Calendar char.
-
fromDateRange: string
The end date range of the Calendar char.
-
isReadOnly: boolean
The readOnly of the Calendar char.
-
toDateRange: string
The start date range of the Calendar char.
Nested Schema : NumericCharSpec
Type:
object
List of attributes applicable only if Characteristic is of control type Numeric.
Show Source
-
@type: string
Allowed Values:
[ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]
The list of valid values for the control type. -
defaultValue: integer
The default value of the Numeric char.
-
displayMask: string
The display mask of the Numeric char.
-
editMask: string
The edit mask of the Numeric char.
-
isReadOnly: boolean
The readOnly of the Numeric char.
-
isSensitive: boolean
The sensitive of the Numeric char.
-
maxValue: integer
The maximum value of the Numeric char.
-
minValue: integer
The minimum value of the Numeric char.
Nested Schema : CheckboxCharSpec
Type:
object
List of attributes applicable only if Characteristic is of control type Checkbox.
Show Source
-
@type: string
Allowed Values:
[ "DropDown", "Text", "URL", "Calendar", "Numeric", "Checkbox" ]
The list of valid values for the control type. -
defaultValue: boolean
The default value of the Checkbox char.
-
isReadOnly: boolean
The readOnly of the Checkbox char.
Nested Schema : Enumerations
Type:
Show Source
object
-
code: string
Key for the enum element.
-
default: boolean
Indicates if the code is default selected attribute in dropdown.
-
description: string
Description for the enum element.
-
language: string
The language of the element.
Nested Schema : SectionLayout
Type:
Show Source
object
-
elements: array
elements
The elements of the section.
-
localizedSectionNames: array
localizedSectionNames
The localized name of the section. This is for internal usage.
-
localizedSectionToolTip: array
localizedSectionToolTip
Localized Tool Tip of the section. This is for internal usage.
-
sectionName: string
The localized name of the section.
-
sectionTooltip: string
The localized tool tip of the section.
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 : ComponentSpecification
Type:
Show Source
object
-
case: string
The case of the element. Possible values are MIXED,UPPER,LOWER.
-
defaultValue: string
The default Value of the element.
-
displayMask: string
The displayMask of the element.
-
displayName: string
The localized display name of the element.
-
editMask: string
The editMask of the element.
-
elementName: string
The name of the hard attribute or char name.
-
fromDateRange: string
The end date Range of the element for Date Chars.
-
isExternal: boolean
Applicable only for URL Chars. Indicates if URL to be opened in new tab.
-
isHardAttribute: boolean
Indicates if element is hard attribute or not.
-
isReadOnly: boolean
Indicates if element is read only.
-
isRequired: boolean
Indicates if element is required.
-
isSensitive: boolean
Indicates if element has to be hidden.
-
localizedDisplayNames: array
localizedDisplayNames
The localized display names of the element. This is for internal usage.
-
localizedToolTips: array
localizedToolTips
The localized tool tips of the element. This is for internal usage.
-
maxValue: string
The maximum value of the element.
-
minValue: string
The minimum value of the element.
-
sort: string
Allowed Values:
[ "ALPHANUMERIC", "NUMERIC" ]
Applicable only for Enum chars. -
toDateRange: string
The start date Range of the element for Date Chars.
-
tooltip: string
The localized tooltip of the element.
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:
Show Source
object
-
language: string
Language of the element.
-
value: string
Value of the element.
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:
Show Source
object
-
@referredType: string
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. -
href: string
Read Only:
true
Reference of the supporting resource. -
id: string
Unique identifier of the supporting resource.
-
name: string
Name of the resource supporting the service.
Nested Schema : ResourceServiceRef-allOf[1]
Type:
Show Source
object
-
assignmentState: string
Allowed Values:
[ "PENDING_ASSIGN", "ASSIGNED", "PENDING_UNASSIGN", "UNASSIGNED", "DISCONNECTED", "TRANSITIONAL", "PORTED" ]
The list of valid values for assignment state. -
configItemDisplayName: string
The config item display name of the resource which is editable from UI.
-
configItemId: string
The config item id of the resource.
-
configItemName: string
The config item name of the resource.
-
consumerName: string
The name of the service consumer.
-
expandResource: object
Discriminator: @type
Discriminator:
{ "propertyName":"@type" }
A base resource Class. -
referenceState: string
Allowed Values:
[ "PENDING_REFERENCE", "REFERENCED", "PENDING_UNREFERENCE", "UNREFERENCED" ]
The list of valid values for reference state.
400 Response
The request isn't valid.
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
-
code: string
The error code.
-
entityType: string
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: array
message
The text that provides more details about the error as well as corrective actions.
-
reason: string
The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
-
referenceError: string
The URL pointing to the documentation that describes the error.
-
status: string
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.
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
-
code: string
The error code.
-
entityType: string
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: array
message
The text that provides more details about the error as well as corrective actions.
-
reason: string
The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
-
referenceError: string
The URL pointing to the documentation that describes the error.
-
status: string
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.
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
-
code: string
The error code.
-
entityType: string
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: array
message
The text that provides more details about the error as well as corrective actions.
-
reason: string
The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
-
referenceError: string
The URL pointing to the documentation that describes the error.
-
status: string
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 rehome project wasn't found.
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
-
code: string
The error code.
-
entityType: string
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: array
message
The text that provides more details about the error as well as corrective actions.
-
reason: string
The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
-
referenceError: string
The URL pointing to the documentation that describes the error.
-
status: string
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.
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
-
code: string
The error code.
-
entityType: string
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: array
message
The text that provides more details about the error as well as corrective actions.
-
reason: string
The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
-
referenceError: string
The URL pointing to the documentation that describes the error.
-
status: string
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
Examples
This example shows how to get the details of a rehome project with the given projectname and activityname 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/resourceInventoryManagement/version/rehome/projectname/activityname" -H 'content-type: application/json' -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".
- projectname is the name of the rehome project.
- activityname is the name of the rehome activity.
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"id": "34-TestRehome_InterIntra3_I",
"href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/rehome/34-TestRehome_InterIntra3_I/33-TestRehomeActivity_InterIntra3_I",
"projectName": "TestRehome_InterIntra3_I",
"status": "CREATED",
"activity": {
"id": "33-TestRehomeActivity_InterIntra3_I",
"activityName": "TestRehomeActivity_InterIntra3_I",
"status": "COMPLETED",
"activityItems": [
{
"changedEntity": {
"id": "31-248",
"href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/31-248",
"@type": "Connectivity",
"connectivityIdentifier": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
},
"source": {
"id": "20-DS3-75759-1",
"href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/20-DS3-75759-1",
"@type": "DeviceInterface"
},
"target": {
"id": "20-DS3-75791-1",
"href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/20-DS3-75791-1",
"@type": "DeviceInterface"
},
"status": "COMPLETED",
"comments": ""
}
],
"impactedItems": [
{
"action": "VIEW_DESIGN",
"changedEntity": {
"id": "31-248",
"href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/31-248",
"@type": "Connectivity",
"connectivityIdentifier": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
},
"status": "COMPLETED",
"parentChangeItem": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
},
{
"action": "VIEW_DESIGN",
"changedEntity": {
"id": "31-278",
"href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/31-278",
"@type": "Connectivity",
"connectivityIdentifier": "FRSCTX3A_I.002 / PLANTX3A_I.003 / DS1 / T1 / 1"
},
"status": "COMPLETED",
"parentChangeItem": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
},
{
"action": "VIEW_DESIGN",
"changedEntity": {
"id": "30-315",
"href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/resource/30-315",
"@type": "Pipe"
},
"status": "COMPLETED",
"parentChangeItem": "ALLTX3A_I.001 / PLANTX3A_I.002 / DS3 / T3 / 1"
}
]
}
}