Jump to

• Request
• Response
• Examples

Update a Connectivity

patch

/connectivity/{connectivityIdentifier}

Updates the Connectivity that matches the specified connectivityIdentifier or id. Update can be performed either using merge-patch or json-patch, each of which accepts a different request content-type. Kindly note that only below attributes can be updated and all other non-editable attributes must not be provided in the PATCH requests:

• description
• consumablePercent
• connectivityDesign
• resourceCharacteristic.name

Merge Patch:

All attributes provided in the request will be updated with the given values.

JSON Patch:

This operation performs sequential updates on individual attributes.

Attribute selection is enabled for all first-level attributes.

Optionally, use the expand parameter to specify resource relationships (resourceRelationship.INVOLVE) that you want to see details for. By default, you'll just see links for these.

Optionally, use the depth parameter to expand the level of referenced entities. If depth=0, all referenced entities in RootEntity objects will contain only the ID, HREF, and @type. If depth=N, it expands reference objects of related entities recursively, and the last level contains only the references. The default is depth=0.

NOTE: {connectivityIdentifier} in path parameter can be connectivityIdentifier or Id of the connectivity.

Request

Path Parameters

• connectivityIdentifier(required): string
  The ID of the connectivity to be updated.

Query Parameters

• depth: integer
  The depth of the expansion.

  Default Value: 0
• expand: string
  The additional details to include in the response.
• fields: string
  The fields to include in the response.

Supported Media Types

• application/json-patch+json
• application/merge-patch+json

Request Body - application/json-patch+json ()

The connectivity to be updated.

Root Schema : schema

Type: array

Show Source

• Array of: object PatchDocument
  A JSON PATCH document.

{
    "type":"array",
    "items":{
        "description":"A list of PATCH documents for a request.",
        "$ref":"#/components/schemas/PatchDocument"
    }
}

Nested Schema : PatchDocument

Type: object

A JSON PATCH document.

Show Source

• op(required): string
  Allowed Values: [ "add", "remove", "replace" ]
• path(required): string
  A JSON pointer indicating where to perform the operation.
• value: object value
  The value to use with the operation.

{
    "description":"A JSON PATCH document.",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "enum":[
                "add",
                "remove",
                "replace"
            ]
        },
        "path":{
            "type":"string",
            "description":"A JSON pointer indicating where to perform the operation."
        },
        "value":{
            "type":"object",
            "description":"The value to use with the operation."
        }
    }
}

Nested Schema : value

Type: object

The value to use with the operation.

Request Body - application/merge-patch+json ()

The connectivity to be updated.

Root 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 : 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 : 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 : 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 : 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 : 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 : 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"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The connectivity was updated successfully.

Body ()

Root 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 : 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 : 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 : 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 : 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 : 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 : 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"
            ]
        }
    }
}

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 update the details of a connectivity of a given ID by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X PATCH "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/connectivity/ID" -H credentials @connectivityPatch.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.
• ID is the ID of the connectivity to be updated.
• connectivityPatch.json is the JSON file with updated values.

Terminate at Media Interface on A and Z sides of Connectivity

Example of Request Body

This shows an example of the contents of the connectivityPatch.json file sent as the request body for the MERGE patch.

Note:

The MERGE patch requests should not have any non-editable attributes in the requests such as technology, aendlocation, function, and so on, as they cannot be updated. The asideInterface and zsideInterface attributes can be provided at a time for MERGE patch.

Example for MERGE patch

{
        "@type": "Connectivity",
        "connectivityDesign": {
            "asideInterface" : {
                "id": "20-10GigE-75001-1",
                "@type": "DeviceInterface"
            }
        }
}

Example for JSON Patch

This shows an example of the contents of the connectivityPatch.json file sent as the request body for the JSON patch.

Note:

For JSON patch, only one sideInterface can be provided at a time.

[
	{
        "op": "add",
	    "path": "/connectivityDesign",
	    "value": {
	    	"asideInterface" : {
		    	"id":"20-10GigE-75001-1",
			    "@type": "DeviceInterface"
		    }	
	    }
    }
]

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the connectivity details for a given ID.

{
        "id": "31-600001",
        "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-600001",
        "@type": "Connectivity",
        "@baseType": "LogicalResource",
        "description": "merged description from apiisisiiii",
        "resourceVersion": "1",
        "lifecycleState": "INSTALLED",
        "lifecycleSubState": "UNASSIGNED",
        "startOperatingDate": "2022-04-18T17:48:53.897Z",
        "endOperatingDate": "2038-01-19T08:44:07.000Z",
        "resourceRelationship": [
            {
                "relationshipType": "INVOLVE",
                "resourceRef": {
                    "id": "12-1125009",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/12-1125009",
                    "@type": "CustomObject"
                }
            }
        ],
        "resourceCharacteristic": [],
        "resourceSpecification": {
            "id": "AccessSiteConn",
            "href": "http://hostname:port/InventoryRSOpenAPI/specification/AccessSiteConn",
            "name": "AccessSiteConn",
            "version": "1",
            "entityType": "Pipe",
            "startDate": "2021-09-10T00:00:01.000Z",
            "endDate": "2038-01-19T08:44:07.000Z"
        },
        "connectivityIdentifier": "BANGLORE / HYD / 10GigE / GE10 / 2",
        "technology": "Ethernet",
        "identificationFormat": "LOCATION_BASED",
        "aendLocation": {
            "id": "HYD",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/HYD",
            "name": "HYD",
            "@referredType": "PropertyLocation"
        },
        "zendLocation": {
            "id": "BANGLORE",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BANGLORE",
            "name": "STREET 9 BANGLORE IN",
            "@referredType": "PropertyLocation"
        },
        "rateCode": "10GigE",
        "function": "GE10",
        "serialNumber": 2,
        "consumablePercent": 64,
        "bitRate": "10000 Mbps",
        "isServiceMultiplexing": false,
        "isBundling": true,
        "isAllToOneBundling": false,
        "isVlanBased": false,
        "maxPacketVirtualNetworkCount": 0,
        "connectivityDesign": {
            "connectivityDesignVersion": 1,
            "startDate": "2022-03-31T22:48:18.586Z",
            "status": "COMPLETED",
            "asideTerminationPointId": "600002",
            "zsideTerminationPointId": "600001",
            "aendLocation": {
                "id": "HYD",
                "href": "http://hostname:port/InventoryRSOpenAPI/place/HYD",
                "name": "HYD",
                "@referredType": "PropertyLocation"
            },
            "zendLocation": {
                "id": "BANGLORE",
                "href": "http://hostname:port/InventoryRSOpenAPI/place/BANGLORE",
                "name": "STREET 9 BANGLORE IN",
                "@referredType": "PropertyLocation"
            },
            "asideInterface": {
                "id": "20-10GigE-75001-1",
                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-10GigE-75001-1",
                "@type": "DeviceInterface"
            },
            "paths": [
                {
                    "label": "Path 1",
                    "segments": [
                        {
                            "segmentNumber": "1",
                            "isGap": true,
                            "gapAccepted": true
                        }
                    ]
                }
            ]
        }
    }

Terminate at Flow Interface on A and Z sides of Connectivity

Example of Request Body

MERGE patch:

{
    "@type": "Connectivity",
    "connectivityDesign": {
         "terminateAtFlowInterface":true,
          "asideInterface": {
            "id": "20-1GigE-225005-1",
            "@type": "DeviceInterface"
        }
    }
}

JSON patch:

[
    {
        "op": "add",
        "path": "/connectivityDesign",
        "value": {
            "asideInterface": {
                "id": "20-1GigE-225005-1",
                "@type": "DeviceInterface"
            },
            "terminateAtFlowInterface":"true"
        }
    }
]

Example for Response Body

This example shows the contents of the response body in JSON format. It shows the connectivity details for a given ID after performing a patch.

{
        "id": "31-750007",
        "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-750007",
        "@type": "Connectivity",
        "@baseType": "LogicalResource",
        "resourceVersion": "1",
        "lifecycleState": "INSTALLED",
        "lifecycleSubState": "PENDING_ASSIGN",
        "startOperatingDate": "2022-04-05T10:05:06.858Z",
        "endOperatingDate": "2038-01-19T08:44:07.000Z",
        "resourceRelationship": [],
        "resourceCharacteristic": [
            {
                "name": "isCeVlanCosPreservation",
                "valueType": "BOOLEAN",
                "value": "true",
                "characteristicRelationship": []
            },
            {
                "name": "isCeVlanIdPreservation",
                "valueType": "BOOLEAN",
                "value": "true",
                "characteristicRelationship": []
            },
            {
                "name": "macLayer",
                "valueType": "ALPHANUMERIC",
                "value": "IEEE 802.3-2005",
                "characteristicRelationship": []
            },
            {
                "name": "uniType",
                "valueType": "ALPHANUMERIC",
                "value": "Type 1.1",
                "characteristicRelationship": []
            },
            {
                "name": "numberOfLinks",
                "valueType": "ALPHANUMERIC",
                "value": "1",
                "characteristicRelationship": []
            }
        ],
        "resourceSpecification": {
            "id": "UNI Connectivity",
            "href": "http://hostname:port/InventoryRSOpenAPI/specification/UNI%20Connectivity",
            "name": "UNI Connectivity",
            "version": "1",
            "entityType": "Pipe",
            "startDate": "2021-12-22T00:00:01.000Z",
            "endDate": "2038-01-19T08:44:07.000Z"
        },
        "connectivityIdentifier": "BAT01HYDB_12.001 / BAT01HYDB_HDFC2 HYDERABAD IN / 1GigE / GE1 / 1",
        "technology": "Ethernet",
        "identificationFormat": "LOCATION_BASED",
        "aendLocation": {
            "id": "BAT01HYDB_HDFC2 HYDERABAD IN",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01HYDB_HDFC2 HYDERABAD IN",
            "name": "BAT01HYDB_HDFC2 HYDERABAD IN",
            "@referredType": "PropertyLocation"
        },
        "zendLocation": {
            "id": "BAT01HYDB_12.001",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01HYDB_12.001",
            "name": "BAT01HYDB_12.001",
            "@referredType": "NetworkEntityCode"
        },
        "rateCode": "1GigE",
        "function": "GE1",
        "serialNumber": 1,
        "consumablePercent": 100,
        "bitRate": "1000 Mbps",
        "isServiceMultiplexing": false,
        "isBundling": false,
        "isAllToOneBundling": false,
        "isVlanBased": false,
        "maxPacketVirtualNetworkCount": 1,
        "connectivityDesign": {
            "connectivityDesignVersion": 1,
            "startDate": "2022-04-05T10:05:07.160Z",
            "status": "IN_PROGRESS",
            "asideTerminationPointId": "750013",
            "zsideTerminationPointId": "750014",
            "aendLocation": {
                "id": "BAT01HYDB_HDFC2 HYDERABAD IN",
                "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01HYDB_HDFC2 HYDERABAD IN",
                "name": "BAT01HYDB_HDFC2 HYDERABAD IN",
                "@referredType": "PropertyLocation"
            },
            "zendLocation": {
                "id": "BAT01HYDB_12.001",
                "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01HYDB_12.001",
                "name": "BAT01HYDB_12.001",
                "@referredType": "NetworkEntityCode"
            },
            "asideInterface": {
                "id": "20-1GigE-225005-1-1",
                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-1GigE-225005-1-1",
                "@type": "DeviceInterface"
            }
            "paths": [
                {
                    "label": "Path 1",
                    "segments": [
                        {
                            "segmentNumber": "1",
                            "isGap": true,
                            "gapAccepted": false
                        }
                    ]
                }
            ]
        }
    }

Assign FlowIdentifiers on A and Z side on Connectivity Design Version

Example of Request Body

Merge patch:

{
    "@type": "Connectivity",
    "connectivityDesign": {
        "asideFlowIdentifiers": [
                {
                    "id": "28-FI_Domain#SP-VLAN#20",
                    "@type": "FlowIdentifier"
                }
            ] 
    }
}

JSON patch:

[
    {
        "op": "add",
        "path": "/connectivityDesign",
        "value": {
            "asideFlowIdentifiers": {
                "id": "28-FI_Domain#SP-VLAN#20",
                "@type": "FlowIdentifier"
            }
        }
    }
]

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the connectivity details for a given ID after performing a patch.

{
        "id": "31-750007",
        "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-750007",
        "@type": "Connectivity",
        "@baseType": "LogicalResource",
        "resourceVersion": "1",
        "lifecycleState": "INSTALLED",
        "lifecycleSubState": "PENDING_ASSIGN",
        "startOperatingDate": "2022-04-05T10:05:06.858Z",
        "endOperatingDate": "2038-01-19T08:44:07.000Z",
        "resourceRelationship": [],
        "resourceCharacteristic": [
            {
                "name": "isCeVlanCosPreservation",
                "valueType": "BOOLEAN",
                "value": "true",
                "characteristicRelationship": []
            },
            {
                "name": "isCeVlanIdPreservation",
                "valueType": "BOOLEAN",
                "value": "true",
                "characteristicRelationship": []
            },
            {
                "name": "macLayer",
                "valueType": "ALPHANUMERIC",
                "value": "IEEE 802.3-2005",
                "characteristicRelationship": []
            },
            {
                "name": "uniType",
                "valueType": "ALPHANUMERIC",
                "value": "Type 1.1",
                "characteristicRelationship": []
            },
            {
                "name": "numberOfLinks",
                "valueType": "ALPHANUMERIC",
                "value": "1",
                "characteristicRelationship": []
            }
        ],
        "resourceSpecification": {
            "id": "UNI Connectivity",
            "href": "http://hostname:port/InventoryRSOpenAPI/specification/UNI%20Connectivity",
            "name": "UNI Connectivity",
            "version": "1",
            "entityType": "Pipe",
            "startDate": "2021-12-22T00:00:01.000Z",
            "endDate": "2038-01-19T08:44:07.000Z"
        },
        "connectivityIdentifier": "BAT01HYDB_12.001 / BAT01HYDB_HDFC2 HYDERABAD IN / 1GigE / GE1 / 1",
        "technology": "Ethernet",
        "identificationFormat": "LOCATION_BASED",
        "aendLocation": {
            "id": "BAT01HYDB_HDFC2 HYDERABAD IN",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01HYDB_HDFC2 HYDERABAD IN",
            "name": "BAT01HYDB_HDFC2 HYDERABAD IN",
            "@referredType": "PropertyLocation"
        },
        "zendLocation": {
            "id": "BAT01HYDB_12.001",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01HYDB_12.001",
            "name": "BAT01HYDB_12.001",
            "@referredType": "NetworkEntityCode"
        },
        "rateCode": "1GigE",
        "function": "GE1",
        "serialNumber": 1,
        "consumablePercent": 100,
        "bitRate": "1000 Mbps",
        "isServiceMultiplexing": false,
        "isBundling": false,
        "isAllToOneBundling": false,
        "isVlanBased": false,
        "maxPacketVirtualNetworkCount": 1,
        "connectivityDesign": {
            "connectivityDesignVersion": 1,
            "startDate": "2022-04-05T10:05:07.160Z",
            "status": "IN_PROGRESS",
            "asideTerminationPointId": "750013",
            "zsideTerminationPointId": "750014",
            "aendLocation": {
                "id": "BAT01HYDB_HDFC2 HYDERABAD IN",
                "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01HYDB_HDFC2 HYDERABAD IN",
                "name": "BAT01HYDB_HDFC2 HYDERABAD IN",
                "@referredType": "PropertyLocation"
            },
            "zendLocation": {
                "id": "BAT01HYDB_12.001",
                "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01HYDB_12.001",
                "name": "BAT01HYDB_12.001",
                "@referredType": "NetworkEntityCode"
            },
            "asideInterface": {
                "id": "20-1GigE-225005-1-1",
                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-1GigE-225005-1-1",
                "@type": "DeviceInterface"
            },
            "zsideInterface": {
                "id": "20-1GigE-225011-1-1",
                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-1GigE-225011-1-1",
                "@type": "DeviceInterface"
            },
            "asideFlowIdentifiers": [
                {
                    "id": "28-FI_Domain#SP-VLAN#20",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/28-FI_Domain%23SP-VLAN%2320",
                    "@type": "FlowIdentifier"
                }
            ]
            "paths": [
                {
                    "label": "Path 1",
                    "segments": [
                        {
                            "segmentNumber": "1",
                            "isGap": true,
                            "gapAccepted": false
                        }
                    ]
                }
            ]
        }
    }

Assign Connectivity Segment for connectivity enablement in Connectivity Design Version

Example of Request Body

Merge patch:

{
        "@type": "Connectivity",
        "connectivityDesign": {
             "paths": [
            {
                "label": "Path 1",
                "segments": [
                    {
                        "segmentNumber": "1",
                        "segmentRef": {
                            "id": "31-750007",
                            "@type": "Connectivity"
                        }
                    }
                ]
            }
        ]
        }      
}

JSON patch:

[
    {
        "op": "add",
        "path": "/connectivityDesign",
        "value": {
            "paths": [
                {
                    "label": "Path 1",
                    "segments": [
                        {
                            "segmentNumber": "1",
                            "segmentRef": {
                                "id": "31-750007",
                                "@type": "Connectivity"
                            }
                        }
                    ]
                }
            ]
        }
    }
]

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the connectivity details for a given ID after performing a patch.

{
        "id": "31-750002",
        "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-750002",
        "@type": "Connectivity",
        "@baseType": "LogicalResource",
        "resourceVersion": "1",
        "lifecycleState": "INSTALLED",
        "lifecycleSubState": "UNASSIGNED",
        "startOperatingDate": "2022-04-05T09:58:43.307Z",
        "endOperatingDate": "2038-01-19T08:44:07.000Z",
        "resourceRelationship": [],
        "resourceCharacteristic": [
            {
                "name": "uniType",
                "valueType": "ALPHANUMERIC",
                "value": "Type 1.1",
                "characteristicRelationship": []
            },
            {
                "name": "numberOfLinks",
                "valueType": "ALPHANUMERIC",
                "value": "1",
                "characteristicRelationship": []
            },
            {
                "name": "isCeVlanCosPreservation",
                "valueType": "BOOLEAN",
                "value": "true",
                "characteristicRelationship": []
            },
            {
                "name": "isCeVlanIdPreservation",
                "valueType": "BOOLEAN",
                "value": "true",
                "characteristicRelationship": []
            },
            {
                "name": "macLayer",
                "valueType": "ALPHANUMERIC",
                "value": "IEEE 802.3-2005",
                "characteristicRelationship": []
            }
        ],
        "resourceSpecification": {
            "id": "UNI Connectivity",
            "href": "http://hostname:port/InventoryRSOpenAPI/specification/UNI%20Connectivity",
            "name": "UNI Connectivity",
            "version": "1",
            "entityType": "Pipe",
            "startDate": "2021-12-22T00:00:01.000Z",
            "endDate": "2038-01-19T08:44:07.000Z"
        },
        "connectivityIdentifier": "BAT01BANG_12.001 / BAT01BANG_HDFC1 BANGLORE IN / 1GigE / GE1 / 1",
        "technology": "Ethernet",
        "identificationFormat": "LOCATION_BASED",
        "aendLocation": {
            "id": "BAT01BANG_HDFC1 BANGLORE IN",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01BANG_HDFC1 BANGLORE IN",
            "name": "BAT01BANG_HDFC1 BANGLORE IN",
            "@referredType": "PropertyLocation"
        },
        "zendLocation": {
            "id": "BAT01BANG_12.001",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01BANG_12.001",
            "name": "BAT01BANG_12.001",
            "@referredType": "NetworkEntityCode"
        },
        "rateCode": "1GigE",
        "function": "GE1",
        "serialNumber": 1,
        "consumablePercent": 100,
        "bitRate": "1000 Mbps",
        "isServiceMultiplexing": false,
        "isBundling": false,
        "isAllToOneBundling": false,
        "isVlanBased": false,
        "maxPacketVirtualNetworkCount": 1,
        "connectivityDesign": {
            "connectivityDesignVersion": 1,
            "startDate": "2022-04-05T09:58:44.181Z",
            "status": "IN_PROGRESS",
            "asideTerminationPointId": "750004",
            "zsideTerminationPointId": "750003",
            "aendLocation": {
                "id": "BAT01BANG_HDFC1 BANGLORE IN",
                "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01BANG_HDFC1 BANGLORE IN",
                "name": "BAT01BANG_HDFC1 BANGLORE IN",
                "@referredType": "PropertyLocation"
            },
            "zendLocation": {
                "id": "BAT01BANG_12.001",
                "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01BANG_12.001",
                "name": "BAT01BANG_12.001",
                "@referredType": "NetworkEntityCode"
            },
            "zsideInterface": {
                "id": "20-1GigE-225008-1-1",
                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-1GigE-225008-1-1",
                "@type": "DeviceInterface"
            },
            "zsideFlowIdentifiers": [
                {
                    "id": "28-FI_Domain#SP-VLAN#23",
                    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/28-FI_Domain%23SP-VLAN%2323",
                    "@type": "FlowIdentifier"
                }
            ],
            "paths": [
                {
                    "label": "Path 1",
                    "segments": [
                        {
                            "segmentNumber": "1",
                            "isGap": true,
                            "gapAccepted": false
                        },
                        {
                            "segmentNumber": "2",
                            "asideInterface": {
                                "id": "20-1GigE-225005-1-1",
                                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-1GigE-225005-1-1",
                                "@type": "DeviceInterface"
                            },
                            "segmentRef": {
                                "id": "31-750007",
                                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-750007",
                                "@type": "Connectivity",
                                "connectivityIdentifier": "BAT01HYDB_12.001 / BAT01HYDB_HDFC2 HYDERABAD IN / 1GigE / GE1 / 1"
                            },
                            "zsideInterface": {
                                "id": "20-1GigE-225011-1-1",
                                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-1GigE-225011-1-1",
                                "@type": "DeviceInterface"
                            }
                        },
                        {
                            "segmentNumber": "3",
                            "isGap": true,
                            "gapAccepted": false
                        }
                    ]
                }
            ]
        }
    }

Assign Pipe Segment for connectivity enablement in Connectivity Design Version

Example of Request Body

Merge patch:

{
        "@type": "Connectivity",
        "connectivityDesign": {
            "terminateAtFlowInterface":true,
             "paths": [
            {
                "label": "Path 1",
                "segments": [
                    {
                        "segmentNumber": "1",
                        "segmentRef": {
                            "id": "30-PipeDWDM-01",
                            "@type": "Pipe"
                        }
                    }
                ]
            }
        ]
        }

}

JSON patch:

[
    {
        "op": "add",
        "path": "/connectivityDesign",
        "value": {
            "paths": [
                {
                    "label": "Path 1",
                    "segments": [
                        {
                            "segmentNumber": "1",
                            "segmentRef": {
                                "id": "30-PipeDWDM-01",
                                "@type": "Pipe"
                            }
                        }
                    ]
                }
            ]
        }
    }
]

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the connectivity details for a given ID after performing a patch.

{
    "id": "31-750002",
    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-750002",
    "@type": "Connectivity",
    "@baseType": "LogicalResource",
    "resourceVersion": "1",
    "lifecycleState": "INSTALLED",
    "lifecycleSubState": "UNASSIGNED",
    "startOperatingDate": "2022-04-05T09:58:43.307Z",
    "endOperatingDate": "2038-01-19T08:44:07.000Z",
    "resourceRelationship": [],
    "resourceCharacteristic": [
        {
            "name": "uniType",
            "valueType": "ALPHANUMERIC",
            "value": "Type 1.1",
            "characteristicRelationship": []
        },
        {
            "name": "numberOfLinks",
            "valueType": "ALPHANUMERIC",
            "value": "1",
            "characteristicRelationship": []
        },
        {
            "name": "isCeVlanCosPreservation",
            "valueType": "BOOLEAN",
            "value": "true",
            "characteristicRelationship": []
        },
        {
            "name": "isCeVlanIdPreservation",
            "valueType": "BOOLEAN",
            "value": "true",
            "characteristicRelationship": []
        },
        {
            "name": "macLayer",
            "valueType": "ALPHANUMERIC",
            "value": "IEEE 802.3-2005",
            "characteristicRelationship": []
        }
    ],
    "resourceSpecification": {
        "id": "UNI Connectivity",
        "href": "http://hostname:port/InventoryRSOpenAPI/specification/UNI%20Connectivity",
        "name": "UNI Connectivity",
        "version": "1",
        "entityType": "Pipe",
        "startDate": "2021-12-22T00:00:01.000Z",
        "endDate": "2038-01-19T08:44:07.000Z"
    },
    "connectivityIdentifier": "BAT01BANG_12.001 / BAT01BANG_HDFC1 BANGLORE IN / 1GigE / GE1 / 1",
    "technology": "Ethernet",
    "identificationFormat": "LOCATION_BASED",
    "aendLocation": {
        "id": "BAT01BANG_HDFC1 BANGLORE IN",
        "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01BANG_HDFC1 BANGLORE IN",
        "name": "BAT01BANG_HDFC1 BANGLORE IN",
        "@referredType": "PropertyLocation"
    },
    "zendLocation": {
        "id": "BAT01BANG_12.001",
        "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01BANG_12.001",
        "name": "BAT01BANG_12.001",
        "@referredType": "NetworkEntityCode"
    },
    "rateCode": "1GigE",
    "function": "GE1",
    "serialNumber": 1,
    "consumablePercent": 100,
    "bitRate": "1000 Mbps",
    "isServiceMultiplexing": false,
    "isBundling": false,
    "isAllToOneBundling": false,
    "isVlanBased": false,
    "maxPacketVirtualNetworkCount": 1,
    "connectivityDesign": {
        "connectivityDesignVersion": 1,
        "startDate": "2022-04-05T09:58:44.181Z",
        "status": "IN_PROGRESS",
        "asideTerminationPointId": "750004",
        "zsideTerminationPointId": "750003",
        "aendLocation": {
            "id": "BAT01BANG_HDFC1 BANGLORE IN",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01BANG_HDFC1 BANGLORE IN",
            "name": "BAT01BANG_HDFC1 BANGLORE IN",
            "@referredType": "PropertyLocation"
        },
        "zendLocation": {
            "id": "BAT01BANG_12.001",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/BAT01BANG_12.001",
            "name": "BAT01BANG_12.001",
            "@referredType": "NetworkEntityCode"
        },
        "zsideInterface": {
            "id": "20-1GigE-225008-1-1",
            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-1GigE-225008-1-1",
            "@type": "DeviceInterface"
        },
        "zsideFlowIdentifiers": [
            {
                "id": "28-FI_Domain#SP-VLAN#23",
                "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/28-FI_Domain%23SP-VLAN%2323",
                "@type": "FlowIdentifier"
            }
        ],
        "paths": [
            {
                "label": "Path 1",
                "segments": [
                    {
                        "segmentNumber": "1",
                        "isGap": true,
                        "gapAccepted": false
                    },
                    {
                        "segmentNumber": "2",
                        "segmentRef": {
                            "id": "30-PipeDWDM-01",
                            "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/30-PipeDWDM-01",
                            "@type": "Pipe"
                        }
                    },
                    {
                        "segmentNumber": "3",
                        "isGap": true,
                        "gapAccepted": false
                    }
                ]
            }
        ]
    }
}

Accept Gap to enable connectivity in Connectivity Design Version

Example of Request Body

Merge patch:

{
    "@type": "Connectivity",
    "connectivityDesign": {
        "paths": [
            {
                "label": "Path 1",
                "segments": [
                    {
                        "segmentNumber": "1",
                        "isGap": true,
                        "gapAccepted": true
                    }
                ]
            }
        ]
    }
}

JSON patch:

[
    {
        "op": "add",
        "path": "/connectivityDesign",
        "value": {
            "paths": [
                {
                    "label": "Path 1",
                    "segments": [
                        {
                            "segmentNumber": "1",
                            "isGap": true,
                            "gapAccepted": true
                        }
                    ]
                }
            ]
        }
    }
]

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the connectivity details for a given ID after performing a patch.

{
    "id": "31-225007",
    "href": "http://localhost:7001/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-225007",
    "@type": "Connectivity",
    "@baseType": "LogicalResource",
    "resourceVersion": "1",
    "lifecycleState": "INSTALLED",
    "lifecycleSubState": "UNASSIGNED",
    "startOperatingDate": "2022-02-18T14:35:51.152Z",
    "endOperatingDate": "2038-01-19T08:44:07.000Z",
    "resourceRelationship": [],
    "resourceCharacteristic": [],
    "resourceSpecification": {
        "id": "Channelized Facility",
        "href": "http://localhost:7001/InventoryRSOpenAPI/specification/Channelized%20Facility",
        "name": "Channelized Facility",
        "version": "1",
        "entityType": "Pipe",
        "startDate": "2021-12-22T00:00:01.000Z",
        "endDate": "2038-01-19T08:44:07.000Z"
    },
    "transmissionSignalType": "OPTICAL",
    "connectivityIdentifier": "DEL.D1 / MUMB.M1 / STM4 / SM04 / 1",
    "technology": "SDH",
    "identificationFormat": "LOCATION_BASED",
    "aendLocation": {
        "id": "DEL.D1",
        "href": "http://localhost:7001/InventoryRSOpenAPI/place/DEL.D1",
        "name": "DEL.D1",
        "@referredType": "NetworkEntityCode"
    },
    "zendLocation": {
        "id": "MUMB.M1",
        "href": "http://localhost:7001/InventoryRSOpenAPI/place/MUMB.M1",
        "name": "MUMB.M1",
        "@referredType": "NetworkEntityCode"
    },
    "rateCode": "STM4",
    "function": "SM04",
    "serialNumber": 1,
    "bitRate": "622.08 Mbps",
    "connectivityDesign": {
        "connectivityDesignVersion": 1,
        "startDate": "2022-02-18T14:35:51.548Z",
        "status": "IN_PROGRESS",
        "asideTerminationPointId": "225013",
        "zsideTerminationPointId": "225014",
        "aendLocation": {
            "id": "DEL.D1",
            "href": "http://localhost:7001/InventoryRSOpenAPI/place/DEL.D1",
            "name": "DEL.D1",
            "@referredType": "NetworkEntityCode"
        },
        "zendLocation": {
            "id": "MUMB.M1",
            "href": "http://localhost:7001/InventoryRSOpenAPI/place/MUMB.M1",
            "name": "MUMB.M1",
            "@referredType": "NetworkEntityCode"
        },
        "asideInterface": {
            "id": "20-STM4-1-1",
            "href": "http://localhost:7001/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-STM4-1-1",
            "@type": "DeviceInterface"
        },
        "zsideInterface": {
            "id": "20-STM4-25-1",
            "href": "http://localhost:7001/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/20-STM4-25-1",
            "@type": "DeviceInterface"
        },
        "paths": [
            {
                "label": "Path 1",
                "segments": [
                    {
                        "segmentNumber": "1",
                        "isGap": true,
                        "gapAccepted": true
                    }
                ]
            }
        ]
    }
}

Back to Top