Create connections

28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Create connections

Updated on 28 Oct 2024
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/sections/{section_id}/create_connections/

Operation is used to create new connections. Available from product version 3.4.0.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Path parameters

section_id

integerRequired

Uniquie identifier integer value for the circuit section which you would like to create connections for

Responses

200

List of created Ccp connections

[
  {
    "cableLength": null,
    "ccp1Id": "https://example.keypro.fi/api/v2/ccps/106469810/",
    "ccp1PremId": "https://example.keypro.fi/api/v2/ccps/4545690/",
    "ccp1TermId": "https://example.keypro.fi/api/v2/ccps/3861090/",
    "ccp2Id": "https://example.keypro.fi/api/v2/ccps/106470510/",
    "ccp2PremId": "https://example.keypro.fi/api/v2/ccps/4545710/",
    "ccp2TermId": "https://example.keypro.fi/api/v2/ccps/3861110/",
    "connectionType": {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "available": true,
      "groupname": "KN_CONNECTION_TYPE",
      "id": 6210,
      "list_url": "https://example.keypro.fi/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
      "logical_txt": "Vastinpistekytkentä",
      "num_value": 1.0,
      "num_value2": null,
      "num_value3": null,
      "num_value4": null,
      "txt": "Other end connection"
    },
    "constState": {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "available": true,
      "groupname": "KN_CONST_STATE",
      "id": 6110,
      "list_url": "https://example.keypro.fi/api/v2/txt_constants/groupname/KN_CONST_STATE/",
      "logical_txt": "Rakenteilla",
      "num_value": 4.0,
      "num_value2": 1.0,
      "num_value3": null,
      "num_value4": null,
      "txt": "Under construction"
    },
    "directionId": null,
    "id": 1823750
  },
  {
    "cableLength": null,
    "ccp1Id": "https://example.keypro.fi/api/v2/ccps/106470510/",
    "ccp1PremId": "https://example.keypro.fi/api/v2/ccps/4545710/",
    "ccp1TermId": "https://example.keypro.fi/api/v2/ccps/3861110/",
    "ccp2Id": "https://example.keypro.fi/api/v2/ccps/106471330/",
    "ccp2PremId": "https://example.keypro.fi/api/v2/ccps/4545730/",
    "ccp2TermId": "https://example.keypro.fi/api/v2/ccps/3861130/",
    "connectionType": {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "available": true,
      "groupname": "KN_CONNECTION_TYPE",
      "id": 6210,
      "list_url": "https://example.keypro.fi/api/v2/txt_constants/groupname/KN_CONNECTION_TYPE/",
      "logical_txt": "Vastinpistekytkentä",
      "num_value": 1.0,
      "num_value2": null,
      "num_value3": null,
      "num_value4": null,
      "txt": "Other end connection"
    },
    "constState": {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "available": true,
      "groupname": "KN_CONST_STATE",
      "id": 6110,
      "list_url": "https://example.keypro.fi/api/v2/txt_constants/groupname/KN_CONST_STATE/",
      "logical_txt": "Rakenteilla",
      "num_value": 4.0,
      "num_value2": 1.0,
      "num_value3": null,
      "num_value4": null,
      "txt": "Under construction"
    },
    "directionId": null,
    "id": 1823770
  }
]

Array of object

List of created Ccp connections

object

attenuation

number (float)

Connection attenuation

cableLength

number (float)

Cable length

ccp1Id

string (url)

Url to fetch details of first cross connection point.

ccp1PremId

string (url)

Url to fetch details of first premises.

ccp1TermId

string (url)

Url to fetch details of first terminal.

ccp2Id

string (url)

Url to fetch details of second cross connection point.

ccp2PremId

string (url)

Url to fetch details of second premises.

ccp2TermId

string (url)

Url to fetch details of second terminal.

connectionType

object (CcpConnectionType)

Connection type

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_CONNECTION_TYPE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

constState

object (ConstructionState)

Txt constants construction state

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_CONST_STATE" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

directionId

object (ConnectionDirection)

Connection direction

availability_end_ts

string (date-time)

Ending date time for availability

availability_start_ts

string (date-time)

Beginning date time for availability

available

boolean

Is object deemed as available. Based on availability_start_ts and availability_end_ts values.

groupname

Group name of constant

Valid values[ "KN_CONN_DIR" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

num_value

number (float)

Numeric value

num_value2

number (float)

Numeric value 2

num_value3

number (float)

Numeric value 3

num_value4

number (float)

Numeric value 4

txt

string

Human readable textual representation

integer

Primary key

400

There was an error in request. Usually field validation failed.

object

Fields which failed validation

property*

Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Get cross connection point details