Operation is used to get a list of cross connection points. Available from product version 3.2.8.
Cross connection points can be filtered by giving filtering parameters at HTTP querystring (see parameters).
Token issued for API consumer.
Offset to start returning results.
Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.
Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:
- For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
- For numerics: gt, lt, gte, lte, isnull
- For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby
Examples:
+++usage_state__txt__istartswith=in+++,+++plan__state__txt__startswith=In+++,+++creation_date__gte=2019-01-02T15:32:01+++,+++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples:+++not__type__txt__istartswith=Tie+++,+++not__id=1390+++
Selects the object field to order the returned objects by.
Can be used to sort in reverse order with '-' prefix.
Can have several ordering rules separated by comma.
Can be used only for object own fields and does not supports structured queries.
Example: orderby=creator,-creation_date
A result response object.
{
"Next": null,
"Previous": null,
"Results": [
{
"bitrate": null,
"ccpOwner": null,
"channelType": null,
"connectorNumber": 12,
"connectorType": null,
"constState": {
"availability_end_ts": "2020-12-31",
"availability_start_ts": "2020-01-01",
"available": true,
"groupname": "KN_CONST_STATE",
"id": 6050,
"list_url": "https://keycom.example.fi/api/v2/txt_constants/groupname/KN_CONST_STATE/",
"logical_txt": "Valmis",
"num_value": 10.1,
"num_value2": 20.2,
"num_value3": 30.3,
"num_value4": 40.4,
"txt": "Valmis"
},
"freeStatus": 1,
"functionality": "",
"id": 595250,
"name": "12",
"parent": null,
"priority": null,
"remarks": "",
"services": [
{
"cableLength": null,
"id": 10,
"servicegroups": [
{
"id": 401,
"name": "Test",
"priority": 2,
"remarks": "testaus",
"sprimary": 1
}
],
"technology": {
"availability_end_ts": "2020-12-31",
"availability_start_ts": "2020-01-01",
"available": true,
"groupname": "CABLE_TECHNOLOGY",
"id": 30,
"list_url": "https://keycom.example.fi/api/v2/txt_constants/groupname/CABLE_TECHNOLOGY/",
"logical_txt": "Kuitu",
"num_value": 10.1,
"num_value2": 20.2,
"num_value3": 30.3,
"num_value4": 40.4,
"txt": "Kuitu"
},
"usage": {
"availability_end_ts": "2020-12-31",
"availability_start_ts": "2020-01-01",
"available": true,
"groupname": "USAGE",
"id": 14970,
"list_url": "https://keycom.example.fi/api/v2/txt_constants/groupname/USAGE/",
"logical_txt": "50 VOIP-liittymä",
"num_value": 10.1,
"num_value2": 20.2,
"num_value3": 30.3,
"num_value4": 40.4,
"txt": "50 VOIP-liittymä"
}
}
],
"signalDirection": null,
"startThread": 23,
"subCcpOrder": null,
"subchannelsExist": "",
"technology": 0,
"terminal": "https://keycom.example.fi/api/v2/devices/3390/"
}
],
"Total": 1
}Url to next page of cross connection points. Null if No next page exist
Url to previous page of cross connection points. Null if No previous page exist
List of fetched cross connection points
Bitrate description
Primary key
Bitrate value
Cross connection point owner
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Cross connection point channel type
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Abbreviation
Attenuation
Description
Primary key
Technology id.
Thread count
Txt constants construction state
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Defines if cross connection point is free
Functionality
Primary key
Name of cross connection point
Url to fetch details of parent cross connection point
Cross connection point priority
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Remarks
List of this cross connection point's services
Cable length
Primary key
List of service groups for this service
Primary key
Name of service type group
Priority
Remarks
Sprimary
Cable type technology
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Service usage
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Cross connection point signal direction
Ending date time for availability
Beginning date time for availability
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
Group name of constant
Unique id of constant
Url to fetch all constants from this group
Logical textual value
Numeric value
Numeric value 2
Numeric value 3
Numeric value 4
Human readable textual representation
Start thread
Sub connector order
Defines whether subchannels exist or not
Technology of ccp. 1 for Fiber, 0 for Copper.
url of cross connection point terminal/device
Total number of cross connection points
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}Detailed description of error