1. REST API for Unified Inventory Management
  2. Tasks
  3. Resource
  4. Connectivity

Process a Connectivity

post

/connectivity/{connectivityIdentifier}/{task}

This operation performs an action denoted by task on latest Connectivity design version of given connectivity Id (or identifier). Supported tasks are COMPLETE and CANCEL. These can be used to complete a design version or cancel it respectively.
NOTE: {connectivityIdentifier} in path parameter can be connectivityIdentifier or Id of the connectivity. Process a Connectivity Design version is an explicit operation for Connectivity resource. Hence, these task APIs are not supported on '/resource' URL.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The Connectivity was processed successfully.
Body ()
Root Schema : schema
A Connectivity resource.
Match All
Show Source
Nested Schema : schema
A pipe resource.
Match All
Show Source
Nested Schema : LogicalResource
Type: object
The base class for logical resources.
Match All
Show Source
Nested Schema : Discriminator: @type
Type: object
A base resource Class.
Show Source
Nested Schema : LogicalResource-allOf[1]
Type: object
Nested Schema : type
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : CapacityConsumed
Type: object
Consumed capacity of pipe.
Show Source
Nested Schema : CapacityProvided
Type: object
A capacity provided.
Show Source
Nested Schema : CapacityRequired
Type: object
Required capacity of pipe.
Show Source
Nested Schema : pipeDirectionalityRef
Type: array
The list of pipe directionalities.
Show Source
Nested Schema : PipeEnablement
Type: object
Segment details that are enabling current Connectivity.
Show Source
Nested Schema : roles
Type: array
The list of pipe inventory roles.
Show Source
Nested Schema : PipeDirectionality
Type: object
A Pipe Directionality .
Show Source
Nested Schema : pipeSegmentRef
Type: array
The list of pipe segments.
Show Source
Nested Schema : Segment
Type: object
Segment details that are enabling current Connectivity.
Show Source
Nested Schema : flowIdentifiers
Type: array
Show Source
Nested Schema : segmentRef
Match One Schema
Show Source
Nested Schema : schema
A flow identifier.
Match All
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : schema
A network address domain.
Match All
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : RelatedPartyRef
Type: object
A related party, which defines a party or party role linked to a specific entity.
Show Source
Nested Schema : PlaceRef
Type: object
A place to associate with the resource/service.
Show Source
Nested Schema : ConnectivityDesign
Type: object
Gives the details of latest connectivity design version.
Show Source
Nested Schema : asideFlowIdentifiers
Type: array
Show Source
Nested Schema : paths
Type: array
Show Source
Nested Schema : zsideFlowIdentifiers
Type: array
Show Source
Nested Schema : ConnectivityPath
Type: object
Paths that are enabling current Connectivity.
Show Source
Nested Schema : segments
Type: array
Show Source
Nested Schema : Role
Type: object
A role.
Show Source

400 Response

The request isn't valid.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

401 Response

You aren't authorized to make this request.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

403 Response

The request is forbidden.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

404 Response

The resources wasn't found.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source

500 Response

An internal server error occurred.
Body ()
Root Schema : Error
Type: object
Used when an API throws an error. This is typically used with HTTP error response codes (3xx, 4xx, 5xx).
Show Source
  • The error code.
  • Allowed Values: [ "CustomObject", "CustomNetworkAddress", "DeviceInterface", "Equipment", "EquipmentHolder", "FlowIdentifier", "GeographicLocation", "GeographicSite", "GeographicAddress", "PropertyLocation", "LogicalDevice", "LogicalDeviceAccount", "MediaStream", "Network", "PhysicalConnector", "PhysicalDevice", "PhysicalPort", "Pipe", "Service", "TelephoneNumber", "IPV4Address", "IPV6Address", "IPSubnet", "NetworkAddressDomain", "Connectivity", "Party" ]
    The list of valid values for an entity class.
  • message
    The text that provides more details about the error as well as corrective actions.
  • The short, user-friendly summary of the problem, which does not change for subsequent occurrences of the problem.
  • The URL pointing to the documentation that describes the error.
  • The HTTP error code extension, such as 400-2.
Nested Schema : message
Type: array
The text that provides more details about the error as well as corrective actions.
Show Source
Back to Top

Examples

This example shows how to perform an action on latest connectivity design version of given connectivity ID and task by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Install and Use cURL".

cURL Command

curl -X POST "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/version/connectivity/ID/task" -H credentials

where:

  • hostname is the URL for the UIM REST server.
  • port is the port for the UIM REST server.
  • version is the version of the API you're using.
  • credentials is the base64 encoding of the user ID and password joined by a single colon (ID:password). See "Authentication and Authorization".
  • ID is the id of the connectivity to process.
  • task is the action to be performed on the latest connectivity design version..

Example of Response Body

This example shows the contents of the response body in JSON format. It shows the full details for a connectivity after processing the latest connectivity design version.

{
    "id": "31-225005",
    "href": "http://hostname:port/InventoryRSOpenAPI/resourceInventoryManagement/v3/resource/31-225005",
    "@type": "Connectivity",
    "@baseType": "LogicalResource",
    "resourceVersion": "1",
    "lifecycleState": "INSTALLED",
    "lifecycleSubState": "UNASSIGNED",
    "startOperatingDate": "2022-02-17T18:50:47.595Z",
    "endOperatingDate": "2038-01-19T08:44:07.000Z",
    "resourceRelationship": [],
    "resourceCharacteristic": [],
    "resourceSpecification": {
        "id": "Channelized Facility",
        "href": "http://hostname:port/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": "ELECTRICAL",
    "connectivityIdentifier": "HYD / HYD / STS1 / ST01 / 2",
    "technology": "SONET",
    "identificationFormat": "LOCATION_BASED",
    "aendLocation": {
        "id": "HYD",
        "href": "http://hostname:port/InventoryRSOpenAPI/place/HYD",
        "name": "HYD",
        "@referredType": "PropertyLocation"
    },
    "zendLocation": {
        "id": "HYD",
        "href": "http://hostname:port/InventoryRSOpenAPI/place/HYD",
        "name": "HYD",
        "@referredType": "PropertyLocation"
    },
    "rateCode": "STS1",
    "function": "ST01",
    "serialNumber": 2,
    "bitRate": "51.84 Mbps",
    "connectivityDesign": {
        "connectivityDesignVersion": 1,
        "startDate": "2022-02-18T13:46:47.346Z",
        "status": "COMPLETED",
        "asideTerminationPointId": "225010",
        "zsideTerminationPointId": "225009",
        "aendLocation": {
            "id": "HYD",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/HYD",
            "name": "HYD",
            "@referredType": "PropertyLocation"
        },
        "zendLocation": {
            "id": "HYD",
            "href": "http://hostname:port/InventoryRSOpenAPI/place/HYD",
            "name": "HYD",
            "@referredType": "PropertyLocation"
        },
        "paths": [
            {
                "label": "Path 1",
                "segments": [
                    {
                        "segmentNumber": "1",
                        "isGap": true,
                        "gapAccepted": true
                    }
                ]
            }
        ]
    }
}
Back to Top