Get list of Survey files
- 28 Aug 2024
- 15 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get list of Survey files
- Updated on 28 Aug 2024
- 15 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/survey-files/
Operation is used to get a list of Survey files. Available from product version 2024.3.
Survey Files can be filtered by giving filtering parameters at HTTP querystring (see parameters).
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Query parameters
offset
integer
Offset to start returning results.
Minimum0
limit
integer
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.
Minimum1
__any of the object fields__
string
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+++
orderby
string
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
Responses
200
A result response object.
{
"Next": "https://keycore.example.fi/api/v2/survey-file/?offset=1&limit=1",
"Previous": null,
"Results": [
{
"combinePoint": true,
"combinePointNumber": false,
"coordinateOrder": {
"groupname": "COORDINATE_ORDER",
"id": 21,
"listUrl": "https://keycore.example.fi/api/v2/survey-constants/groupname/COORDINATE_ORDER",
"numValue": 2,
"orderno": 2,
"txt": "IPH",
"txtValue": ""
},
"createdBy": "example.user",
"createdDate": "2024-05-14T08:32:26Z",
"fileName": "test.txt",
"hashCode": "73c539a1265ecea4da6e2936a21d3b648da0c683",
"heightAccuracy": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "H_ACCURACY",
"id": 117210,
"list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/H_ACCURACY/",
"logical_txt": "Ei määritelty",
"num_value": 1.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Ei määritelty"
},
"historyDate": "2024-05-14",
"id": 1919021,
"identification": "test",
"inputSrs": "3067",
"kindCode": {
"groupname": "KIND_CODE",
"id": 41,
"listUrl": "https://keycore.example.fi/api/v2/survey-constants/groupname/KIND_CODE",
"numValue": 1,
"orderno": 1,
"txt": "T2",
"txtValue": ""
},
"locationAccuracy": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "LOCATION_ACCURACY",
"id": 8301,
"list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/LOCATION_ACCURACY/",
"logical_txt": "2.0m",
"num_value": 2.0,
"num_value2": null,
"num_value3": null,
"num_value4": 2.0,
"txt": "2.0m"
},
"mapper": "example.mapper",
"mappingConfig": {
"id": 1,
"label": "T3 PIH",
"separator": ""
},
"mappingMethod": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "MAPPING_METHOD",
"id": 390,
"list_url": "http://10.121.8.101:8055/api/v2/txt_constants/groupname/MAPPING_METHOD/",
"logical_txt": "Digitoitu",
"num_value": 4.0,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Digitoitu"
},
"name": "test",
"operator": {
"groupname": "SURVEY_DATA_OPERATOR",
"id": 101,
"listUrl": "https://keycore.example.fi/api/v2/survey-constants/groupname/SURVEY_DATA_OPERATOR",
"numValue": 1,
"orderno": 1,
"txt": "Sonera",
"txtValue": ""
},
"plan": null,
"procedure": {
"groupname": "PROCEDURE",
"id": 101,
"listUrl": "https://keycore.example.fi/api/v2/survey-constants/groupname/PROCEDURE",
"numValue": 2,
"orderno": 2,
"txt": "Create geometries",
"txtValue": ""
},
"processed": true,
"rawText": "0 1 2310 29 6940066.737 662608.394 0.000 0\r\n0 1 2310 30 6940079.681 662633.697 0.000 0\r\n0 1 2310 31 6940091.115 662657.592 0.000 0\r\n0 1 2310 32 6940095.332 662663.369 0.000 0\r\n0 1 2310 33 6940097.127 662666.554 0.000 0\r\n0 1 2310 34 6940097.387 662668.499 0.000 0\r\n0 1 2310 35 6940098.338 662669.326 0.000 0\r\n0 1 2310 36 6940099.784 662672.116 0.000 0\r\n0 1 2310 37 6940100.676 662674.610 0.000 0\r\n0 1 2310 38 6940111.111 662694.414 0.000 0\r\n0 1 2310 39 6940138.112 662744.359 0.000 0\r\n0 1 2310 40 6940144.218 662755.741 0.000 0\r\n0 1 2310 41 6940153.005 662769.017 0.000 0\r\n0 1 2310 42 6940158.065 662775.159 0.000 0\r\n0 1 2310 43 6940160.829 662778.160 0.000 0\r\n0 1 2310 44 6940172.380 662795.760 0.000 0\r\n0 1 2310 45 6940179.898 662807.504 0.000 0\r\n0 1 2310 46 6940196.485 662829.526 0.000 0\r\n0 1 2310 47 6940206.959 662840.947 0.000 0\r\n0 1 2310 48 6940221.305 662854.917 0.000 0\r\n0 1 2310 49 6940238.199 662870.187 0.000 0\r\n0 1 2310 50 6940251.578 662882.408 0.000 0\r\n0 1 2310 51 6940264.041 662891.856 0.000 0\r\n0 1 2310 52 6940273.706 662897.280 0.000 0\r\n0 1 2310 53 6940287.255 662901.589 0.000 0\r\n0 1 2310 54 6940297.418 662903.950 0.000 0\r\n0 1 2310 55 6940310.539 662907.235 0.000 0\r\n0 2 2310 56 6940310.541 662907.197 0.000 0\r\n0 2 2310 57 6940319.398 662910.872 0.000 0\r\n0 2 2310 58 6940323.685 662913.424 0.000 0\r\n0 2 2310 59 6940328.088 662917.001 0.000 0\r\n0 2 2310 60 6940335.853 662923.723 0.000 0\r\n0 2 2310 61 6940339.609 662926.500 0.000 0\r\n0 2 2310 62 6940344.559 662930.090 0.000 0\r\n0 2 2310 63 6940347.224 662930.826 0.000 0\r\n0 2 2310 64 6940349.451 662931.806 0.000 0\r\n0 2 2310 65 6940352.965 662937.173 0.000 0\r\n0 2 2310 66 6940353.703 662938.371 0.000 0\r\n0 2 2310 67 6940352.113 662944.365 0.000 0\r\n0 2 2310 68 6940351.603 662947.021 0.000 0\r\n0 5 2310 75 6940351.574 662947.033 0.000 0\r\n0 5 2310 76 6940352.823 662950.725 0.000 0\r\n0 5 2310 77 6940363.064 662976.966 0.000 0\r\n0 5 2310 78 6940364.156 662977.542 0.000 0\r\n0 6 2511 79 6940364.157 662977.534 0.000 0\r\n0 6 2511 80 6940369.190 662984.543 0.000 0\r\n0 7 2310 81 6940369.183 662984.531 0.000 0\r\n0 7 2310 82 6940370.953 662985.797 0.000 0\r\n0 7 2310 83 6940373.828 662991.002 0.000 0\r\n0 7 2310 84 6940375.777 662998.734 0.000 0\r\n0 7 2310 85 6940376.106 663003.833 0.000 0\r\n0 7 2310 86 6940378.400 663008.731 0.000 0\r\n0 8 2511 87 6940378.421 663008.738 0.000 0\r\n0 8 2511 88 6940390.370 663029.613 0.000 0\r\n0 8 2511 89 6940400.388 663046.025 0.000 0\r\n0 8 2511 90 6940402.650 663047.581 0.000 0\r\n0 8 2511 91 6940405.137 663047.422 0.000 0\r\n0 8 2511 92 6940414.741 663063.170 0.000 0\r\n0 8 2511 93 6940415.037 663065.416 0.000 0\r\n0 8 2511 94 6940416.103 663069.682 0.000 0\r\n0 8 2511 95 6940419.641 663077.178 0.000 0\r\n0 8 2511 96 6940428.695 663094.293 0.000 0\r\n0 8 2511 97 6940435.714 663105.237 0.000 0\r\n0 8 2511 98 6940441.397 663114.925 0.000 0\r\n0 8 2511 99 6940445.110 663119.128 0.000 0\r\n0 8 2511 100 6940449.167 663122.871 0.000 0\r\n0 8 2511 101 6940457.013 663126.287 0.000 0\r\n0 8 2511 102 6940460.522 663127.156 0.000 0\r\n0 8 2511 103 6940462.288 663126.532 0.000 0\r\n0 8 2511 104 6940463.244 663123.771 0.000 0\r\n0 8 2511 105 6940463.028 663122.462 0.000 0",
"srid": 3067,
"surveyAmount": 10,
"updatedBy": "example.user",
"updatedDate": "2024-05-14T08:32:26Z"
}
],
"Total": 1
}object
Next
string (url)
Url to next page of Survey File list. Null if No next page exist
Prev
string (url)
Url to previous page of Survey File list. Null if No previous page exist
Results
Array of object (SurveyFile)
List of fetched Survey File
object
SurveyFile
combinePoint
boolean
Is survey file processed to have combined point
combinePointNumber
boolean
Is survey file processed to have combined point number
coordinateOrder
object (CoordinateOrder)
Coordinate Order
groupname
Group name of constant
Valid values[ "COORDINATE_ORDER" ]
id
integer
Unique id of constant
listUrl
string (url)
Url to fetch all contants from this group
numValue
integer
Numeric value
orderno
integer
Order number
txt
string
Human readable textual representation
txtValue
string
Text value
createdBy
string
created by user
createdDate
string (date-time)
created date
fileName
string
file name attached to the survey file
hashCode
string
hash code of the file attached to the survey file
heightAccuracy
object (HeightAccuracy)
Height accuracy
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[ "H_ACCURACY" ]
id
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
historyDate
string (date)
history date of survey file
id
integer
Unique id of survey file
identification
string
identification of survey file
inputSrs
string
input srs of the survey file
kindCode
object (KindCode)
Kind Code
groupname
Group name of constant
Valid values[ "KIND_CODE" ]
id
integer
Unique id of constant
listUrl
string (url)
Url to fetch all contants from this group
numValue
integer
Numeric value
orderno
integer
Order number
txt
string
Human readable textual representation
txtValue
string
Text value
locationAccuracy
object (LocationAccuracy)
Location accuracy
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[ "LOCATION_ACCURACY" ]
id
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
mapper
string
Mapper of the survey file
mappingConfig
object (MappingConfig)
id
integer
Primary key
label
string
Mapping config label
separator
string
Mapping config separator
mappingMethod
object (MappingMethod)
Mapping method
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[ "MAPPING_METHOD" ]
id
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
name
string
name of survey file
operator
object (Operator)
Operator
groupname
Group name of constant
Valid values[ "SURVEY_DATA_OPERATOR" ]
id
integer
Unique id of constant
listUrl
string (url)
Url to fetch all contants from this group
numValue
integer
Numeric value
orderno
integer
Order number
txt
string
Human readable textual representation
txtValue
string
Text value
plan
object (Plan)
Plan
Branch_line
object (DHCPDN)
District Heating Consumer Point Duct Diameter
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[ "DH_CP_DN" ]
id
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
Center_measure
object (DHCPDN)
District Heating Consumer Point Duct Diameter
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[ "DH_CP_DN" ]
id
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
Construction
object (PlanConstruction)
Plan Construction
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[ "PLAN_CONSTRUCTION" ]
id
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
Excavation
object (PlanExcavation)
Plan Excavation
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[ "PLAN_EXCAVATION" ]
id
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
Limiter
object (DHCPLimiter)
District Heating Consumer Point Limiter
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[ "DH_CP_LIMITER" ]
id
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
Plan_piping
object (PlanPiping)
Plan Piping
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[ "PLAN_PIPING" ]
id
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
agreed_delivery_date
string (date-time)
Agreed Delivery Date. Activated on request by customer.
area_description
string
Area Description. Activated on request by customer.
begin_date
string (date-time)
Begin Date
construction_year
integer
Contact Name. Not shown when displaying plan details in related objects. Activated on request by customer.
contact_email
string
Contact Email Address. Activated on request by customer.
contact_name
string
Contact Name. Activated on request by customer.
contact_phone
string
Contact phone number. Activated on request by customer.
cp_identification
string
Consumer Point Identification. Activated on request by customer.
created_by
string
Created by
created_date
string (date-time)
Create Date
customer_contact_date
string (date-time)
Customer Contact Date. Activated on request by customer.
description
string
Description
desired_delivery_date
string (date-time)
Desired Delivery Date. Activated on request by customer.
district_area
object (DistrictArea)
District Area
location
string (ewkt)
Geographical location as EWKT representation
name
string
Name of District Area
duration
integer
Duration. Activated on request by customer.
expire_date
string (date-time)
Expire Date
first_contact
string
First contact person for plan. Not shown when displaying plan details in related objects. Activated on request by customer.
id
integer
Unique id of plan
implementation_begin_end
string (date-time)
Implementation Date. Activated on request by customer.
implementation_date
string (date)
Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.
latest_implementation_date
string (date)
Latest Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.
list_url
string (url)
URL to the list of all Plans. Only shown when displaying plan details in related objects.
location
string (ewkt)
Geographical location. As EWKT representation
louhi_id
string
Louhi ID. Activated on request by customer.
modifications
string
Modifications. Not shown when displaying plan details in related objects. Activated on request by customer.
name
string
Name of Plan
network
object (PlanNetworkType)
Plan Network 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[ "PLAN_NETWORK_TYPE" ]
id
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
network_owner
object (PlanNetworkOwner)
Plan Network Owner
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[ "PLAN_NETWORK_OWNER" ]
id
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
offer_accepted_date
string (date-time)
Offer Accepted Date. Activated on request by customer.
offer_id
string
Offer ID. Activated on request by customer.
parentplan
string (url)
URL to the plan of which the plan is part of (subplan). Available from version 3.2.24. Activated on request by customer.
plan_remark
string
Plan remark. Not shown when displaying plan details in related objects. Activated on request by customer.
plumbing_start_date
string (date-time)
Plumbing Start Date. Activated on request by customer.
property_address
string
Property address. Not shown when displaying plan details in related objects. Activated on request by customer.
publicity
object (PlanPublicity)
Plan Publicity
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[ "PLAN_PUBLICITY" ]
id
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
state
object (PlanState)
Plan 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[ "PLAN_STATE" ]
id
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
total_cost
number (float)
Sum of cost for all related objects for the plan. Not shown when displaying plan details in related objects. Activated on request by customer.
type
object (PlanType)
Plan 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[ "PLAN_TYPE" ]
id
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
updated_by
string
Updated by
updated_date
string (date-time)
Update Date
work_activities
string
Work Activities. Activated on request by customer.
work_phase
object (PlanWorkPhase)
Plan Work Phase
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[ "PLAN_WORK_PHASE" ]
id
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
work_project
string
Work Project. Activated on request by customer.
work_type
object (PlanWorkType)
Plan Work 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[ "PLAN_WORK_TYPE" ]
id
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
work_type_main
object (PlanWorkTypeMain)
Plan Work Type Main
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[ "PLAN_WORK_TYPE_MAIN" ]
id
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
work_type_sub
object (PlanWorkTypeSub)
Plan Work Type Sub
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[ "PLAN_WORK_TYPE_SUB" ]
id
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
procedure
object (Procedure)
Procedure
groupname
Group name of constant
Valid values[ "PROCEDURE" ]
id
integer
Unique id of constant
listUrl
string (url)
Url to fetch all contants from this group
numValue
integer
Numeric value
orderno
integer
Order number
txt
string
Human readable textual representation
txtValue
string
Text value
processed
boolean
Is survey file processed or not
rawText
string
raw text of the file attached to the survey file
srid
integer
Srid of the survey file
surveyAmount
integer
Amount of surveys in the file
updatedBy
string
updated by user
updatedDate
string (date-time)
updated date
Total
integer
Total number of Survey File in the list
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
