Jump to

• Request
• Response
• Examples

Create a Replace Card activity

post

/replacecard

Creates a Project with Replace Card activity having specified replace card activity items.
Optionally, the project can be auto submitted by sending a query parameter 'submit=true'

Request

Query Parameters

• submit: boolean
  To submit the replace card project post creation.

Supported Media Types

• application/json

Request Body - application/json ()

The replace card project to be created

Root Schema : schema

Type: object

ReplaceCard Project Class.

Show Source

• activity: object ReplaceCardActivity
  ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.
• description: string
  A free-text description for the project.
• href: string (uri)
  Read Only: true

  The URI for the ReplaceCardProject 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.

{
    "type":"object",
    "description":"ReplaceCard Project Class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project.",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "description":"The URI for the ReplaceCardProject class.",
            "format":"uri",
            "readOnly":true
        },
        "projectName":{
            "type":"string",
            "description":"The name of the project."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the project."
        },
        "status":{
            "$ref":"#/components/schemas/ProjectStateEnum",
            "readOnly":true
        },
        "activity":{
            "description":"Activity",
            "$ref":"#/components/schemas/ReplaceCardActivity"
        }
    }
}

Nested Schema : ReplaceCardActivity

Type: object

ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.

Show Source

• activityItems: array activityItems
• activityName: string
  The name of the activity.
• autoMap: boolean
  Auto maps the consumers of source card's physical ports to target card's physical ports in the same order.
• id: string
  The ID of the Activity.
• impactedItems: array impactedItems
• sourceCard: schema
  An equipment resource.
• 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.
• targetCard: schema
  An equipment resource.

{
    "type":"object",
    "description":"ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the Activity."
        },
        "activityName":{
            "type":"string",
            "description":"The name of the activity."
        },
        "autoMap":{
            "type":"boolean",
            "description":"Auto maps the consumers of source card's physical ports to target card's physical ports in the same order."
        },
        "sourceCard":{
            "description":"The source card which is replaced from it's parent equipment.",
            "$ref":"#/components/schemas/Equipment"
        },
        "targetCard":{
            "description":"The target card which is replacing the source card and is added in the parent Shelf equipment.",
            "$ref":"#/components/schemas/Equipment"
        },
        "status":{
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "activityItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReplaceCardActivityItem"
            }
        },
        "impactedItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImpactedItem"
            }
        }
    }
}

Nested Schema : activityItems

Type: array

Show Source

• Array of: object ReplaceCardActivityItem
  A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReplaceCardActivityItem"
    }
}

Nested Schema : impactedItems

Type: array

Show Source

• Array of: object ImpactedItem
  Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImpactedItem"
    }
}

Nested Schema : schema

An equipment resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"An equipment resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"string",
                    "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
                    "readOnly":true
                },
                "vendorName":{
                    "type":"string",
                    "description":"The name of the equipment manufacturer.",
                    "readOnly":true
                },
                "modelNumber":{
                    "type":"string",
                    "description":"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.",
                    "readOnly":true
                },
                "partNumber":{
                    "type":"string",
                    "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
                    "readOnly":true
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the equipment instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the physical port instances provided by the equipment instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of equipment inventory roles."
                }
            }
        }
    ]
}

Nested Schema : ReplaceCardActivityItem

Type: object

A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.

Show Source

• changedEntity: changedEntity
  The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.
• comments: string
  Comments related to failure of replace card activity items if any.
• serviceChangedEntity: object schema
  Service Class.
• source: source
  Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.
• 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 Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.

{
    "type":"object",
    "description":"A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.",
    "properties":{
        "changedEntity":{
            "description":"The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "serviceChangedEntity":{
            "description":"Service consumers of the port of the source card.",
            "$ref":"#/components/schemas/Service"
        },
        "source":{
            "description":"Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/PhysicalPort"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "target":{
            "description":"Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/PhysicalPort"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "status":{
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "comments":{
            "type":"string",
            "description":"Comments related to failure of replace card activity items if any."
        }
    }
}

Nested Schema : changedEntity

The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.
• schema
  An equipment resource.

{
    "description":"The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

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
  A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.
• 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).

{
    "type":"object",
    "description":"Service Class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service.",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "description":"The URI for the service class.",
            "readOnly":true
        },
        "businessInteraction":{
            "$ref":"#/components/schemas/BusinessInteractionRef",
            "description":"A related Business Interaction. A related business interaction linked to a specific entity."
        },
        "category":{
            "type":"string",
            "description":"Indicates if it is customer facing or resource facing service."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the service."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is no longer effective."
        },
        "hasStarted":{
            "type":"boolean",
            "description":"Flag indicates that service is started.",
            "readOnly":true
        },
        "isServiceEnabled":{
            "type":"boolean",
            "description":"If FALSE, this particular Service has NOT been enabled for use",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "serviceDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time when the service was created (whatever its status).",
            "readOnly":true
        },
        "supportingResource":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceServiceRef"
            },
            "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is started."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyServiceRef"
            },
            "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
        },
        "serviceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            },
            "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
        },
        "serviceRelationship":{
            "type":"array",
            "description":"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).",
            "items":{
                "$ref":"#/components/schemas/ServiceRelationship"
            }
        },
        "serviceType":{
            "type":"string",
            "description":"The business type of the service."
        },
        "supportingService":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Service"
            },
            "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
        },
        "serviceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "state":{
            "$ref":"#/components/schemas/ServiceStateEnum"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceServiceRef"
            },
            "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
        },
        "externalIdentity":{
            "$ref":"#/components/schemas/ExternalIdentity"
        },
        "serviceOrderItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedServiceOrderItem"
            },
            "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service changes goes to activate."
        }
    }
}

Nested Schema : source

Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.

Match One Schema

Show Source

• schema
  A physical port.
• schema
  An equipment resource.

{
    "description":"Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PhysicalPort"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : target

Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.

Match One Schema

Show Source

• schema
  A physical port.
• schema
  An equipment resource.

{
    "description":"Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PhysicalPort"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : schema

A pipe resource.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A pipe resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "totalConsumedCapacity":{
                    "type":"string",
                    "description":"The total consumed capacity."
                },
                "capacityProvidedRef":{
                    "$ref":"#/components/schemas/CapacityProvided"
                },
                "capacityRequiredRef":{
                    "$ref":"#/components/schemas/CapacityRequired"
                },
                "capacityConsumedRef":{
                    "$ref":"#/components/schemas/CapacityConsumed"
                },
                "allowSecondaryEnablement":{
                    "type":"boolean",
                    "description":"To allow SecondaryEnablement for a pipe or not."
                },
                "isVersioned":{
                    "type":"boolean",
                    "description":"To denote whether pipe is versioned or not."
                },
                "aendTerminationPoint":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for aterminationPoint of the pipe."
                },
                "zendTerminationPoint":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for zterminationPoint of the pipe."
                },
                "primaryPathEnabled":{
                    "$ref":"#/components/schemas/PipeEnablement"
                },
                "secondaryPathEnabled":{
                    "$ref":"#/components/schemas/PipeEnablement"
                },
                "transmissionSignalType":{
                    "type":"string",
                    "description":"The TransmissionSignalType of the pipe. Valid values are NONE, ELECTRICAL, ELECTROMAGNETIC, OPTICAL, UNKNOWN.",
                    "enum":[
                        "ELECTRICAL",
                        "ELECTROMAGNETIC",
                        "OPTICAL",
                        "UNKNOWN",
                        "NONE"
                    ]
                },
                "medium":{
                    "type":"string",
                    "description":"The Medium of the pipe. Valid values are NONE, WIRELESS, METALLIC, FIBER, SOFTWARE, UNKNOWN.",
                    "enum":[
                        "WIRELESS",
                        "METALLIC",
                        "FIBER",
                        "SOFTWARE",
                        "UNKNOWN",
                        "NONE"
                    ]
                },
                "gridType":{
                    "type":"string",
                    "description":"The GridType of the pipe. Valid values are NONE, FIXED, FLEX_GRID.",
                    "enum":[
                        "FIXED",
                        "FLEX_GRID",
                        "NONE"
                    ]
                },
                "channelSpacing":{
                    "type":"string",
                    "description":"The channelSpacing of pipe."
                },
                "pipeDirectionalityRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PipeDirectionality"
                    },
                    "description":"The list of pipe directionalities."
                },
                "parentPipeRef":{
                    "$ref":"#/components/schemas/Pipe"
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of pipe inventory roles."
                }
            }
        }
    ]
}

Nested Schema : schema

A Connectivity resource.

Match All

Show Source

• allOf schema
  A pipe resource.
• object type

{
    "description":"A Connectivity resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "type":"object",
            "properties":{
                "connectivityIdentifier":{
                    "type":"string",
                    "description":"A unique identifier of Connectivity."
                },
                "technology":{
                    "type":"string",
                    "description":"The technology that applies to connectivity."
                },
                "identificationFormat":{
                    "$ref":"#/components/schemas/ConnectivityIdentifierFormatEnum"
                },
                "ALocation":{
                    "$ref":"#/components/schemas/PlaceRef",
                    "description":"The network location code or network entity code for the A side of the connectivity."
                },
                "ZLocation":{
                    "$ref":"#/components/schemas/PlaceRef",
                    "description":"The network location code or network entity code for the Z side of the connectivity."
                },
                "rateCode":{
                    "type":"string",
                    "description":"The rate code that applies to connectivity."
                },
                "function":{
                    "type":"string",
                    "description":"The function that applies to connectivity. Functions apply only to connectivities that have rate codes that define them as facilities."
                },
                "serialNumber":{
                    "type":"integer",
                    "description":"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."
                },
                "quantity":{
                    "type":"integer",
                    "description":"The number of Connectivity entities to be created."
                },
                "isAssignContiguousSerialNumber":{
                    "type":"boolean",
                    "description":"Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block."
                },
                "consumablePercent":{
                    "type":"integer",
                    "description":"Percentage of capacity that can be consumed."
                },
                "bitRate":{
                    "type":"string",
                    "description":"The bit rate is based on the rate code applied to the connectivity."
                },
                "assignedToService":{
                    "type":"string",
                    "format":"uri",
                    "description":"The service (if any) to which the connectivity is assigned."
                },
                "isInternetwork":{
                    "type":"boolean",
                    "description":"If it is inter network or not."
                },
                "isInternetworkExternal":{
                    "type":"boolean",
                    "description":"If it is internetwork external or not."
                },
                "otherServiceProviderName":{
                    "type":"string",
                    "description":"Name of other service provider."
                },
                "otherProviderDemarcationPoint":{
                    "$ref":"#/components/schemas/AZLocationTypeEnum"
                },
                "isServiceMultiplexing":{
                    "type":"boolean",
                    "description":"If it is service multiplexing or not."
                },
                "isBundling":{
                    "type":"boolean",
                    "description":"If it is bundling or not."
                },
                "isAllToOneBundling":{
                    "type":"boolean",
                    "description":"If all to one bundling is applicable."
                },
                "isVlanBased":{
                    "type":"boolean",
                    "description":"If it is vlan based or not."
                },
                "maxPacketVirtualNetworkCount":{
                    "type":"integer",
                    "description":"count of maximum packet virtual network."
                },
                "committedInformationRateDisplay":{
                    "type":"string",
                    "description":"Information rate."
                },
                "maxInformationRateDisplay":{
                    "type":"string",
                    "description":"maximum information rate."
                },
                "connectivityDesign":{
                    "$ref":"#/components/schemas/ConnectivityDesign"
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

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" ]

  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" ]

  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.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "totalConsumedCapacity":{
            "type":"string",
            "description":"The total consumed capacity."
        },
        "capacityProvidedRef":{
            "$ref":"#/components/schemas/CapacityProvided"
        },
        "capacityRequiredRef":{
            "$ref":"#/components/schemas/CapacityRequired"
        },
        "capacityConsumedRef":{
            "$ref":"#/components/schemas/CapacityConsumed"
        },
        "allowSecondaryEnablement":{
            "type":"boolean",
            "description":"To allow SecondaryEnablement for a pipe or not."
        },
        "isVersioned":{
            "type":"boolean",
            "description":"To denote whether pipe is versioned or not."
        },
        "aendTerminationPoint":{
            "type":"string",
            "format":"uri",
            "description":"The URI for aterminationPoint of the pipe."
        },
        "zendTerminationPoint":{
            "type":"string",
            "format":"uri",
            "description":"The URI for zterminationPoint of the pipe."
        },
        "primaryPathEnabled":{
            "$ref":"#/components/schemas/PipeEnablement"
        },
        "secondaryPathEnabled":{
            "$ref":"#/components/schemas/PipeEnablement"
        },
        "transmissionSignalType":{
            "type":"string",
            "description":"The TransmissionSignalType of the pipe. Valid values are NONE, ELECTRICAL, ELECTROMAGNETIC, OPTICAL, UNKNOWN.",
            "enum":[
                "ELECTRICAL",
                "ELECTROMAGNETIC",
                "OPTICAL",
                "UNKNOWN",
                "NONE"
            ]
        },
        "medium":{
            "type":"string",
            "description":"The Medium of the pipe. Valid values are NONE, WIRELESS, METALLIC, FIBER, SOFTWARE, UNKNOWN.",
            "enum":[
                "WIRELESS",
                "METALLIC",
                "FIBER",
                "SOFTWARE",
                "UNKNOWN",
                "NONE"
            ]
        },
        "gridType":{
            "type":"string",
            "description":"The GridType of the pipe. Valid values are NONE, FIXED, FLEX_GRID.",
            "enum":[
                "FIXED",
                "FLEX_GRID",
                "NONE"
            ]
        },
        "channelSpacing":{
            "type":"string",
            "description":"The channelSpacing of pipe."
        },
        "pipeDirectionalityRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PipeDirectionality"
            },
            "description":"The list of pipe directionalities."
        },
        "parentPipeRef":{
            "$ref":"#/components/schemas/Pipe"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of pipe inventory roles."
        }
    }
}

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.

{
    "type":"object",
    "description":"Consumed capacity of pipe.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the CapacityConsumed."
        },
        "name":{
            "type":"string",
            "description":"The name of the CapacityConsumed."
        },
        "percentConsumed":{
            "type":"string",
            "description":"Consumed capacity percentage."
        },
        "capacityConsumed":{
            "type":"string",
            "description":"Capacity consumed."
        }
    }
}

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.

{
    "type":"object",
    "description":"A capacity provided.",
    "properties":{
        "capacityType":{
            "type":"string",
            "description":"Capacity type of capacity provided."
        },
        "totalAmount":{
            "type":"string",
            "description":"Total amount of capacity provided."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure valid are Gbps,Kbps,Mbps,bps."
        },
        "consumablePercentage":{
            "type":"string",
            "description":"Percentage of capacity that can be consumable."
        }
    }
}

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.

{
    "type":"object",
    "description":"Required capacity of pipe.",
    "properties":{
        "capacityType":{
            "type":"string",
            "description":"Capacity type of required capacity."
        },
        "requiredAmount":{
            "type":"string",
            "description":"Required amount of capacity."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure valid are Gbps,Kbps,Mbps,bps."
        },
        "quantity":{
            "type":"integer",
            "description":"Percentage of capacity that can be consumable."
        }
    }
}

Nested Schema : pipeDirectionalityRef

Type: array

The list of pipe directionalities.

Show Source

• Array of: object PipeDirectionality
  A Pipe Directionality .

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PipeDirectionality"
    },
    "description":"The list of pipe directionalities."
}

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.

{
    "type":"object",
    "description":"Segment details that are enabling current Connectivity.",
    "properties":{
        "originatingTerminationPoint":{
            "type":"string",
            "description":"The id of the originatingTerminationPoint."
        },
        "terminatingTerminationPoint":{
            "type":"string",
            "description":"The id of the terminatingTerminationPoint."
        },
        "pipeSegmentRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Segment"
            },
            "description":"The list of pipe segments."
        }
    }
}

Nested Schema : roles

Type: array

The list of pipe inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of pipe inventory roles."
}

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.

{
    "type":"object",
    "description":"A Pipe Directionality .",
    "properties":{
        "pipeDirection":{
            "type":"string",
            "description":"The direction of the pipe.",
            "enum":[
                "BI_DIRECTIONAL",
                "UNI_DIRECTIONAL",
                "UNKNOWN"
            ]
        },
        "directionalityType":{
            "type":"string",
            "description":"The directionalityType of the pipe.",
            "enum":[
                "ROUTING",
                "SIGNAL"
            ]
        },
        "terminationId1":{
            "type":"string",
            "description":"The ID of the termination1."
        },
        "terminationId2":{
            "type":"string",
            "description":"The ID of the termination2."
        },
        "terminationName1":{
            "type":"string",
            "description":"The name of the termination1."
        },
        "terminationName2":{
            "type":"string",
            "description":"The name of the termination2."
        },
        "terminationDirectType1":{
            "type":"string",
            "description":"The DirectType of the termination1. Valid values are SINK, SOURCE, UNKNOWN.",
            "enum":[
                "SINK",
                "SOURCE",
                "UNKNOWN"
            ]
        },
        "terminationDirectType2":{
            "type":"string",
            "description":"The DirectType of the termination2. Valid values are SINK, SOURCE, UNKNOWN.",
            "enum":[
                "SINK",
                "SOURCE",
                "UNKNOWN"
            ]
        }
    }
}

Nested Schema : pipeSegmentRef

Type: array

The list of pipe segments.

Show Source

• Array of: object Segment
  Segment details that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Segment"
    },
    "description":"The list of pipe segments."
}

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.

{
    "type":"object",
    "description":"Segment details that are enabling current Connectivity.",
    "properties":{
        "segmentNumber":{
            "type":"string",
            "description":"Segment number."
        },
        "asideTerminationPoint":{
            "type":"string",
            "description":"The id of Termination point."
        },
        "asideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "asidePhysicalPort":{
            "$ref":"#/components/schemas/LogicalResource"
        },
        "aendLocation":{
            "type":"string",
            "description":"A side Location."
        },
        "segmentRef":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                }
            ]
        },
        "flowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "isGap":{
            "type":"boolean",
            "description":"Identifies if it is a gap or not."
        },
        "interconnectionType":{
            "$ref":"#/components/schemas/InterConnectionTypeEnum"
        },
        "zsideTerminationPoint":{
            "type":"string",
            "description":"The id of Termination point."
        },
        "zsideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "zendLocation":{
            "type":"string",
            "description":"Z side Location."
        },
        "zsidePhysicalPort":{
            "$ref":"#/components/schemas/LogicalResource"
        },
        "gapAccepted":{
            "type":"boolean",
            "description":"Use this attribute to accept gap. Default Reason for accepting gap is auto-generated as \"GAP OK\""
        },
        "lifeCycleBinding":{
            "$ref":"#/components/schemas/InterConnectionLifeCycleBindingEnum"
        }
    }
}

Nested Schema : flowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : segmentRef

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        }
    ]
}

Nested Schema : schema

A flow identifier.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A flow identifier.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "identifier":{
                    "type":"integer",
                    "description":"The ID of the flow identifier."
                },
                "identifierPrefix":{
                    "type":"string",
                    "description":"Prefix for the Identifier."
                },
                "domain":{
                    "$ref":"#/components/schemas/NetworkAddressDomain"
                },
                "stackingLevel":{
                    "type":"integer",
                    "description":"The stacking level of the flow identifier."
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• domain: schema
  A network address domain.
• identifier: integer
  The ID of the flow identifier.
• identifierPrefix: string
  Prefix for the Identifier.
• stackingLevel: integer
  The stacking level of the flow identifier.

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"integer",
            "description":"The ID of the flow identifier."
        },
        "identifierPrefix":{
            "type":"string",
            "description":"Prefix for the Identifier."
        },
        "domain":{
            "$ref":"#/components/schemas/NetworkAddressDomain"
        },
        "stackingLevel":{
            "type":"integer",
            "description":"The stacking level of the flow identifier."
        }
    }
}

Nested Schema : schema

A network address domain.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A network address domain.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The name of the network address domain. It also indicates the ID of the domain."
                },
                "networkAddressType":{
                    "type":"string",
                    "description":"The type of network address, either IP Subnet or flow identifier."
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the network address domain. It also indicates the ID of the domain."
        },
        "networkAddressType":{
            "type":"string",
            "description":"The type of network address, either IP Subnet or flow identifier."
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

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.

{
    "type":"object",
    "description":"A related party, which defines a party or party role linked to a specific entity.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the related party."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the related party."
        },
        "name":{
            "type":"string",
            "description":"The name of the related party."
        },
        "role":{
            "type":"string",
            "description":"The role of the related party."
        },
        "@referredType":{
            "type":"string",
            "description":"Concrete Type of the Party, in case of dis-ambiguity. Default  is '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.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

Nested Schema : type

Type: object

Show Source

• ALocation: object PlaceRef
  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.
• committedInformationRateDisplay: string
  Information rate.
• 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.
• identificationFormat: string
  Allowed Values: [ "LOCATION_BASED", "SERVICE_BASED", "CUSTOM_IDENTIFICATION" ]

  The list of valid values for Connectivity identifier format.
• isAllToOneBundling: boolean
  If all to one bundling is applicable.
• isAssignContiguousSerialNumber: boolean
  Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block.
• isBundling: boolean
  If it is bundling or not.
• isInternetwork: boolean
  If it is inter network or not.
• isInternetworkExternal: boolean
  If it is internetwork external or not.
• isServiceMultiplexing: boolean
  If it is service multiplexing or not.
• isVlanBased: boolean
  If it is vlan based or not.
• maxInformationRateDisplay: string
  maximum information rate.
• maxPacketVirtualNetworkCount: integer
  count of maximum packet virtual network.
• otherProviderDemarcationPoint: string
  Allowed Values: [ "A_LOCATION", "Z_LOCATION" ]

  The list of valid values for AZLocationType.
• otherServiceProviderName: string
  Name of other service provider.
• 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 PlaceRef
  A place to associate with the resource/service.

{
    "type":"object",
    "properties":{
        "connectivityIdentifier":{
            "type":"string",
            "description":"A unique identifier of Connectivity."
        },
        "technology":{
            "type":"string",
            "description":"The technology that applies to connectivity."
        },
        "identificationFormat":{
            "$ref":"#/components/schemas/ConnectivityIdentifierFormatEnum"
        },
        "ALocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the A side of the connectivity."
        },
        "ZLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the Z side of the connectivity."
        },
        "rateCode":{
            "type":"string",
            "description":"The rate code that applies to connectivity."
        },
        "function":{
            "type":"string",
            "description":"The function that applies to connectivity. Functions apply only to connectivities that have rate codes that define them as facilities."
        },
        "serialNumber":{
            "type":"integer",
            "description":"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."
        },
        "quantity":{
            "type":"integer",
            "description":"The number of Connectivity entities to be created."
        },
        "isAssignContiguousSerialNumber":{
            "type":"boolean",
            "description":"Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block."
        },
        "consumablePercent":{
            "type":"integer",
            "description":"Percentage of capacity that can be consumed."
        },
        "bitRate":{
            "type":"string",
            "description":"The bit rate is based on the rate code applied to the connectivity."
        },
        "assignedToService":{
            "type":"string",
            "format":"uri",
            "description":"The service (if any) to which the connectivity is assigned."
        },
        "isInternetwork":{
            "type":"boolean",
            "description":"If it is inter network or not."
        },
        "isInternetworkExternal":{
            "type":"boolean",
            "description":"If it is internetwork external or not."
        },
        "otherServiceProviderName":{
            "type":"string",
            "description":"Name of other service provider."
        },
        "otherProviderDemarcationPoint":{
            "$ref":"#/components/schemas/AZLocationTypeEnum"
        },
        "isServiceMultiplexing":{
            "type":"boolean",
            "description":"If it is service multiplexing or not."
        },
        "isBundling":{
            "type":"boolean",
            "description":"If it is bundling or not."
        },
        "isAllToOneBundling":{
            "type":"boolean",
            "description":"If all to one bundling is applicable."
        },
        "isVlanBased":{
            "type":"boolean",
            "description":"If it is vlan based or not."
        },
        "maxPacketVirtualNetworkCount":{
            "type":"integer",
            "description":"count of maximum packet virtual network."
        },
        "committedInformationRateDisplay":{
            "type":"string",
            "description":"Information rate."
        },
        "maxInformationRateDisplay":{
            "type":"string",
            "description":"maximum information rate."
        },
        "connectivityDesign":{
            "$ref":"#/components/schemas/ConnectivityDesign"
        }
    }
}

Nested Schema : PlaceRef

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.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : ConnectivityDesign

Type: object

Gives the details of latest connectivity design version.

Show Source

• aendLocation: object PlaceRef
  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.
• terminateAtFlowInterface: boolean
  This should be true if end point needs to be terminated at Flow Interface.
• zendLocation: object PlaceRef
  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.

{
    "type":"object",
    "description":"Gives the details of latest connectivity design version.",
    "properties":{
        "connectivityDesignVersion":{
            "type":"integer",
            "description":"The version number of connectivity design."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the connectivity design becomes effective."
        },
        "status":{
            "$ref":"#/components/schemas/ConfigurationStateEnum",
            "description":"The configuration status of latest connectivity design version."
        },
        "asideTerminationPointId":{
            "type":"string",
            "description":"The id of Termination point on A side."
        },
        "zsideTerminationPointId":{
            "type":"string",
            "description":"The id of Termination point on Z side."
        },
        "aendLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the A side of the connectivity."
        },
        "zendLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the Z side of the connectivity."
        },
        "asideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "zsideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for Z side interface of the connectivity."
        },
        "asideFlowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "zsideFlowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "terminateAtFlowInterface":{
            "type":"boolean",
            "description":"This should be true if end point needs to be terminated at Flow Interface."
        },
        "paths":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectivityPath"
            }
        }
    }
}

Nested Schema : asideFlowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : paths

Type: array

Show Source

• Array of: object ConnectivityPath
  Paths that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ConnectivityPath"
    }
}

Nested Schema : zsideFlowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : ConnectivityPath

Type: object

Paths that are enabling current Connectivity.

Show Source

• label: string
  Path label like Path1, Path2.
• segments: array segments

{
    "type":"object",
    "description":"Paths that are enabling current Connectivity.",
    "properties":{
        "label":{
            "type":"string",
            "description":"Path label like Path1, Path2."
        },
        "segments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Segment"
            }
        }
    }
}

Nested Schema : segments

Type: array

Show Source

• Array of: object Segment
  Segment details that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Segment"
    }
}

Nested Schema : BusinessInteractionRef

Type: object

Show Source

• id: string
  The id of Business Interaction
• state: string
  The state of Business Interaction

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of Business Interaction"
        },
        "state":{
            "type":"string",
            "description":"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.

{
    "type":"object",
    "description":"An external identity.",
    "properties":{
        "externalObjectId":{
            "type":"string",
            "description":"The ID for a business entity."
        },
        "externalName":{
            "type":"string",
            "description":"The business-meaningful name of the business entity."
        },
        "externalManagementDomain":{
            "type":"string",
            "description":"The external system, domain name, party, or participant in a federation solution."
        },
        "externalArrangement":{
            "type":"string",
            "description":"The type of federation model between UIM and the external party for the given entity.",
            "enum":[
                "LEASED_IN",
                "FEDERATED",
                "LEASED_OUT",
                "SHARED"
            ]
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaceServiceRef"
    },
    "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
}

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

• Array of: RelatedPartyServiceRef
  The party reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyServiceRef"
    },
    "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
}

Nested Schema : serviceCharacteristic

Type: array

A list of characteristics that characterize this service (ServiceCharacteristic [*])

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceCharacteristic"
    },
    "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedServiceOrderItem"
    },
    "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
}

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).

{
    "type":"array",
    "description":"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).",
    "items":{
        "$ref":"#/components/schemas/ServiceRelationship"
    }
}

Nested Schema : Specification

Type: object

A specification.

Show Source

• description: string
  Details about the specification.
• endDate: string (date-time)
  The date and time when the specification ends.
• entityType: string
  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.
• 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.
• startDate: string (date-time)
  The date and time when the specification starts.
• version: string
  The version of the specification, which is always 1.

{
    "type":"object",
    "description":"A specification.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the specification, which is the same as the name of the specification."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the specification."
        },
        "name":{
            "type":"string",
            "description":"The name of the specification."
        },
        "description":{
            "type":"string",
            "description":"Details about the specification."
        },
        "version":{
            "type":"string",
            "description":"The version of the specification, which is always <b>1</b>."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification starts."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification ends."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceServiceRef"
    },
    "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Service"
    },
    "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
}

Nested Schema : PlaceServiceRef

The place reference on a service.

Match All

Show Source

• object PlaceRef
  A place to associate with the resource/service.
• object PlaceServiceRef-allOf[1]

{
    "description":"The place reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PlaceRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "resourceName":{
                    "type":"string",
                    "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "latitude":{
                    "type":"string",
                    "description":"Latitude of the place."
                },
                "longitude":{
                    "type":"string",
                    "description":"Longitude of the place."
                },
                "placeSpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "placeCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the place."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the place."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the place."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the place which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : PlaceServiceRef-allOf[1]

Type: object

Show Source

• 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'.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "resourceName":{
            "type":"string",
            "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "latitude":{
            "type":"string",
            "description":"Latitude of the place."
        },
        "longitude":{
            "type":"string",
            "description":"Longitude of the place."
        },
        "placeSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "placeCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the place."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the place."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the place."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the place which is editable from UI."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the place."
}

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.
• 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.

{
    "type":"object",
    "description":"A characteristic of an object or entity represented by a name-value pair.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the characteristic."
        },
        "valueType":{
            "type":"string",
            "description":"The data type for the characteristics's value.",
            "enum":[
                "ALPHANUMERIC",
                "NUMERIC",
                "BOOLEAN",
                "DATE",
                "OBJECT",
                "URL"
            ]
        },
        "value":{
            "type":"object",
            "description":"The value of the characteristic."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI for the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the <b>valueType</b> is an object."
        }
    }
}

Nested Schema : value

Type: object

The value of the characteristic.

Nested Schema : RelatedPartyServiceRef

The party reference on a service.

Match All

Show Source

• object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• object RelatedPartyServiceRef-allOf[1]

{
    "description":"The party reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "partySpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "partyCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the party."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the party."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the party."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the party which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : RelatedPartyServiceRef-allOf[1]

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "partySpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "partyCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the party."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the party."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the party."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the party which is editable from UI."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the party."
}

Nested Schema : ServiceCharacteristic

The service characteristic details.

Match All

Show Source

• object Characteristic
  A characteristic of an object or entity represented by a name-value pair.
• object ServiceCharacteristic-allOf[1]

{
    "description":"The service characteristic details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Characteristic"
        },
        {
            "type":"object",
            "properties":{
                "serviceName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "serviceSpecName":{
                    "type":"string",
                    "description":"The specification name of service.Required only for creation of the service."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the service characteristic."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the service characteristic."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the service characteristic which is editable from UI."
                },
                "configItemPath":{
                    "type":"string",
                    "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
                }
            }
        }
    ]
}

Nested Schema : ServiceCharacteristic-allOf[1]

Type: object

Show Source

• 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.
• serviceName: string
  The name of the service consumer.
• serviceSpecName: string
  The specification name of service.Required only for creation of the service.

{
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "serviceSpecName":{
            "type":"string",
            "description":"The specification name of service.Required only for creation of the service."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the service characteristic."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the service characteristic."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the service characteristic which is editable from UI."
        },
        "configItemPath":{
            "type":"string",
            "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
        }
    }
}

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.

{
    "type":"object",
    "required":[
        "itemId, serviceOrderId"
    ],
    "description":"The service order item which triggered service creation/change/termination.",
    "properties":{
        "itemAction":{
            "$ref":"#/components/schemas/OrderItemActionEnum"
        },
        "itemId":{
            "type":"string",
            "description":"Identifier of the order item where the service was managed."
        },
        "role":{
            "type":"string",
            "description":"Role of the service order item for this service."
        },
        "serviceOrderHref":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "serviceOrderId":{
            "type":"string",
            "description":"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

{
    "required":[
        "relationshipType",
        "service"
    ],
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"The type of relationship (e.g. depends on, enables)"
        },
        "service":{
            "$ref":"#/components/schemas/Service"
        },
        "serviceRelationshipCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            }
        }
    },
    "description":"Describes links with services of the same category (useful for bundled services)."
}

Nested Schema : serviceRelationshipCharacteristic

Type: array

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceCharacteristic"
    }
}

Nested Schema : ResourceServiceRef

The resource reference on a service.

Match All

Show Source

• object ResourceRef
• object ResourceServiceRef-allOf[1]

{
    "description":"The resource reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceRef"
        },
        {
            "type":"object",
            "properties":{
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "expandResource":{
                    "$ref":"#/components/schemas/ResourceBase"
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the resource."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the resource."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the resource which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : ResourceRef

Type: object

Show Source

• @referredType: string
  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.
• 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.

{
    "type":"object",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the supporting resource."
        },
        "href":{
            "type":"string",
            "description":"Reference of the supporting resource.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the resource supporting the service."
        },
        "@referredType":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        }
    }
}

Nested Schema : ResourceServiceRef-allOf[1]

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "expandResource":{
            "$ref":"#/components/schemas/ResourceBase"
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the resource."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the resource."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the resource which is editable from UI."
        }
    }
}

Nested Schema : schema

A physical port.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical port.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "portNumber":{
                    "type":"integer",
                    "description":"A non-zero integer that uniquely identifies this physical port instance from all other instances."
                },
                "vendorPortName":{
                    "type":"string",
                    "description":"The vendor-specific name for the port."
                },
                "customerPortName":{
                    "type":"string",
                    "description":"The customer-specific name for the port."
                },
                "physicalDeviceRef":{
                    "$ref":"#/components/schemas/PhysicalDevice"
                },
                "equipmentRef":{
                    "$ref":"#/components/schemas/Equipment"
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of physical port inventory roles."
                }
            }
        }
    ]
}

Nested Schema : PhysicalResource

Type: object

The base class for physical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object PhysicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for physical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object",
            "properties":{
                "serialNumber":{
                    "type":"string",
                    "description":"The serial number for the physical resource."
                }
            }
        }
    ]
}

Nested Schema : PhysicalResource-allOf[1]

Type: object

Show Source

• serialNumber: string
  The serial number for the physical resource.

{
    "type":"object",
    "properties":{
        "serialNumber":{
            "type":"string",
            "description":"The serial number for the physical resource."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "portNumber":{
            "type":"integer",
            "description":"A non-zero integer that uniquely identifies this physical port instance from all other instances."
        },
        "vendorPortName":{
            "type":"string",
            "description":"The vendor-specific name for the port."
        },
        "customerPortName":{
            "type":"string",
            "description":"The customer-specific name for the port."
        },
        "physicalDeviceRef":{
            "$ref":"#/components/schemas/PhysicalDevice"
        },
        "equipmentRef":{
            "$ref":"#/components/schemas/Equipment"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of physical port inventory roles."
        }
    }
}

Nested Schema : schema

A physical device resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical device resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalAddress":{
                    "type":"string",
                    "description":"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."
                },
                "physicalLocation":{
                    "type":"string",
                    "description":"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)."
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the physical device instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical ports provided by the physical device instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of physical device inventory roles."
                }
            }
        }
    ]
}

Nested Schema : roles

Type: array

The list of physical port inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of physical port inventory roles."
}

Nested Schema : type

Type: object

Show Source

• networkLocation: object PlaceRef
  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.

{
    "type":"object",
    "properties":{
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalAddress":{
            "type":"string",
            "description":"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."
        },
        "physicalLocation":{
            "type":"string",
            "description":"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)."
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the physical device instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical ports provided by the physical device instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of physical device inventory roles."
}

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.

{
    "type":"object",
    "description":"Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.",
    "properties":{
        "action":{
            "type":"string",
            "description":"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":{
            "description":"Impacted Connectivity or Pipe after rehome or groom.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "serviceChangeEntity":{
            "description":"Impacted Service after rehome service.",
            "$ref":"#/components/schemas/Service"
        },
        "status":{
            "description":"Status of impacted item.",
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "parentChangeItem":{
            "type":"string",
            "description":"Parent activity item due to which this item got imapacted."
        }
    }
}

Nested Schema : changedEntity

Impacted Connectivity or Pipe after rehome or groom.

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.
• schema
  An equipment resource.

{
    "description":"Impacted Connectivity or Pipe after rehome or groom.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• 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 PlaceRef
  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.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
            "readOnly":true
        },
        "vendorName":{
            "type":"string",
            "description":"The name of the equipment manufacturer.",
            "readOnly":true
        },
        "modelNumber":{
            "type":"string",
            "description":"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.",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
            "readOnly":true
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the equipment instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the physical port instances provided by the equipment instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of equipment inventory roles."
        }
    }
}

Nested Schema : roles

Type: array

The list of equipment inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of equipment inventory roles."
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The replace card project was created successfully.

Body ()

Root Schema : schema

Type: object

ReplaceCard Project Class.

Show Source

• activity: object ReplaceCardActivity
  ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.
• description: string
  A free-text description for the project.
• href: string (uri)
  Read Only: true

  The URI for the ReplaceCardProject 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.

{
    "type":"object",
    "description":"ReplaceCard Project Class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project.",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "description":"The URI for the ReplaceCardProject class.",
            "format":"uri",
            "readOnly":true
        },
        "projectName":{
            "type":"string",
            "description":"The name of the project."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the project."
        },
        "status":{
            "$ref":"#/components/schemas/ProjectStateEnum",
            "readOnly":true
        },
        "activity":{
            "description":"Activity",
            "$ref":"#/components/schemas/ReplaceCardActivity"
        }
    }
}

Nested Schema : ReplaceCardActivity

Type: object

ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.

Show Source

• activityItems: array activityItems
• activityName: string
  The name of the activity.
• autoMap: boolean
  Auto maps the consumers of source card's physical ports to target card's physical ports in the same order.
• id: string
  The ID of the Activity.
• impactedItems: array impactedItems
• sourceCard: schema
  An equipment resource.
• 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.
• targetCard: schema
  An equipment resource.

{
    "type":"object",
    "description":"ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the Activity."
        },
        "activityName":{
            "type":"string",
            "description":"The name of the activity."
        },
        "autoMap":{
            "type":"boolean",
            "description":"Auto maps the consumers of source card's physical ports to target card's physical ports in the same order."
        },
        "sourceCard":{
            "description":"The source card which is replaced from it's parent equipment.",
            "$ref":"#/components/schemas/Equipment"
        },
        "targetCard":{
            "description":"The target card which is replacing the source card and is added in the parent Shelf equipment.",
            "$ref":"#/components/schemas/Equipment"
        },
        "status":{
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "activityItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReplaceCardActivityItem"
            }
        },
        "impactedItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImpactedItem"
            }
        }
    }
}

Nested Schema : activityItems

Type: array

Show Source

• Array of: object ReplaceCardActivityItem
  A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReplaceCardActivityItem"
    }
}

Nested Schema : impactedItems

Type: array

Show Source

• Array of: object ImpactedItem
  Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImpactedItem"
    }
}

Nested Schema : schema

An equipment resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"An equipment resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"string",
                    "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
                    "readOnly":true
                },
                "vendorName":{
                    "type":"string",
                    "description":"The name of the equipment manufacturer.",
                    "readOnly":true
                },
                "modelNumber":{
                    "type":"string",
                    "description":"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.",
                    "readOnly":true
                },
                "partNumber":{
                    "type":"string",
                    "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
                    "readOnly":true
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the equipment instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the physical port instances provided by the equipment instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of equipment inventory roles."
                }
            }
        }
    ]
}

Nested Schema : ReplaceCardActivityItem

Type: object

A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.

Show Source

• changedEntity: changedEntity
  The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.
• comments: string
  Comments related to failure of replace card activity items if any.
• serviceChangedEntity: object schema
  Service Class.
• source: source
  Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.
• 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 Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.

{
    "type":"object",
    "description":"A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.",
    "properties":{
        "changedEntity":{
            "description":"The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "serviceChangedEntity":{
            "description":"Service consumers of the port of the source card.",
            "$ref":"#/components/schemas/Service"
        },
        "source":{
            "description":"Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/PhysicalPort"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "target":{
            "description":"Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/PhysicalPort"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "status":{
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "comments":{
            "type":"string",
            "description":"Comments related to failure of replace card activity items if any."
        }
    }
}

Nested Schema : changedEntity

The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.
• schema
  An equipment resource.

{
    "description":"The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

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
  A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.
• 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).

{
    "type":"object",
    "description":"Service Class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service.",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "description":"The URI for the service class.",
            "readOnly":true
        },
        "businessInteraction":{
            "$ref":"#/components/schemas/BusinessInteractionRef",
            "description":"A related Business Interaction. A related business interaction linked to a specific entity."
        },
        "category":{
            "type":"string",
            "description":"Indicates if it is customer facing or resource facing service."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the service."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is no longer effective."
        },
        "hasStarted":{
            "type":"boolean",
            "description":"Flag indicates that service is started.",
            "readOnly":true
        },
        "isServiceEnabled":{
            "type":"boolean",
            "description":"If FALSE, this particular Service has NOT been enabled for use",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "serviceDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time when the service was created (whatever its status).",
            "readOnly":true
        },
        "supportingResource":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceServiceRef"
            },
            "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is started."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyServiceRef"
            },
            "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
        },
        "serviceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            },
            "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
        },
        "serviceRelationship":{
            "type":"array",
            "description":"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).",
            "items":{
                "$ref":"#/components/schemas/ServiceRelationship"
            }
        },
        "serviceType":{
            "type":"string",
            "description":"The business type of the service."
        },
        "supportingService":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Service"
            },
            "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
        },
        "serviceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "state":{
            "$ref":"#/components/schemas/ServiceStateEnum"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceServiceRef"
            },
            "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
        },
        "externalIdentity":{
            "$ref":"#/components/schemas/ExternalIdentity"
        },
        "serviceOrderItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedServiceOrderItem"
            },
            "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service changes goes to activate."
        }
    }
}

Nested Schema : source

Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.

Match One Schema

Show Source

• schema
  A physical port.
• schema
  An equipment resource.

{
    "description":"Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PhysicalPort"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : target

Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.

Match One Schema

Show Source

• schema
  A physical port.
• schema
  An equipment resource.

{
    "description":"Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PhysicalPort"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : schema

A pipe resource.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A pipe resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "totalConsumedCapacity":{
                    "type":"string",
                    "description":"The total consumed capacity."
                },
                "capacityProvidedRef":{
                    "$ref":"#/components/schemas/CapacityProvided"
                },
                "capacityRequiredRef":{
                    "$ref":"#/components/schemas/CapacityRequired"
                },
                "capacityConsumedRef":{
                    "$ref":"#/components/schemas/CapacityConsumed"
                },
                "allowSecondaryEnablement":{
                    "type":"boolean",
                    "description":"To allow SecondaryEnablement for a pipe or not."
                },
                "isVersioned":{
                    "type":"boolean",
                    "description":"To denote whether pipe is versioned or not."
                },
                "aendTerminationPoint":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for aterminationPoint of the pipe."
                },
                "zendTerminationPoint":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for zterminationPoint of the pipe."
                },
                "primaryPathEnabled":{
                    "$ref":"#/components/schemas/PipeEnablement"
                },
                "secondaryPathEnabled":{
                    "$ref":"#/components/schemas/PipeEnablement"
                },
                "transmissionSignalType":{
                    "type":"string",
                    "description":"The TransmissionSignalType of the pipe. Valid values are NONE, ELECTRICAL, ELECTROMAGNETIC, OPTICAL, UNKNOWN.",
                    "enum":[
                        "ELECTRICAL",
                        "ELECTROMAGNETIC",
                        "OPTICAL",
                        "UNKNOWN",
                        "NONE"
                    ]
                },
                "medium":{
                    "type":"string",
                    "description":"The Medium of the pipe. Valid values are NONE, WIRELESS, METALLIC, FIBER, SOFTWARE, UNKNOWN.",
                    "enum":[
                        "WIRELESS",
                        "METALLIC",
                        "FIBER",
                        "SOFTWARE",
                        "UNKNOWN",
                        "NONE"
                    ]
                },
                "gridType":{
                    "type":"string",
                    "description":"The GridType of the pipe. Valid values are NONE, FIXED, FLEX_GRID.",
                    "enum":[
                        "FIXED",
                        "FLEX_GRID",
                        "NONE"
                    ]
                },
                "channelSpacing":{
                    "type":"string",
                    "description":"The channelSpacing of pipe."
                },
                "pipeDirectionalityRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PipeDirectionality"
                    },
                    "description":"The list of pipe directionalities."
                },
                "parentPipeRef":{
                    "$ref":"#/components/schemas/Pipe"
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of pipe inventory roles."
                }
            }
        }
    ]
}

Nested Schema : schema

A Connectivity resource.

Match All

Show Source

• allOf schema
  A pipe resource.
• object type

{
    "description":"A Connectivity resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "type":"object",
            "properties":{
                "connectivityIdentifier":{
                    "type":"string",
                    "description":"A unique identifier of Connectivity."
                },
                "technology":{
                    "type":"string",
                    "description":"The technology that applies to connectivity."
                },
                "identificationFormat":{
                    "$ref":"#/components/schemas/ConnectivityIdentifierFormatEnum"
                },
                "ALocation":{
                    "$ref":"#/components/schemas/PlaceRef",
                    "description":"The network location code or network entity code for the A side of the connectivity."
                },
                "ZLocation":{
                    "$ref":"#/components/schemas/PlaceRef",
                    "description":"The network location code or network entity code for the Z side of the connectivity."
                },
                "rateCode":{
                    "type":"string",
                    "description":"The rate code that applies to connectivity."
                },
                "function":{
                    "type":"string",
                    "description":"The function that applies to connectivity. Functions apply only to connectivities that have rate codes that define them as facilities."
                },
                "serialNumber":{
                    "type":"integer",
                    "description":"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."
                },
                "quantity":{
                    "type":"integer",
                    "description":"The number of Connectivity entities to be created."
                },
                "isAssignContiguousSerialNumber":{
                    "type":"boolean",
                    "description":"Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block."
                },
                "consumablePercent":{
                    "type":"integer",
                    "description":"Percentage of capacity that can be consumed."
                },
                "bitRate":{
                    "type":"string",
                    "description":"The bit rate is based on the rate code applied to the connectivity."
                },
                "assignedToService":{
                    "type":"string",
                    "format":"uri",
                    "description":"The service (if any) to which the connectivity is assigned."
                },
                "isInternetwork":{
                    "type":"boolean",
                    "description":"If it is inter network or not."
                },
                "isInternetworkExternal":{
                    "type":"boolean",
                    "description":"If it is internetwork external or not."
                },
                "otherServiceProviderName":{
                    "type":"string",
                    "description":"Name of other service provider."
                },
                "otherProviderDemarcationPoint":{
                    "$ref":"#/components/schemas/AZLocationTypeEnum"
                },
                "isServiceMultiplexing":{
                    "type":"boolean",
                    "description":"If it is service multiplexing or not."
                },
                "isBundling":{
                    "type":"boolean",
                    "description":"If it is bundling or not."
                },
                "isAllToOneBundling":{
                    "type":"boolean",
                    "description":"If all to one bundling is applicable."
                },
                "isVlanBased":{
                    "type":"boolean",
                    "description":"If it is vlan based or not."
                },
                "maxPacketVirtualNetworkCount":{
                    "type":"integer",
                    "description":"count of maximum packet virtual network."
                },
                "committedInformationRateDisplay":{
                    "type":"string",
                    "description":"Information rate."
                },
                "maxInformationRateDisplay":{
                    "type":"string",
                    "description":"maximum information rate."
                },
                "connectivityDesign":{
                    "$ref":"#/components/schemas/ConnectivityDesign"
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

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" ]

  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" ]

  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.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "totalConsumedCapacity":{
            "type":"string",
            "description":"The total consumed capacity."
        },
        "capacityProvidedRef":{
            "$ref":"#/components/schemas/CapacityProvided"
        },
        "capacityRequiredRef":{
            "$ref":"#/components/schemas/CapacityRequired"
        },
        "capacityConsumedRef":{
            "$ref":"#/components/schemas/CapacityConsumed"
        },
        "allowSecondaryEnablement":{
            "type":"boolean",
            "description":"To allow SecondaryEnablement for a pipe or not."
        },
        "isVersioned":{
            "type":"boolean",
            "description":"To denote whether pipe is versioned or not."
        },
        "aendTerminationPoint":{
            "type":"string",
            "format":"uri",
            "description":"The URI for aterminationPoint of the pipe."
        },
        "zendTerminationPoint":{
            "type":"string",
            "format":"uri",
            "description":"The URI for zterminationPoint of the pipe."
        },
        "primaryPathEnabled":{
            "$ref":"#/components/schemas/PipeEnablement"
        },
        "secondaryPathEnabled":{
            "$ref":"#/components/schemas/PipeEnablement"
        },
        "transmissionSignalType":{
            "type":"string",
            "description":"The TransmissionSignalType of the pipe. Valid values are NONE, ELECTRICAL, ELECTROMAGNETIC, OPTICAL, UNKNOWN.",
            "enum":[
                "ELECTRICAL",
                "ELECTROMAGNETIC",
                "OPTICAL",
                "UNKNOWN",
                "NONE"
            ]
        },
        "medium":{
            "type":"string",
            "description":"The Medium of the pipe. Valid values are NONE, WIRELESS, METALLIC, FIBER, SOFTWARE, UNKNOWN.",
            "enum":[
                "WIRELESS",
                "METALLIC",
                "FIBER",
                "SOFTWARE",
                "UNKNOWN",
                "NONE"
            ]
        },
        "gridType":{
            "type":"string",
            "description":"The GridType of the pipe. Valid values are NONE, FIXED, FLEX_GRID.",
            "enum":[
                "FIXED",
                "FLEX_GRID",
                "NONE"
            ]
        },
        "channelSpacing":{
            "type":"string",
            "description":"The channelSpacing of pipe."
        },
        "pipeDirectionalityRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PipeDirectionality"
            },
            "description":"The list of pipe directionalities."
        },
        "parentPipeRef":{
            "$ref":"#/components/schemas/Pipe"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of pipe inventory roles."
        }
    }
}

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.

{
    "type":"object",
    "description":"Consumed capacity of pipe.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the CapacityConsumed."
        },
        "name":{
            "type":"string",
            "description":"The name of the CapacityConsumed."
        },
        "percentConsumed":{
            "type":"string",
            "description":"Consumed capacity percentage."
        },
        "capacityConsumed":{
            "type":"string",
            "description":"Capacity consumed."
        }
    }
}

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.

{
    "type":"object",
    "description":"A capacity provided.",
    "properties":{
        "capacityType":{
            "type":"string",
            "description":"Capacity type of capacity provided."
        },
        "totalAmount":{
            "type":"string",
            "description":"Total amount of capacity provided."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure valid are Gbps,Kbps,Mbps,bps."
        },
        "consumablePercentage":{
            "type":"string",
            "description":"Percentage of capacity that can be consumable."
        }
    }
}

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.

{
    "type":"object",
    "description":"Required capacity of pipe.",
    "properties":{
        "capacityType":{
            "type":"string",
            "description":"Capacity type of required capacity."
        },
        "requiredAmount":{
            "type":"string",
            "description":"Required amount of capacity."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure valid are Gbps,Kbps,Mbps,bps."
        },
        "quantity":{
            "type":"integer",
            "description":"Percentage of capacity that can be consumable."
        }
    }
}

Nested Schema : pipeDirectionalityRef

Type: array

The list of pipe directionalities.

Show Source

• Array of: object PipeDirectionality
  A Pipe Directionality .

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PipeDirectionality"
    },
    "description":"The list of pipe directionalities."
}

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.

{
    "type":"object",
    "description":"Segment details that are enabling current Connectivity.",
    "properties":{
        "originatingTerminationPoint":{
            "type":"string",
            "description":"The id of the originatingTerminationPoint."
        },
        "terminatingTerminationPoint":{
            "type":"string",
            "description":"The id of the terminatingTerminationPoint."
        },
        "pipeSegmentRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Segment"
            },
            "description":"The list of pipe segments."
        }
    }
}

Nested Schema : roles

Type: array

The list of pipe inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of pipe inventory roles."
}

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.

{
    "type":"object",
    "description":"A Pipe Directionality .",
    "properties":{
        "pipeDirection":{
            "type":"string",
            "description":"The direction of the pipe.",
            "enum":[
                "BI_DIRECTIONAL",
                "UNI_DIRECTIONAL",
                "UNKNOWN"
            ]
        },
        "directionalityType":{
            "type":"string",
            "description":"The directionalityType of the pipe.",
            "enum":[
                "ROUTING",
                "SIGNAL"
            ]
        },
        "terminationId1":{
            "type":"string",
            "description":"The ID of the termination1."
        },
        "terminationId2":{
            "type":"string",
            "description":"The ID of the termination2."
        },
        "terminationName1":{
            "type":"string",
            "description":"The name of the termination1."
        },
        "terminationName2":{
            "type":"string",
            "description":"The name of the termination2."
        },
        "terminationDirectType1":{
            "type":"string",
            "description":"The DirectType of the termination1. Valid values are SINK, SOURCE, UNKNOWN.",
            "enum":[
                "SINK",
                "SOURCE",
                "UNKNOWN"
            ]
        },
        "terminationDirectType2":{
            "type":"string",
            "description":"The DirectType of the termination2. Valid values are SINK, SOURCE, UNKNOWN.",
            "enum":[
                "SINK",
                "SOURCE",
                "UNKNOWN"
            ]
        }
    }
}

Nested Schema : pipeSegmentRef

Type: array

The list of pipe segments.

Show Source

• Array of: object Segment
  Segment details that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Segment"
    },
    "description":"The list of pipe segments."
}

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.

{
    "type":"object",
    "description":"Segment details that are enabling current Connectivity.",
    "properties":{
        "segmentNumber":{
            "type":"string",
            "description":"Segment number."
        },
        "asideTerminationPoint":{
            "type":"string",
            "description":"The id of Termination point."
        },
        "asideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "asidePhysicalPort":{
            "$ref":"#/components/schemas/LogicalResource"
        },
        "aendLocation":{
            "type":"string",
            "description":"A side Location."
        },
        "segmentRef":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                }
            ]
        },
        "flowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "isGap":{
            "type":"boolean",
            "description":"Identifies if it is a gap or not."
        },
        "interconnectionType":{
            "$ref":"#/components/schemas/InterConnectionTypeEnum"
        },
        "zsideTerminationPoint":{
            "type":"string",
            "description":"The id of Termination point."
        },
        "zsideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "zendLocation":{
            "type":"string",
            "description":"Z side Location."
        },
        "zsidePhysicalPort":{
            "$ref":"#/components/schemas/LogicalResource"
        },
        "gapAccepted":{
            "type":"boolean",
            "description":"Use this attribute to accept gap. Default Reason for accepting gap is auto-generated as \"GAP OK\""
        },
        "lifeCycleBinding":{
            "$ref":"#/components/schemas/InterConnectionLifeCycleBindingEnum"
        }
    }
}

Nested Schema : flowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : segmentRef

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        }
    ]
}

Nested Schema : schema

A flow identifier.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A flow identifier.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "identifier":{
                    "type":"integer",
                    "description":"The ID of the flow identifier."
                },
                "identifierPrefix":{
                    "type":"string",
                    "description":"Prefix for the Identifier."
                },
                "domain":{
                    "$ref":"#/components/schemas/NetworkAddressDomain"
                },
                "stackingLevel":{
                    "type":"integer",
                    "description":"The stacking level of the flow identifier."
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• domain: schema
  A network address domain.
• identifier: integer
  The ID of the flow identifier.
• identifierPrefix: string
  Prefix for the Identifier.
• stackingLevel: integer
  The stacking level of the flow identifier.

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"integer",
            "description":"The ID of the flow identifier."
        },
        "identifierPrefix":{
            "type":"string",
            "description":"Prefix for the Identifier."
        },
        "domain":{
            "$ref":"#/components/schemas/NetworkAddressDomain"
        },
        "stackingLevel":{
            "type":"integer",
            "description":"The stacking level of the flow identifier."
        }
    }
}

Nested Schema : schema

A network address domain.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A network address domain.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The name of the network address domain. It also indicates the ID of the domain."
                },
                "networkAddressType":{
                    "type":"string",
                    "description":"The type of network address, either IP Subnet or flow identifier."
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the network address domain. It also indicates the ID of the domain."
        },
        "networkAddressType":{
            "type":"string",
            "description":"The type of network address, either IP Subnet or flow identifier."
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

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.

{
    "type":"object",
    "description":"A related party, which defines a party or party role linked to a specific entity.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the related party."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the related party."
        },
        "name":{
            "type":"string",
            "description":"The name of the related party."
        },
        "role":{
            "type":"string",
            "description":"The role of the related party."
        },
        "@referredType":{
            "type":"string",
            "description":"Concrete Type of the Party, in case of dis-ambiguity. Default  is '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.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

Nested Schema : type

Type: object

Show Source

• ALocation: object PlaceRef
  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.
• committedInformationRateDisplay: string
  Information rate.
• 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.
• identificationFormat: string
  Allowed Values: [ "LOCATION_BASED", "SERVICE_BASED", "CUSTOM_IDENTIFICATION" ]

  The list of valid values for Connectivity identifier format.
• isAllToOneBundling: boolean
  If all to one bundling is applicable.
• isAssignContiguousSerialNumber: boolean
  Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block.
• isBundling: boolean
  If it is bundling or not.
• isInternetwork: boolean
  If it is inter network or not.
• isInternetworkExternal: boolean
  If it is internetwork external or not.
• isServiceMultiplexing: boolean
  If it is service multiplexing or not.
• isVlanBased: boolean
  If it is vlan based or not.
• maxInformationRateDisplay: string
  maximum information rate.
• maxPacketVirtualNetworkCount: integer
  count of maximum packet virtual network.
• otherProviderDemarcationPoint: string
  Allowed Values: [ "A_LOCATION", "Z_LOCATION" ]

  The list of valid values for AZLocationType.
• otherServiceProviderName: string
  Name of other service provider.
• 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 PlaceRef
  A place to associate with the resource/service.

{
    "type":"object",
    "properties":{
        "connectivityIdentifier":{
            "type":"string",
            "description":"A unique identifier of Connectivity."
        },
        "technology":{
            "type":"string",
            "description":"The technology that applies to connectivity."
        },
        "identificationFormat":{
            "$ref":"#/components/schemas/ConnectivityIdentifierFormatEnum"
        },
        "ALocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the A side of the connectivity."
        },
        "ZLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the Z side of the connectivity."
        },
        "rateCode":{
            "type":"string",
            "description":"The rate code that applies to connectivity."
        },
        "function":{
            "type":"string",
            "description":"The function that applies to connectivity. Functions apply only to connectivities that have rate codes that define them as facilities."
        },
        "serialNumber":{
            "type":"integer",
            "description":"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."
        },
        "quantity":{
            "type":"integer",
            "description":"The number of Connectivity entities to be created."
        },
        "isAssignContiguousSerialNumber":{
            "type":"boolean",
            "description":"Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block."
        },
        "consumablePercent":{
            "type":"integer",
            "description":"Percentage of capacity that can be consumed."
        },
        "bitRate":{
            "type":"string",
            "description":"The bit rate is based on the rate code applied to the connectivity."
        },
        "assignedToService":{
            "type":"string",
            "format":"uri",
            "description":"The service (if any) to which the connectivity is assigned."
        },
        "isInternetwork":{
            "type":"boolean",
            "description":"If it is inter network or not."
        },
        "isInternetworkExternal":{
            "type":"boolean",
            "description":"If it is internetwork external or not."
        },
        "otherServiceProviderName":{
            "type":"string",
            "description":"Name of other service provider."
        },
        "otherProviderDemarcationPoint":{
            "$ref":"#/components/schemas/AZLocationTypeEnum"
        },
        "isServiceMultiplexing":{
            "type":"boolean",
            "description":"If it is service multiplexing or not."
        },
        "isBundling":{
            "type":"boolean",
            "description":"If it is bundling or not."
        },
        "isAllToOneBundling":{
            "type":"boolean",
            "description":"If all to one bundling is applicable."
        },
        "isVlanBased":{
            "type":"boolean",
            "description":"If it is vlan based or not."
        },
        "maxPacketVirtualNetworkCount":{
            "type":"integer",
            "description":"count of maximum packet virtual network."
        },
        "committedInformationRateDisplay":{
            "type":"string",
            "description":"Information rate."
        },
        "maxInformationRateDisplay":{
            "type":"string",
            "description":"maximum information rate."
        },
        "connectivityDesign":{
            "$ref":"#/components/schemas/ConnectivityDesign"
        }
    }
}

Nested Schema : PlaceRef

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.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : ConnectivityDesign

Type: object

Gives the details of latest connectivity design version.

Show Source

• aendLocation: object PlaceRef
  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.
• terminateAtFlowInterface: boolean
  This should be true if end point needs to be terminated at Flow Interface.
• zendLocation: object PlaceRef
  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.

{
    "type":"object",
    "description":"Gives the details of latest connectivity design version.",
    "properties":{
        "connectivityDesignVersion":{
            "type":"integer",
            "description":"The version number of connectivity design."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the connectivity design becomes effective."
        },
        "status":{
            "$ref":"#/components/schemas/ConfigurationStateEnum",
            "description":"The configuration status of latest connectivity design version."
        },
        "asideTerminationPointId":{
            "type":"string",
            "description":"The id of Termination point on A side."
        },
        "zsideTerminationPointId":{
            "type":"string",
            "description":"The id of Termination point on Z side."
        },
        "aendLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the A side of the connectivity."
        },
        "zendLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the Z side of the connectivity."
        },
        "asideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "zsideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for Z side interface of the connectivity."
        },
        "asideFlowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "zsideFlowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "terminateAtFlowInterface":{
            "type":"boolean",
            "description":"This should be true if end point needs to be terminated at Flow Interface."
        },
        "paths":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectivityPath"
            }
        }
    }
}

Nested Schema : asideFlowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : paths

Type: array

Show Source

• Array of: object ConnectivityPath
  Paths that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ConnectivityPath"
    }
}

Nested Schema : zsideFlowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : ConnectivityPath

Type: object

Paths that are enabling current Connectivity.

Show Source

• label: string
  Path label like Path1, Path2.
• segments: array segments

{
    "type":"object",
    "description":"Paths that are enabling current Connectivity.",
    "properties":{
        "label":{
            "type":"string",
            "description":"Path label like Path1, Path2."
        },
        "segments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Segment"
            }
        }
    }
}

Nested Schema : segments

Type: array

Show Source

• Array of: object Segment
  Segment details that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Segment"
    }
}

Nested Schema : BusinessInteractionRef

Type: object

Show Source

• id: string
  The id of Business Interaction
• state: string
  The state of Business Interaction

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of Business Interaction"
        },
        "state":{
            "type":"string",
            "description":"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.

{
    "type":"object",
    "description":"An external identity.",
    "properties":{
        "externalObjectId":{
            "type":"string",
            "description":"The ID for a business entity."
        },
        "externalName":{
            "type":"string",
            "description":"The business-meaningful name of the business entity."
        },
        "externalManagementDomain":{
            "type":"string",
            "description":"The external system, domain name, party, or participant in a federation solution."
        },
        "externalArrangement":{
            "type":"string",
            "description":"The type of federation model between UIM and the external party for the given entity.",
            "enum":[
                "LEASED_IN",
                "FEDERATED",
                "LEASED_OUT",
                "SHARED"
            ]
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaceServiceRef"
    },
    "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
}

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

• Array of: RelatedPartyServiceRef
  The party reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyServiceRef"
    },
    "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
}

Nested Schema : serviceCharacteristic

Type: array

A list of characteristics that characterize this service (ServiceCharacteristic [*])

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceCharacteristic"
    },
    "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedServiceOrderItem"
    },
    "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
}

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).

{
    "type":"array",
    "description":"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).",
    "items":{
        "$ref":"#/components/schemas/ServiceRelationship"
    }
}

Nested Schema : Specification

Type: object

A specification.

Show Source

• description: string
  Details about the specification.
• endDate: string (date-time)
  The date and time when the specification ends.
• entityType: string
  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.
• 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.
• startDate: string (date-time)
  The date and time when the specification starts.
• version: string
  The version of the specification, which is always 1.

{
    "type":"object",
    "description":"A specification.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the specification, which is the same as the name of the specification."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the specification."
        },
        "name":{
            "type":"string",
            "description":"The name of the specification."
        },
        "description":{
            "type":"string",
            "description":"Details about the specification."
        },
        "version":{
            "type":"string",
            "description":"The version of the specification, which is always <b>1</b>."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification starts."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification ends."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceServiceRef"
    },
    "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Service"
    },
    "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
}

Nested Schema : PlaceServiceRef

The place reference on a service.

Match All

Show Source

• object PlaceRef
  A place to associate with the resource/service.
• object PlaceServiceRef-allOf[1]

{
    "description":"The place reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PlaceRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "resourceName":{
                    "type":"string",
                    "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "latitude":{
                    "type":"string",
                    "description":"Latitude of the place."
                },
                "longitude":{
                    "type":"string",
                    "description":"Longitude of the place."
                },
                "placeSpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "placeCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the place."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the place."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the place."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the place which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : PlaceServiceRef-allOf[1]

Type: object

Show Source

• 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'.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "resourceName":{
            "type":"string",
            "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "latitude":{
            "type":"string",
            "description":"Latitude of the place."
        },
        "longitude":{
            "type":"string",
            "description":"Longitude of the place."
        },
        "placeSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "placeCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the place."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the place."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the place."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the place which is editable from UI."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the place."
}

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.
• 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.

{
    "type":"object",
    "description":"A characteristic of an object or entity represented by a name-value pair.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the characteristic."
        },
        "valueType":{
            "type":"string",
            "description":"The data type for the characteristics's value.",
            "enum":[
                "ALPHANUMERIC",
                "NUMERIC",
                "BOOLEAN",
                "DATE",
                "OBJECT",
                "URL"
            ]
        },
        "value":{
            "type":"object",
            "description":"The value of the characteristic."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI for the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the <b>valueType</b> is an object."
        }
    }
}

Nested Schema : value

Type: object

The value of the characteristic.

Nested Schema : RelatedPartyServiceRef

The party reference on a service.

Match All

Show Source

• object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• object RelatedPartyServiceRef-allOf[1]

{
    "description":"The party reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "partySpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "partyCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the party."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the party."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the party."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the party which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : RelatedPartyServiceRef-allOf[1]

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "partySpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "partyCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the party."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the party."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the party."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the party which is editable from UI."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the party."
}

Nested Schema : ServiceCharacteristic

The service characteristic details.

Match All

Show Source

• object Characteristic
  A characteristic of an object or entity represented by a name-value pair.
• object ServiceCharacteristic-allOf[1]

{
    "description":"The service characteristic details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Characteristic"
        },
        {
            "type":"object",
            "properties":{
                "serviceName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "serviceSpecName":{
                    "type":"string",
                    "description":"The specification name of service.Required only for creation of the service."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the service characteristic."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the service characteristic."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the service characteristic which is editable from UI."
                },
                "configItemPath":{
                    "type":"string",
                    "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
                }
            }
        }
    ]
}

Nested Schema : ServiceCharacteristic-allOf[1]

Type: object

Show Source

• 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.
• serviceName: string
  The name of the service consumer.
• serviceSpecName: string
  The specification name of service.Required only for creation of the service.

{
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "serviceSpecName":{
            "type":"string",
            "description":"The specification name of service.Required only for creation of the service."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the service characteristic."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the service characteristic."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the service characteristic which is editable from UI."
        },
        "configItemPath":{
            "type":"string",
            "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
        }
    }
}

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.

{
    "type":"object",
    "required":[
        "itemId, serviceOrderId"
    ],
    "description":"The service order item which triggered service creation/change/termination.",
    "properties":{
        "itemAction":{
            "$ref":"#/components/schemas/OrderItemActionEnum"
        },
        "itemId":{
            "type":"string",
            "description":"Identifier of the order item where the service was managed."
        },
        "role":{
            "type":"string",
            "description":"Role of the service order item for this service."
        },
        "serviceOrderHref":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "serviceOrderId":{
            "type":"string",
            "description":"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

{
    "required":[
        "relationshipType",
        "service"
    ],
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"The type of relationship (e.g. depends on, enables)"
        },
        "service":{
            "$ref":"#/components/schemas/Service"
        },
        "serviceRelationshipCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            }
        }
    },
    "description":"Describes links with services of the same category (useful for bundled services)."
}

Nested Schema : serviceRelationshipCharacteristic

Type: array

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceCharacteristic"
    }
}

Nested Schema : ResourceServiceRef

The resource reference on a service.

Match All

Show Source

• object ResourceRef
• object ResourceServiceRef-allOf[1]

{
    "description":"The resource reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceRef"
        },
        {
            "type":"object",
            "properties":{
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "expandResource":{
                    "$ref":"#/components/schemas/ResourceBase"
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the resource."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the resource."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the resource which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : ResourceRef

Type: object

Show Source

• @referredType: string
  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.
• 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.

{
    "type":"object",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the supporting resource."
        },
        "href":{
            "type":"string",
            "description":"Reference of the supporting resource.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the resource supporting the service."
        },
        "@referredType":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        }
    }
}

Nested Schema : ResourceServiceRef-allOf[1]

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "expandResource":{
            "$ref":"#/components/schemas/ResourceBase"
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the resource."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the resource."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the resource which is editable from UI."
        }
    }
}

Nested Schema : schema

A physical port.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical port.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "portNumber":{
                    "type":"integer",
                    "description":"A non-zero integer that uniquely identifies this physical port instance from all other instances."
                },
                "vendorPortName":{
                    "type":"string",
                    "description":"The vendor-specific name for the port."
                },
                "customerPortName":{
                    "type":"string",
                    "description":"The customer-specific name for the port."
                },
                "physicalDeviceRef":{
                    "$ref":"#/components/schemas/PhysicalDevice"
                },
                "equipmentRef":{
                    "$ref":"#/components/schemas/Equipment"
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of physical port inventory roles."
                }
            }
        }
    ]
}

Nested Schema : PhysicalResource

Type: object

The base class for physical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object PhysicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for physical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object",
            "properties":{
                "serialNumber":{
                    "type":"string",
                    "description":"The serial number for the physical resource."
                }
            }
        }
    ]
}

Nested Schema : PhysicalResource-allOf[1]

Type: object

Show Source

• serialNumber: string
  The serial number for the physical resource.

{
    "type":"object",
    "properties":{
        "serialNumber":{
            "type":"string",
            "description":"The serial number for the physical resource."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "portNumber":{
            "type":"integer",
            "description":"A non-zero integer that uniquely identifies this physical port instance from all other instances."
        },
        "vendorPortName":{
            "type":"string",
            "description":"The vendor-specific name for the port."
        },
        "customerPortName":{
            "type":"string",
            "description":"The customer-specific name for the port."
        },
        "physicalDeviceRef":{
            "$ref":"#/components/schemas/PhysicalDevice"
        },
        "equipmentRef":{
            "$ref":"#/components/schemas/Equipment"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of physical port inventory roles."
        }
    }
}

Nested Schema : schema

A physical device resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical device resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalAddress":{
                    "type":"string",
                    "description":"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."
                },
                "physicalLocation":{
                    "type":"string",
                    "description":"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)."
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the physical device instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical ports provided by the physical device instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of physical device inventory roles."
                }
            }
        }
    ]
}

Nested Schema : roles

Type: array

The list of physical port inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of physical port inventory roles."
}

Nested Schema : type

Type: object

Show Source

• networkLocation: object PlaceRef
  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.

{
    "type":"object",
    "properties":{
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalAddress":{
            "type":"string",
            "description":"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."
        },
        "physicalLocation":{
            "type":"string",
            "description":"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)."
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the physical device instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical ports provided by the physical device instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of physical device inventory roles."
}

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.

{
    "type":"object",
    "description":"Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.",
    "properties":{
        "action":{
            "type":"string",
            "description":"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":{
            "description":"Impacted Connectivity or Pipe after rehome or groom.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "serviceChangeEntity":{
            "description":"Impacted Service after rehome service.",
            "$ref":"#/components/schemas/Service"
        },
        "status":{
            "description":"Status of impacted item.",
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "parentChangeItem":{
            "type":"string",
            "description":"Parent activity item due to which this item got imapacted."
        }
    }
}

Nested Schema : changedEntity

Impacted Connectivity or Pipe after rehome or groom.

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.
• schema
  An equipment resource.

{
    "description":"Impacted Connectivity or Pipe after rehome or groom.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• 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 PlaceRef
  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.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
            "readOnly":true
        },
        "vendorName":{
            "type":"string",
            "description":"The name of the equipment manufacturer.",
            "readOnly":true
        },
        "modelNumber":{
            "type":"string",
            "description":"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.",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
            "readOnly":true
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the equipment instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the physical port instances provided by the equipment instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of equipment inventory roles."
        }
    }
}

Nested Schema : roles

Type: array

The list of equipment inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of equipment inventory roles."
}

202 Response

The replace card project was created successfully and is auto submitted. Activity will be processed asynchronously.

Body ()

Root Schema : schema

Type: object

ReplaceCard Project Class.

Show Source

• activity: object ReplaceCardActivity
  ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.
• description: string
  A free-text description for the project.
• href: string (uri)
  Read Only: true

  The URI for the ReplaceCardProject 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.

{
    "type":"object",
    "description":"ReplaceCard Project Class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project.",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "description":"The URI for the ReplaceCardProject class.",
            "format":"uri",
            "readOnly":true
        },
        "projectName":{
            "type":"string",
            "description":"The name of the project."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the project."
        },
        "status":{
            "$ref":"#/components/schemas/ProjectStateEnum",
            "readOnly":true
        },
        "activity":{
            "description":"Activity",
            "$ref":"#/components/schemas/ReplaceCardActivity"
        }
    }
}

Nested Schema : ReplaceCardActivity

Type: object

ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.

Show Source

• activityItems: array activityItems
• activityName: string
  The name of the activity.
• autoMap: boolean
  Auto maps the consumers of source card's physical ports to target card's physical ports in the same order.
• id: string
  The ID of the Activity.
• impactedItems: array impactedItems
• sourceCard: schema
  An equipment resource.
• 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.
• targetCard: schema
  An equipment resource.

{
    "type":"object",
    "description":"ReplaceCard Activity is used to replace an card equipment with other card equipment along with its consumers including Pipe, Connectivity and Service.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the Activity."
        },
        "activityName":{
            "type":"string",
            "description":"The name of the activity."
        },
        "autoMap":{
            "type":"boolean",
            "description":"Auto maps the consumers of source card's physical ports to target card's physical ports in the same order."
        },
        "sourceCard":{
            "description":"The source card which is replaced from it's parent equipment.",
            "$ref":"#/components/schemas/Equipment"
        },
        "targetCard":{
            "description":"The target card which is replacing the source card and is added in the parent Shelf equipment.",
            "$ref":"#/components/schemas/Equipment"
        },
        "status":{
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "activityItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReplaceCardActivityItem"
            }
        },
        "impactedItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImpactedItem"
            }
        }
    }
}

Nested Schema : activityItems

Type: array

Show Source

• Array of: object ReplaceCardActivityItem
  A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReplaceCardActivityItem"
    }
}

Nested Schema : impactedItems

Type: array

Show Source

• Array of: object ImpactedItem
  Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ImpactedItem"
    }
}

Nested Schema : schema

An equipment resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"An equipment resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "category":{
                    "type":"string",
                    "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
                    "readOnly":true
                },
                "vendorName":{
                    "type":"string",
                    "description":"The name of the equipment manufacturer.",
                    "readOnly":true
                },
                "modelNumber":{
                    "type":"string",
                    "description":"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.",
                    "readOnly":true
                },
                "partNumber":{
                    "type":"string",
                    "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
                    "readOnly":true
                },
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the equipment instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the physical port instances provided by the equipment instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of equipment inventory roles."
                }
            }
        }
    ]
}

Nested Schema : ReplaceCardActivityItem

Type: object

A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.

Show Source

• changedEntity: changedEntity
  The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.
• comments: string
  Comments related to failure of replace card activity items if any.
• serviceChangedEntity: object schema
  Service Class.
• source: source
  Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.
• 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 Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.

{
    "type":"object",
    "description":"A replace card activity item captures details of Equipment being replaced and the port consumers(Connectivity/Pipe/Service) being rehomed.",
    "properties":{
        "changedEntity":{
            "description":"The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "serviceChangedEntity":{
            "description":"Service consumers of the port of the source card.",
            "$ref":"#/components/schemas/Service"
        },
        "source":{
            "description":"Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/PhysicalPort"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "target":{
            "description":"Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/PhysicalPort"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "status":{
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "comments":{
            "type":"string",
            "description":"Comments related to failure of replace card activity items if any."
        }
    }
}

Nested Schema : changedEntity

The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.
• schema
  An equipment resource.

{
    "description":"The Shelf where the source card is being replaced. Connectivity/Pipe consumers of the port of the source card.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

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
  A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity.
• 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).

{
    "type":"object",
    "description":"Service Class.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the service.",
            "readOnly":true
        },
        "href":{
            "type":"string",
            "description":"The URI for the service class.",
            "readOnly":true
        },
        "businessInteraction":{
            "$ref":"#/components/schemas/BusinessInteractionRef",
            "description":"A related Business Interaction. A related business interaction linked to a specific entity."
        },
        "category":{
            "type":"string",
            "description":"Indicates if it is customer facing or resource facing service."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the service."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is no longer effective."
        },
        "hasStarted":{
            "type":"boolean",
            "description":"Flag indicates that service is started.",
            "readOnly":true
        },
        "isServiceEnabled":{
            "type":"boolean",
            "description":"If FALSE, this particular Service has NOT been enabled for use",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "serviceDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time when the service was created (whatever its status).",
            "readOnly":true
        },
        "supportingResource":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceServiceRef"
            },
            "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service is started."
        },
        "relatedParty":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedPartyServiceRef"
            },
            "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
        },
        "serviceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            },
            "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
        },
        "serviceRelationship":{
            "type":"array",
            "description":"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).",
            "items":{
                "$ref":"#/components/schemas/ServiceRelationship"
            }
        },
        "serviceType":{
            "type":"string",
            "description":"The business type of the service."
        },
        "supportingService":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Service"
            },
            "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
        },
        "serviceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "state":{
            "$ref":"#/components/schemas/ServiceStateEnum"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceServiceRef"
            },
            "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
        },
        "externalIdentity":{
            "$ref":"#/components/schemas/ExternalIdentity"
        },
        "serviceOrderItem":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RelatedServiceOrderItem"
            },
            "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the service changes goes to activate."
        }
    }
}

Nested Schema : source

Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.

Match One Schema

Show Source

• schema
  A physical port.
• schema
  An equipment resource.

{
    "description":"Source Port on which connectivity or pipe or service are currently terminated. Source Card which is being replaced from the Shelf.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PhysicalPort"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : target

Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.

Match One Schema

Show Source

• schema
  A physical port.
• schema
  An equipment resource.

{
    "description":"Target Port on which connectivity or pipe or service has to be rehomed. Target Card which is replacing the source card.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/PhysicalPort"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : schema

A pipe resource.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A pipe resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "totalConsumedCapacity":{
                    "type":"string",
                    "description":"The total consumed capacity."
                },
                "capacityProvidedRef":{
                    "$ref":"#/components/schemas/CapacityProvided"
                },
                "capacityRequiredRef":{
                    "$ref":"#/components/schemas/CapacityRequired"
                },
                "capacityConsumedRef":{
                    "$ref":"#/components/schemas/CapacityConsumed"
                },
                "allowSecondaryEnablement":{
                    "type":"boolean",
                    "description":"To allow SecondaryEnablement for a pipe or not."
                },
                "isVersioned":{
                    "type":"boolean",
                    "description":"To denote whether pipe is versioned or not."
                },
                "aendTerminationPoint":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for aterminationPoint of the pipe."
                },
                "zendTerminationPoint":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for zterminationPoint of the pipe."
                },
                "primaryPathEnabled":{
                    "$ref":"#/components/schemas/PipeEnablement"
                },
                "secondaryPathEnabled":{
                    "$ref":"#/components/schemas/PipeEnablement"
                },
                "transmissionSignalType":{
                    "type":"string",
                    "description":"The TransmissionSignalType of the pipe. Valid values are NONE, ELECTRICAL, ELECTROMAGNETIC, OPTICAL, UNKNOWN.",
                    "enum":[
                        "ELECTRICAL",
                        "ELECTROMAGNETIC",
                        "OPTICAL",
                        "UNKNOWN",
                        "NONE"
                    ]
                },
                "medium":{
                    "type":"string",
                    "description":"The Medium of the pipe. Valid values are NONE, WIRELESS, METALLIC, FIBER, SOFTWARE, UNKNOWN.",
                    "enum":[
                        "WIRELESS",
                        "METALLIC",
                        "FIBER",
                        "SOFTWARE",
                        "UNKNOWN",
                        "NONE"
                    ]
                },
                "gridType":{
                    "type":"string",
                    "description":"The GridType of the pipe. Valid values are NONE, FIXED, FLEX_GRID.",
                    "enum":[
                        "FIXED",
                        "FLEX_GRID",
                        "NONE"
                    ]
                },
                "channelSpacing":{
                    "type":"string",
                    "description":"The channelSpacing of pipe."
                },
                "pipeDirectionalityRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/PipeDirectionality"
                    },
                    "description":"The list of pipe directionalities."
                },
                "parentPipeRef":{
                    "$ref":"#/components/schemas/Pipe"
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of pipe inventory roles."
                }
            }
        }
    ]
}

Nested Schema : schema

A Connectivity resource.

Match All

Show Source

• allOf schema
  A pipe resource.
• object type

{
    "description":"A Connectivity resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "type":"object",
            "properties":{
                "connectivityIdentifier":{
                    "type":"string",
                    "description":"A unique identifier of Connectivity."
                },
                "technology":{
                    "type":"string",
                    "description":"The technology that applies to connectivity."
                },
                "identificationFormat":{
                    "$ref":"#/components/schemas/ConnectivityIdentifierFormatEnum"
                },
                "ALocation":{
                    "$ref":"#/components/schemas/PlaceRef",
                    "description":"The network location code or network entity code for the A side of the connectivity."
                },
                "ZLocation":{
                    "$ref":"#/components/schemas/PlaceRef",
                    "description":"The network location code or network entity code for the Z side of the connectivity."
                },
                "rateCode":{
                    "type":"string",
                    "description":"The rate code that applies to connectivity."
                },
                "function":{
                    "type":"string",
                    "description":"The function that applies to connectivity. Functions apply only to connectivities that have rate codes that define them as facilities."
                },
                "serialNumber":{
                    "type":"integer",
                    "description":"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."
                },
                "quantity":{
                    "type":"integer",
                    "description":"The number of Connectivity entities to be created."
                },
                "isAssignContiguousSerialNumber":{
                    "type":"boolean",
                    "description":"Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block."
                },
                "consumablePercent":{
                    "type":"integer",
                    "description":"Percentage of capacity that can be consumed."
                },
                "bitRate":{
                    "type":"string",
                    "description":"The bit rate is based on the rate code applied to the connectivity."
                },
                "assignedToService":{
                    "type":"string",
                    "format":"uri",
                    "description":"The service (if any) to which the connectivity is assigned."
                },
                "isInternetwork":{
                    "type":"boolean",
                    "description":"If it is inter network or not."
                },
                "isInternetworkExternal":{
                    "type":"boolean",
                    "description":"If it is internetwork external or not."
                },
                "otherServiceProviderName":{
                    "type":"string",
                    "description":"Name of other service provider."
                },
                "otherProviderDemarcationPoint":{
                    "$ref":"#/components/schemas/AZLocationTypeEnum"
                },
                "isServiceMultiplexing":{
                    "type":"boolean",
                    "description":"If it is service multiplexing or not."
                },
                "isBundling":{
                    "type":"boolean",
                    "description":"If it is bundling or not."
                },
                "isAllToOneBundling":{
                    "type":"boolean",
                    "description":"If all to one bundling is applicable."
                },
                "isVlanBased":{
                    "type":"boolean",
                    "description":"If it is vlan based or not."
                },
                "maxPacketVirtualNetworkCount":{
                    "type":"integer",
                    "description":"count of maximum packet virtual network."
                },
                "committedInformationRateDisplay":{
                    "type":"string",
                    "description":"Information rate."
                },
                "maxInformationRateDisplay":{
                    "type":"string",
                    "description":"maximum information rate."
                },
                "connectivityDesign":{
                    "$ref":"#/components/schemas/ConnectivityDesign"
                }
            }
        }
    ]
}

Nested Schema : LogicalResource

Type: object

The base class for logical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object LogicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for logical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : Discriminator: @type

Type: object

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

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" ]

  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" ]

  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.

{
    "type":"object",
    "description":"A base resource Class.",
    "discriminator":{
        "propertyName":"@type"
    },
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the resource."
        },
        "href":{
            "type":"string",
            "description":"The URI for the resource class.",
            "format":"uri",
            "readOnly":true
        },
        "@type":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        },
        "@baseType":{
            "$ref":"#/components/schemas/ResourceBaseTypeEnum"
        },
        "name":{
            "type":"string",
            "description":"The name of the resource."
        },
        "description":{
            "type":"string",
            "description":"A free-text description for the resource."
        },
        "resourceVersion":{
            "type":"string",
            "description":"A field that identifies the version of a resource instance.",
            "readOnly":true
        },
        "lifecycleState":{
            "$ref":"#/components/schemas/InventoryStateEnum"
        },
        "lifecycleSubState":{
            "$ref":"#/components/schemas/AssignmentStateEnum",
            "readOnly":true
        },
        "resourceStatus":{
            "$ref":"#/components/schemas/ResourceStatusType",
            "readOnly":true
        },
        "category":{
            "type":"string",
            "description":"The category of the concrete resource, such as Gold or Silver for a MSISDN concrete resource."
        },
        "startOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the resource becomes effective.",
            "readOnly":true
        },
        "endOperatingDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the resource is no longer effective."
        },
        "resourceRelationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRelationship"
            },
            "description":"The list of all resources referenced with the current resource. For example, parent resource, associated resource, etc."
        },
        "resourceCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the resource."
        },
        "resourceSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "place":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaceRef"
            },
            "description":"The list of associated geographic places."
        },
        "externalIdentity":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExternalIdentity"
                }
            ],
            "description":"The external identity details for the federated resource.",
            "readOnly":true
        }
    }
}

Nested Schema : LogicalResource-allOf[1]

Type: object

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "totalConsumedCapacity":{
            "type":"string",
            "description":"The total consumed capacity."
        },
        "capacityProvidedRef":{
            "$ref":"#/components/schemas/CapacityProvided"
        },
        "capacityRequiredRef":{
            "$ref":"#/components/schemas/CapacityRequired"
        },
        "capacityConsumedRef":{
            "$ref":"#/components/schemas/CapacityConsumed"
        },
        "allowSecondaryEnablement":{
            "type":"boolean",
            "description":"To allow SecondaryEnablement for a pipe or not."
        },
        "isVersioned":{
            "type":"boolean",
            "description":"To denote whether pipe is versioned or not."
        },
        "aendTerminationPoint":{
            "type":"string",
            "format":"uri",
            "description":"The URI for aterminationPoint of the pipe."
        },
        "zendTerminationPoint":{
            "type":"string",
            "format":"uri",
            "description":"The URI for zterminationPoint of the pipe."
        },
        "primaryPathEnabled":{
            "$ref":"#/components/schemas/PipeEnablement"
        },
        "secondaryPathEnabled":{
            "$ref":"#/components/schemas/PipeEnablement"
        },
        "transmissionSignalType":{
            "type":"string",
            "description":"The TransmissionSignalType of the pipe. Valid values are NONE, ELECTRICAL, ELECTROMAGNETIC, OPTICAL, UNKNOWN.",
            "enum":[
                "ELECTRICAL",
                "ELECTROMAGNETIC",
                "OPTICAL",
                "UNKNOWN",
                "NONE"
            ]
        },
        "medium":{
            "type":"string",
            "description":"The Medium of the pipe. Valid values are NONE, WIRELESS, METALLIC, FIBER, SOFTWARE, UNKNOWN.",
            "enum":[
                "WIRELESS",
                "METALLIC",
                "FIBER",
                "SOFTWARE",
                "UNKNOWN",
                "NONE"
            ]
        },
        "gridType":{
            "type":"string",
            "description":"The GridType of the pipe. Valid values are NONE, FIXED, FLEX_GRID.",
            "enum":[
                "FIXED",
                "FLEX_GRID",
                "NONE"
            ]
        },
        "channelSpacing":{
            "type":"string",
            "description":"The channelSpacing of pipe."
        },
        "pipeDirectionalityRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PipeDirectionality"
            },
            "description":"The list of pipe directionalities."
        },
        "parentPipeRef":{
            "$ref":"#/components/schemas/Pipe"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of pipe inventory roles."
        }
    }
}

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.

{
    "type":"object",
    "description":"Consumed capacity of pipe.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the CapacityConsumed."
        },
        "name":{
            "type":"string",
            "description":"The name of the CapacityConsumed."
        },
        "percentConsumed":{
            "type":"string",
            "description":"Consumed capacity percentage."
        },
        "capacityConsumed":{
            "type":"string",
            "description":"Capacity consumed."
        }
    }
}

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.

{
    "type":"object",
    "description":"A capacity provided.",
    "properties":{
        "capacityType":{
            "type":"string",
            "description":"Capacity type of capacity provided."
        },
        "totalAmount":{
            "type":"string",
            "description":"Total amount of capacity provided."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure valid are Gbps,Kbps,Mbps,bps."
        },
        "consumablePercentage":{
            "type":"string",
            "description":"Percentage of capacity that can be consumable."
        }
    }
}

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.

{
    "type":"object",
    "description":"Required capacity of pipe.",
    "properties":{
        "capacityType":{
            "type":"string",
            "description":"Capacity type of required capacity."
        },
        "requiredAmount":{
            "type":"string",
            "description":"Required amount of capacity."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of measure valid are Gbps,Kbps,Mbps,bps."
        },
        "quantity":{
            "type":"integer",
            "description":"Percentage of capacity that can be consumable."
        }
    }
}

Nested Schema : pipeDirectionalityRef

Type: array

The list of pipe directionalities.

Show Source

• Array of: object PipeDirectionality
  A Pipe Directionality .

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PipeDirectionality"
    },
    "description":"The list of pipe directionalities."
}

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.

{
    "type":"object",
    "description":"Segment details that are enabling current Connectivity.",
    "properties":{
        "originatingTerminationPoint":{
            "type":"string",
            "description":"The id of the originatingTerminationPoint."
        },
        "terminatingTerminationPoint":{
            "type":"string",
            "description":"The id of the terminatingTerminationPoint."
        },
        "pipeSegmentRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Segment"
            },
            "description":"The list of pipe segments."
        }
    }
}

Nested Schema : roles

Type: array

The list of pipe inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of pipe inventory roles."
}

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.

{
    "type":"object",
    "description":"A Pipe Directionality .",
    "properties":{
        "pipeDirection":{
            "type":"string",
            "description":"The direction of the pipe.",
            "enum":[
                "BI_DIRECTIONAL",
                "UNI_DIRECTIONAL",
                "UNKNOWN"
            ]
        },
        "directionalityType":{
            "type":"string",
            "description":"The directionalityType of the pipe.",
            "enum":[
                "ROUTING",
                "SIGNAL"
            ]
        },
        "terminationId1":{
            "type":"string",
            "description":"The ID of the termination1."
        },
        "terminationId2":{
            "type":"string",
            "description":"The ID of the termination2."
        },
        "terminationName1":{
            "type":"string",
            "description":"The name of the termination1."
        },
        "terminationName2":{
            "type":"string",
            "description":"The name of the termination2."
        },
        "terminationDirectType1":{
            "type":"string",
            "description":"The DirectType of the termination1. Valid values are SINK, SOURCE, UNKNOWN.",
            "enum":[
                "SINK",
                "SOURCE",
                "UNKNOWN"
            ]
        },
        "terminationDirectType2":{
            "type":"string",
            "description":"The DirectType of the termination2. Valid values are SINK, SOURCE, UNKNOWN.",
            "enum":[
                "SINK",
                "SOURCE",
                "UNKNOWN"
            ]
        }
    }
}

Nested Schema : pipeSegmentRef

Type: array

The list of pipe segments.

Show Source

• Array of: object Segment
  Segment details that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Segment"
    },
    "description":"The list of pipe segments."
}

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.

{
    "type":"object",
    "description":"Segment details that are enabling current Connectivity.",
    "properties":{
        "segmentNumber":{
            "type":"string",
            "description":"Segment number."
        },
        "asideTerminationPoint":{
            "type":"string",
            "description":"The id of Termination point."
        },
        "asideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "asidePhysicalPort":{
            "$ref":"#/components/schemas/LogicalResource"
        },
        "aendLocation":{
            "type":"string",
            "description":"A side Location."
        },
        "segmentRef":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                }
            ]
        },
        "flowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "isGap":{
            "type":"boolean",
            "description":"Identifies if it is a gap or not."
        },
        "interconnectionType":{
            "$ref":"#/components/schemas/InterConnectionTypeEnum"
        },
        "zsideTerminationPoint":{
            "type":"string",
            "description":"The id of Termination point."
        },
        "zsideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "zendLocation":{
            "type":"string",
            "description":"Z side Location."
        },
        "zsidePhysicalPort":{
            "$ref":"#/components/schemas/LogicalResource"
        },
        "gapAccepted":{
            "type":"boolean",
            "description":"Use this attribute to accept gap. Default Reason for accepting gap is auto-generated as \"GAP OK\""
        },
        "lifeCycleBinding":{
            "$ref":"#/components/schemas/InterConnectionLifeCycleBindingEnum"
        }
    }
}

Nested Schema : flowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : segmentRef

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        }
    ]
}

Nested Schema : schema

A flow identifier.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A flow identifier.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "identifier":{
                    "type":"integer",
                    "description":"The ID of the flow identifier."
                },
                "identifierPrefix":{
                    "type":"string",
                    "description":"Prefix for the Identifier."
                },
                "domain":{
                    "$ref":"#/components/schemas/NetworkAddressDomain"
                },
                "stackingLevel":{
                    "type":"integer",
                    "description":"The stacking level of the flow identifier."
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• domain: schema
  A network address domain.
• identifier: integer
  The ID of the flow identifier.
• identifierPrefix: string
  Prefix for the Identifier.
• stackingLevel: integer
  The stacking level of the flow identifier.

{
    "type":"object",
    "properties":{
        "identifier":{
            "type":"integer",
            "description":"The ID of the flow identifier."
        },
        "identifierPrefix":{
            "type":"string",
            "description":"Prefix for the Identifier."
        },
        "domain":{
            "$ref":"#/components/schemas/NetworkAddressDomain"
        },
        "stackingLevel":{
            "type":"integer",
            "description":"The stacking level of the flow identifier."
        }
    }
}

Nested Schema : schema

A network address domain.

Match All

Show Source

• object allOf LogicalResource
  The base class for logical resources.
• object type

{
    "description":"A network address domain.",
    "allOf":[
        {
            "$ref":"#/components/schemas/LogicalResource"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The name of the network address domain. It also indicates the ID of the domain."
                },
                "networkAddressType":{
                    "type":"string",
                    "description":"The type of network address, either IP Subnet or flow identifier."
                },
                "ownedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                },
                "managedBy":{
                    "$ref":"#/components/schemas/RelatedPartyRef"
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the network address domain. It also indicates the ID of the domain."
        },
        "networkAddressType":{
            "type":"string",
            "description":"The type of network address, either IP Subnet or flow identifier."
        },
        "ownedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "managedBy":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        }
    }
}

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.

{
    "type":"object",
    "description":"A related party, which defines a party or party role linked to a specific entity.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the related party."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the related party."
        },
        "name":{
            "type":"string",
            "description":"The name of the related party."
        },
        "role":{
            "type":"string",
            "description":"The role of the related party."
        },
        "@referredType":{
            "type":"string",
            "description":"Concrete Type of the Party, in case of dis-ambiguity. Default  is '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.

{
    "type":"object",
    "description":"A role.",
    "properties":{
        "roleName":{
            "type":"string",
            "description":"The name of the role."
        },
        "roleType":{
            "type":"string",
            "description":"The type of role.",
            "enum":[
                "NONE",
                "TECHNOLOGY",
                "FUNCTION",
                "TOPOLOGY",
                "TARGET"
            ]
        }
    }
}

Nested Schema : type

Type: object

Show Source

• ALocation: object PlaceRef
  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.
• committedInformationRateDisplay: string
  Information rate.
• 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.
• identificationFormat: string
  Allowed Values: [ "LOCATION_BASED", "SERVICE_BASED", "CUSTOM_IDENTIFICATION" ]

  The list of valid values for Connectivity identifier format.
• isAllToOneBundling: boolean
  If all to one bundling is applicable.
• isAssignContiguousSerialNumber: boolean
  Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block.
• isBundling: boolean
  If it is bundling or not.
• isInternetwork: boolean
  If it is inter network or not.
• isInternetworkExternal: boolean
  If it is internetwork external or not.
• isServiceMultiplexing: boolean
  If it is service multiplexing or not.
• isVlanBased: boolean
  If it is vlan based or not.
• maxInformationRateDisplay: string
  maximum information rate.
• maxPacketVirtualNetworkCount: integer
  count of maximum packet virtual network.
• otherProviderDemarcationPoint: string
  Allowed Values: [ "A_LOCATION", "Z_LOCATION" ]

  The list of valid values for AZLocationType.
• otherServiceProviderName: string
  Name of other service provider.
• 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 PlaceRef
  A place to associate with the resource/service.

{
    "type":"object",
    "properties":{
        "connectivityIdentifier":{
            "type":"string",
            "description":"A unique identifier of Connectivity."
        },
        "technology":{
            "type":"string",
            "description":"The technology that applies to connectivity."
        },
        "identificationFormat":{
            "$ref":"#/components/schemas/ConnectivityIdentifierFormatEnum"
        },
        "ALocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the A side of the connectivity."
        },
        "ZLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the Z side of the connectivity."
        },
        "rateCode":{
            "type":"string",
            "description":"The rate code that applies to connectivity."
        },
        "function":{
            "type":"string",
            "description":"The function that applies to connectivity. Functions apply only to connectivities that have rate codes that define them as facilities."
        },
        "serialNumber":{
            "type":"integer",
            "description":"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."
        },
        "quantity":{
            "type":"integer",
            "description":"The number of Connectivity entities to be created."
        },
        "isAssignContiguousSerialNumber":{
            "type":"boolean",
            "description":"Should be true if multiple Connectivity entities are created and want their serial numbers to be in a continuous block."
        },
        "consumablePercent":{
            "type":"integer",
            "description":"Percentage of capacity that can be consumed."
        },
        "bitRate":{
            "type":"string",
            "description":"The bit rate is based on the rate code applied to the connectivity."
        },
        "assignedToService":{
            "type":"string",
            "format":"uri",
            "description":"The service (if any) to which the connectivity is assigned."
        },
        "isInternetwork":{
            "type":"boolean",
            "description":"If it is inter network or not."
        },
        "isInternetworkExternal":{
            "type":"boolean",
            "description":"If it is internetwork external or not."
        },
        "otherServiceProviderName":{
            "type":"string",
            "description":"Name of other service provider."
        },
        "otherProviderDemarcationPoint":{
            "$ref":"#/components/schemas/AZLocationTypeEnum"
        },
        "isServiceMultiplexing":{
            "type":"boolean",
            "description":"If it is service multiplexing or not."
        },
        "isBundling":{
            "type":"boolean",
            "description":"If it is bundling or not."
        },
        "isAllToOneBundling":{
            "type":"boolean",
            "description":"If all to one bundling is applicable."
        },
        "isVlanBased":{
            "type":"boolean",
            "description":"If it is vlan based or not."
        },
        "maxPacketVirtualNetworkCount":{
            "type":"integer",
            "description":"count of maximum packet virtual network."
        },
        "committedInformationRateDisplay":{
            "type":"string",
            "description":"Information rate."
        },
        "maxInformationRateDisplay":{
            "type":"string",
            "description":"maximum information rate."
        },
        "connectivityDesign":{
            "$ref":"#/components/schemas/ConnectivityDesign"
        }
    }
}

Nested Schema : PlaceRef

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.

{
    "type":"object",
    "description":"A place to associate with the resource/service.",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the place."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the place."
        },
        "name":{
            "type":"string",
            "description":"The name of the place."
        },
        "@referredType":{
            "$ref":"#/components/schemas/PlaceReferredTypeEnum"
        },
        "role":{
            "type":"string",
            "description":"The role of the place."
        },
        "referrerRole":{
            "type":"string",
            "description":"The role of the associated resource."
        }
    }
}

Nested Schema : ConnectivityDesign

Type: object

Gives the details of latest connectivity design version.

Show Source

• aendLocation: object PlaceRef
  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.
• terminateAtFlowInterface: boolean
  This should be true if end point needs to be terminated at Flow Interface.
• zendLocation: object PlaceRef
  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.

{
    "type":"object",
    "description":"Gives the details of latest connectivity design version.",
    "properties":{
        "connectivityDesignVersion":{
            "type":"integer",
            "description":"The version number of connectivity design."
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The starting date and time when the connectivity design becomes effective."
        },
        "status":{
            "$ref":"#/components/schemas/ConfigurationStateEnum",
            "description":"The configuration status of latest connectivity design version."
        },
        "asideTerminationPointId":{
            "type":"string",
            "description":"The id of Termination point on A side."
        },
        "zsideTerminationPointId":{
            "type":"string",
            "description":"The id of Termination point on Z side."
        },
        "aendLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the A side of the connectivity."
        },
        "zendLocation":{
            "$ref":"#/components/schemas/PlaceRef",
            "description":"The network location code or network entity code for the Z side of the connectivity."
        },
        "asideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for A side interface of the connectivity."
        },
        "zsideInterface":{
            "$ref":"#/components/schemas/LogicalResource",
            "description":"The DeviceInterface or FlowInterface for Z side interface of the connectivity."
        },
        "asideFlowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "zsideFlowIdentifiers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowIdentifier"
            }
        },
        "terminateAtFlowInterface":{
            "type":"boolean",
            "description":"This should be true if end point needs to be terminated at Flow Interface."
        },
        "paths":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectivityPath"
            }
        }
    }
}

Nested Schema : asideFlowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : paths

Type: array

Show Source

• Array of: object ConnectivityPath
  Paths that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ConnectivityPath"
    }
}

Nested Schema : zsideFlowIdentifiers

Type: array

Show Source

• Array of: schema
  A flow identifier.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowIdentifier"
    }
}

Nested Schema : ConnectivityPath

Type: object

Paths that are enabling current Connectivity.

Show Source

• label: string
  Path label like Path1, Path2.
• segments: array segments

{
    "type":"object",
    "description":"Paths that are enabling current Connectivity.",
    "properties":{
        "label":{
            "type":"string",
            "description":"Path label like Path1, Path2."
        },
        "segments":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Segment"
            }
        }
    }
}

Nested Schema : segments

Type: array

Show Source

• Array of: object Segment
  Segment details that are enabling current Connectivity.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Segment"
    }
}

Nested Schema : BusinessInteractionRef

Type: object

Show Source

• id: string
  The id of Business Interaction
• state: string
  The state of Business Interaction

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of Business Interaction"
        },
        "state":{
            "type":"string",
            "description":"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.

{
    "type":"object",
    "description":"An external identity.",
    "properties":{
        "externalObjectId":{
            "type":"string",
            "description":"The ID for a business entity."
        },
        "externalName":{
            "type":"string",
            "description":"The business-meaningful name of the business entity."
        },
        "externalManagementDomain":{
            "type":"string",
            "description":"The external system, domain name, party, or participant in a federation solution."
        },
        "externalArrangement":{
            "type":"string",
            "description":"The type of federation model between UIM and the external party for the given entity.",
            "enum":[
                "LEASED_IN",
                "FEDERATED",
                "LEASED_OUT",
                "SHARED"
            ]
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaceServiceRef"
    },
    "description":"The list of associated geographic places, list of assigned/referenced geographic places, list of associated places on supported resources."
}

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

• Array of: RelatedPartyServiceRef
  The party reference on a service.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedPartyServiceRef"
    },
    "description":"A list of related party references (RelatedParty [1..*]). A related party defines party or party role linked to a specific entity."
}

Nested Schema : serviceCharacteristic

Type: array

A list of characteristics that characterize this service (ServiceCharacteristic [*])

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceCharacteristic"
    },
    "description":"A list of characteristics that characterize this service (ServiceCharacteristic [*]) "
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RelatedServiceOrderItem"
    },
    "description":"A list of related service order items (RelatedServiceOrderItem [*]). A list of service order items related to this service."
}

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).

{
    "type":"array",
    "description":"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).",
    "items":{
        "$ref":"#/components/schemas/ServiceRelationship"
    }
}

Nested Schema : Specification

Type: object

A specification.

Show Source

• description: string
  Details about the specification.
• endDate: string (date-time)
  The date and time when the specification ends.
• entityType: string
  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.
• 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.
• startDate: string (date-time)
  The date and time when the specification starts.
• version: string
  The version of the specification, which is always 1.

{
    "type":"object",
    "description":"A specification.",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the specification, which is the same as the name of the specification."
        },
        "href":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the specification."
        },
        "name":{
            "type":"string",
            "description":"The name of the specification."
        },
        "description":{
            "type":"string",
            "description":"Details about the specification."
        },
        "version":{
            "type":"string",
            "description":"The version of the specification, which is always <b>1</b>."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        },
        "startDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification starts."
        },
        "endDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the specification ends."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceServiceRef"
    },
    "description":"A list of supporting resources (SupportingResource [*]).For CFS list includes all the supporting resources of RFS."
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Service"
    },
    "description":"A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)."
}

Nested Schema : PlaceServiceRef

The place reference on a service.

Match All

Show Source

• object PlaceRef
  A place to associate with the resource/service.
• object PlaceServiceRef-allOf[1]

{
    "description":"The place reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PlaceRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "resourceName":{
                    "type":"string",
                    "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "latitude":{
                    "type":"string",
                    "description":"Latitude of the place."
                },
                "longitude":{
                    "type":"string",
                    "description":"Longitude of the place."
                },
                "placeSpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "placeCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the place."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the place."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the place."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the place which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : PlaceServiceRef-allOf[1]

Type: object

Show Source

• 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'.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "resourceName":{
            "type":"string",
            "description":"The name of the resource on which place is associated. This will be populated when ReferenceType is set to 'ResourceNetworkLocation' or 'ResourceAssociation'."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "latitude":{
            "type":"string",
            "description":"Latitude of the place."
        },
        "longitude":{
            "type":"string",
            "description":"Longitude of the place."
        },
        "placeSpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "placeCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the place."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the place."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the place."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the place which is editable from UI."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the place."
}

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.
• 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.

{
    "type":"object",
    "description":"A characteristic of an object or entity represented by a name-value pair.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the characteristic."
        },
        "valueType":{
            "type":"string",
            "description":"The data type for the characteristics's value.",
            "enum":[
                "ALPHANUMERIC",
                "NUMERIC",
                "BOOLEAN",
                "DATE",
                "OBJECT",
                "URL"
            ]
        },
        "value":{
            "type":"object",
            "description":"The value of the characteristic."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI for the JSON Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The entity type of the object. This is useful for EntityLink characters and when the value is set with an actual object and the <b>valueType</b> is an object."
        }
    }
}

Nested Schema : value

Type: object

The value of the characteristic.

Nested Schema : RelatedPartyServiceRef

The party reference on a service.

Match All

Show Source

• object RelatedPartyRef
  A related party, which defines a party or party role linked to a specific entity.
• object RelatedPartyServiceRef-allOf[1]

{
    "description":"The party reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        {
            "type":"object",
            "properties":{
                "referenceType":{
                    "$ref":"#/components/schemas/ReferenceTypeEnum",
                    "description":"The type of the reference."
                },
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "partySpecification":{
                    "$ref":"#/components/schemas/Specification"
                },
                "partyCharacteristic":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Characteristic"
                    },
                    "description":"The list of characteristics for the party."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the party."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the party."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the party which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : RelatedPartyServiceRef-allOf[1]

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "referenceType":{
            "$ref":"#/components/schemas/ReferenceTypeEnum",
            "description":"The type of the reference."
        },
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "partySpecification":{
            "$ref":"#/components/schemas/Specification"
        },
        "partyCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Characteristic"
            },
            "description":"The list of characteristics for the party."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the party."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the party."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the party which is editable from UI."
        }
    }
}

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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Characteristic"
    },
    "description":"The list of characteristics for the party."
}

Nested Schema : ServiceCharacteristic

The service characteristic details.

Match All

Show Source

• object Characteristic
  A characteristic of an object or entity represented by a name-value pair.
• object ServiceCharacteristic-allOf[1]

{
    "description":"The service characteristic details.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Characteristic"
        },
        {
            "type":"object",
            "properties":{
                "serviceName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "serviceSpecName":{
                    "type":"string",
                    "description":"The specification name of service.Required only for creation of the service."
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the service characteristic."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the service characteristic."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the service characteristic which is editable from UI."
                },
                "configItemPath":{
                    "type":"string",
                    "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
                }
            }
        }
    ]
}

Nested Schema : ServiceCharacteristic-allOf[1]

Type: object

Show Source

• 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.
• serviceName: string
  The name of the service consumer.
• serviceSpecName: string
  The specification name of service.Required only for creation of the service.

{
    "type":"object",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "serviceSpecName":{
            "type":"string",
            "description":"The specification name of service.Required only for creation of the service."
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the service characteristic."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the service characteristic."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the service characteristic which is editable from UI."
        },
        "configItemPath":{
            "type":"string",
            "description":"The path of the config item's property. Its value can be get from design studio catridges where this property was designed."
        }
    }
}

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.

{
    "type":"object",
    "required":[
        "itemId, serviceOrderId"
    ],
    "description":"The service order item which triggered service creation/change/termination.",
    "properties":{
        "itemAction":{
            "$ref":"#/components/schemas/OrderItemActionEnum"
        },
        "itemId":{
            "type":"string",
            "description":"Identifier of the order item where the service was managed."
        },
        "role":{
            "type":"string",
            "description":"Role of the service order item for this service."
        },
        "serviceOrderHref":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "serviceOrderId":{
            "type":"string",
            "description":"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

{
    "required":[
        "relationshipType",
        "service"
    ],
    "type":"object",
    "properties":{
        "relationshipType":{
            "type":"string",
            "description":"The type of relationship (e.g. depends on, enables)"
        },
        "service":{
            "$ref":"#/components/schemas/Service"
        },
        "serviceRelationshipCharacteristic":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceCharacteristic"
            }
        }
    },
    "description":"Describes links with services of the same category (useful for bundled services)."
}

Nested Schema : serviceRelationshipCharacteristic

Type: array

Show Source

• Array of: ServiceCharacteristic
  The service characteristic details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceCharacteristic"
    }
}

Nested Schema : ResourceServiceRef

The resource reference on a service.

Match All

Show Source

• object ResourceRef
• object ResourceServiceRef-allOf[1]

{
    "description":"The resource reference on a service.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceRef"
        },
        {
            "type":"object",
            "properties":{
                "consumerName":{
                    "type":"string",
                    "description":"The name of the service consumer."
                },
                "assignmentState":{
                    "$ref":"#/components/schemas/AssignmentStateEnum"
                },
                "referenceState":{
                    "$ref":"#/components/schemas/ReferenceStateEnum"
                },
                "expandResource":{
                    "$ref":"#/components/schemas/ResourceBase"
                },
                "configItemId":{
                    "type":"string",
                    "description":"The config item id of the resource."
                },
                "configItemName":{
                    "type":"string",
                    "description":"The config item name of the resource."
                },
                "configItemDisplayName":{
                    "type":"string",
                    "description":"The config item display name of the resource which is editable from UI."
                }
            }
        }
    ]
}

Nested Schema : ResourceRef

Type: object

Show Source

• @referredType: string
  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.
• 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.

{
    "type":"object",
    "required":[
        "id, '@referredType'"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the supporting resource."
        },
        "href":{
            "type":"string",
            "description":"Reference of the supporting resource.",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "description":"Name of the resource supporting the service."
        },
        "@referredType":{
            "$ref":"#/components/schemas/ResourceTypeEnum"
        }
    }
}

Nested Schema : ResourceServiceRef-allOf[1]

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "consumerName":{
            "type":"string",
            "description":"The name of the service consumer."
        },
        "assignmentState":{
            "$ref":"#/components/schemas/AssignmentStateEnum"
        },
        "referenceState":{
            "$ref":"#/components/schemas/ReferenceStateEnum"
        },
        "expandResource":{
            "$ref":"#/components/schemas/ResourceBase"
        },
        "configItemId":{
            "type":"string",
            "description":"The config item id of the resource."
        },
        "configItemName":{
            "type":"string",
            "description":"The config item name of the resource."
        },
        "configItemDisplayName":{
            "type":"string",
            "description":"The config item display name of the resource which is editable from UI."
        }
    }
}

Nested Schema : schema

A physical port.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical port.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "portNumber":{
                    "type":"integer",
                    "description":"A non-zero integer that uniquely identifies this physical port instance from all other instances."
                },
                "vendorPortName":{
                    "type":"string",
                    "description":"The vendor-specific name for the port."
                },
                "customerPortName":{
                    "type":"string",
                    "description":"The customer-specific name for the port."
                },
                "physicalDeviceRef":{
                    "$ref":"#/components/schemas/PhysicalDevice"
                },
                "equipmentRef":{
                    "$ref":"#/components/schemas/Equipment"
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of physical port inventory roles."
                }
            }
        }
    ]
}

Nested Schema : PhysicalResource

Type: object

The base class for physical resources.

Match All

Show Source

• object Discriminator: @type
  Discriminator: { "propertyName":"@type" }

  A base resource Class.
• object PhysicalResource-allOf[1]

{
    "type":"object",
    "description":"The base class for physical resources.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ResourceBase"
        },
        {
            "type":"object",
            "properties":{
                "serialNumber":{
                    "type":"string",
                    "description":"The serial number for the physical resource."
                }
            }
        }
    ]
}

Nested Schema : PhysicalResource-allOf[1]

Type: object

Show Source

• serialNumber: string
  The serial number for the physical resource.

{
    "type":"object",
    "properties":{
        "serialNumber":{
            "type":"string",
            "description":"The serial number for the physical resource."
        }
    }
}

Nested Schema : type

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "portNumber":{
            "type":"integer",
            "description":"A non-zero integer that uniquely identifies this physical port instance from all other instances."
        },
        "vendorPortName":{
            "type":"string",
            "description":"The vendor-specific name for the port."
        },
        "customerPortName":{
            "type":"string",
            "description":"The customer-specific name for the port."
        },
        "physicalDeviceRef":{
            "$ref":"#/components/schemas/PhysicalDevice"
        },
        "equipmentRef":{
            "$ref":"#/components/schemas/Equipment"
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of physical port inventory roles."
        }
    }
}

Nested Schema : schema

A physical device resource.

Match All

Show Source

• object allOf PhysicalResource
  The base class for physical resources.
• object type

{
    "description":"A physical device resource.",
    "allOf":[
        {
            "$ref":"#/components/schemas/PhysicalResource"
        },
        {
            "type":"object",
            "properties":{
                "networkLocation":{
                    "$ref":"#/components/schemas/PlaceRef"
                },
                "physicalAddress":{
                    "type":"string",
                    "description":"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."
                },
                "physicalLocation":{
                    "type":"string",
                    "description":"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)."
                },
                "physicalConnectors":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical connector instances provided by the physical device instance.",
                    "readOnly":true
                },
                "physicalPorts":{
                    "type":"string",
                    "format":"uri",
                    "description":"The URI for the list of physical ports provided by the physical device instance.",
                    "readOnly":true
                },
                "roles":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Role"
                    },
                    "description":"The list of physical device inventory roles."
                }
            }
        }
    ]
}

Nested Schema : roles

Type: array

The list of physical port inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of physical port inventory roles."
}

Nested Schema : type

Type: object

Show Source

• networkLocation: object PlaceRef
  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.

{
    "type":"object",
    "properties":{
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalAddress":{
            "type":"string",
            "description":"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."
        },
        "physicalLocation":{
            "type":"string",
            "description":"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)."
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the physical device instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical ports provided by the physical device instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"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.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of physical device inventory roles."
}

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.

{
    "type":"object",
    "description":"Details of rehomed or groomed connectivity/pipe and trails (Connectivity/Pipe) impacted by the rehome or groom.",
    "properties":{
        "action":{
            "type":"string",
            "description":"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":{
            "description":"Impacted Connectivity or Pipe after rehome or groom.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Pipe"
                },
                {
                    "$ref":"#/components/schemas/Connectivity"
                },
                {
                    "$ref":"#/components/schemas/Equipment"
                }
            ]
        },
        "serviceChangeEntity":{
            "description":"Impacted Service after rehome service.",
            "$ref":"#/components/schemas/Service"
        },
        "status":{
            "description":"Status of impacted item.",
            "$ref":"#/components/schemas/ActivityStateEnum"
        },
        "parentChangeItem":{
            "type":"string",
            "description":"Parent activity item due to which this item got imapacted."
        }
    }
}

Nested Schema : changedEntity

Impacted Connectivity or Pipe after rehome or groom.

Match One Schema

Show Source

• schema
  A pipe resource.
• schema
  A Connectivity resource.
• schema
  An equipment resource.

{
    "description":"Impacted Connectivity or Pipe after rehome or groom.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/Pipe"
        },
        {
            "$ref":"#/components/schemas/Connectivity"
        },
        {
            "$ref":"#/components/schemas/Equipment"
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• 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 PlaceRef
  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.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"The category, or grouping, of equipment built from this specification. The valid values are RACK, SHELF, and CARD.",
            "readOnly":true
        },
        "vendorName":{
            "type":"string",
            "description":"The name of the equipment manufacturer.",
            "readOnly":true
        },
        "modelNumber":{
            "type":"string",
            "description":"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.",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "description":"The manufacturer-allocated part number assigned by the organization that manufactures the hardware. This, in combination with model number, identifies different types of hardware.",
            "readOnly":true
        },
        "networkLocation":{
            "$ref":"#/components/schemas/PlaceRef"
        },
        "physicalConnectors":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the list of physical connector instances provided by the equipment instance.",
            "readOnly":true
        },
        "physicalPorts":{
            "type":"string",
            "format":"uri",
            "description":"The URI for the physical port instances provided by the equipment instance.",
            "readOnly":true
        },
        "roles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Role"
            },
            "description":"The list of equipment inventory roles."
        }
    }
}

Nested Schema : roles

Type: array

The list of equipment inventory roles.

Show Source

• Array of: object Role
  A role.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    },
    "description":"The list of equipment inventory roles."
}

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

• code: string
  The error code.
• entityType: string
  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: 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.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

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

• code: string
  The error code.
• entityType: string
  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: 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.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

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

• code: string
  The error code.
• entityType: string
  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: 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.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

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

• code: string
  The error code.
• entityType: string
  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: 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.

{
    "type":"object",
    "description":"Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).",
    "properties":{
        "code":{
            "type":"string",
            "description":"The error code."
        },
        "reason":{
            "type":"string",
            "description":"The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem."
        },
        "message":{
            "type":"array",
            "description":"The text that provides more details about the error as well as corrective actions.",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension, such as 400-2."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to the documentation that describes the error."
        },
        "entityType":{
            "$ref":"#/components/schemas/EntityClassEnum"
        }
    }
}

Nested Schema : message

Type: array

The text that provides more details about the error as well as corrective actions.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The text that provides more details about the error as well as corrective actions.",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

This example shows how to create a replace card project for a given project name and activity name 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/resourceInventoryManagement/version/replacecard -H 'content-type: application/json' -H credentials -d @replacecardcreate.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".
• replacecardcreate.json is the JSON file that specifies the replace card entities to create.

Example of Request Body

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

{
    "projectName": "ReplaceCardRESTProject_29",
    "activity": {
        "activityName": "ReplaceCardRESTActivity_29",
        "autoMap": true,
        "sourceCard": {
            "id": "8-525014",
            "@type": "Equipment"
        },
        "targetCard": {
            "id": "8-EqRC_New_A04",
            "@type": "Equipment"
        }
    }
}
{
    "projectName": "ReplaceCardRESTProject_30",
    "activity": {
        "activityName": "ReplaceCardRESTActivity_30",
        "autoMap": false,
        "sourceCard": {
            "id": "8-525024",
            "@type": "Equipment"
        },
        "targetCard": {
            "id": "8-EqRC_New_A09",
            "@type": "Equipment"
        }
        "activityItems": [
            {
                "source": {
                    "id": "10-525024-525170",
                    "@type": "PhysicalPort"
                },
                "target": {
                    "id": "10-EqRC_New_A09-525177",
                    "@type": "PhysicalPort"
                }
            },
            {
                "changedEntity": {
                    "id": "AAA / BBB / OTU3 / OTU3 / 22",
                    "@type": "Connectivity"
                },
                "source": {
                    "id": "10-525005-525033",
                    "@type": "PhysicalPort"
                },
                "target": {
                    "id": "10-EqRC_New_F27-525039",
                    "@type": "PhysicalPort"
                }
            },
            {
                "serviceChangeEntity": {
                    "id": "ServiceRC_A_A99"
                },
                "source": {
                    "id": "10-525005-525032",
                    "@type": "PhysicalPort"
                },
                "target": {
                    "id": "10-EqRC_New_F27-525040",
                    "@type": "PhysicalPort"
                }
            }
        ]
    }
}

Note:

If the project and activity names are not provided, the project and activity are created with the default names. Optionally, a single POST request can be sent for rehome project creation and submission by adding a query parameter submit=true.

If autoMap is true, all the consumers from physical ports of source card are rehomed to physical ports of the target cards. Therefore, for autoMap = true, the target card should have equal or more number of physical ports than the source card.

If autoMap is false, the activity items are created to address each and every consumer of the source card's physical ports. The activity items are created as follows:

• If only source and target are mentioned with no information on the consumers, all the consumers on the source port are rehomed to the target port.
• For connectivity or pipe, changedEntity is passed with the activity, along with the corresponding source and target. For changedEntity, the id and type properties are provided.
• For service, serviceChangedEntity is passed with the activity, along with the corresponding source and target. For serviceChangedEntity, only the id property is provided.

Example of Response Body

This example shows the contents of the response body in JSON format. The projectname and activityname values are auto-generated if not provided in the request body. The response code 201 is generated upon successful creation.

{
    "id": "36-ReplaceCardProject1_RCMT15",
    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/replacecard/36-ReplaceCardProject1_RCMT15/33-RC_1_RCMT15",
    "projectName": "ReplaceCardProject1_RCMT15",
    "status": "CREATED",
    "activity": {
        "id": "33-RC_1_RCMT15",
        "activityName": "RC_1_RCMT15",
        "status": "READY",
        "activityItems": [
            {
                "changedEntity": {
                    "id": "8-EQ.AAA.F1_RCMT15",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/8-EQ.AAA.F1_RCMT15",
                    "@type": "Equipment"
                },
                "source": {
                    "id": "8-2100002",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/8-2100002",
                    "@type": "Equipment"
                },
                "target": {
                    "id": "8-EQ.PAR.AAA.New_RCMT15",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/8-EQ.PAR.AAA.New_RCMT15",
                    "@type": "Equipment"
                },
                "status": "READY",
                "comments": ""
            },
            {
                "serviceChangedEntity": {
                    "id": "ServiceRC_A_RCMT15",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/serviceInventoryManagement/v3/service/ServiceRC_A_RCMT15"
                },
                "source": {
                    "id": "10-2100002-2100005",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/10-2100002-2100005",
                    "@type": "PhysicalPort"
                },
                "target": {
                    "id": "10-EQ.PAR.AAA.New_RCMT15-2100045",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/10-EQ.PAR.AAA.New_RCMT15-2100045",
                    "@type": "PhysicalPort"
                },
                "status": "READY",
                "comments": ""
            },
            {
                "changedEntity": {
                    "id": "31-1650003",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-1650003",
                    "@type": "Connectivity",
                    "connectivityIdentifier": "AAA_RCMT15 / BBB_RCMT15 / STM4 / SM04 / 1"
                },
                "source": {
                    "id": "10-EQ.SUB.AAA.F1_RCMT15-2100025",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/10-EQ.SUB.AAA.F1_RCMT15-2100025",
                    "@type": "PhysicalPort"
                },
                "target": {
                    "id": "10-EQ.SUB.AAA.New_RCMT15-2100040",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/10-EQ.SUB.AAA.New_RCMT15-2100040",
                    "@type": "PhysicalPort"
                },
                "status": "READY",
                "comments": ""
            },
            {
                "changedEntity": {
                    "id": "31-1650001",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-1650001",
                    "@type": "Connectivity",
                    "connectivityIdentifier": "AAA_RCMT15 / CCC_RCMT15 / 300M / E300 / 1"
                },
                "source": {
                    "id": "10-EQ.SUB.AAA.F1_RCMT15-2100025",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/10-EQ.SUB.AAA.F1_RCMT15-2100025",
                    "@type": "PhysicalPort"
                },
                "target": {
                    "id": "10-EQ.SUB.AAA.New_RCMT15-2100040",
                    "href": "http://localhost:7222/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/10-EQ.SUB.AAA.New_RCMT15-2100040",
                    "@type": "PhysicalPort"
                },
                "status": "READY",
                "comments": ""
            }
        ],
        "impactedItems": []
    }
}

Note:

The first activity item is always to replace a source card with a target card from its parent equipment.

Back to Top