Get the location plan defined in a project.
get
/connectedWorker/clientapi/v2/orgs/{orgId}/projects/{projectId}/locationPlans/{locationPlanId}
This operation retrieves the location plan of a specific project.
Request
Path Parameters
-
locationPlanId: string
Location plan identifier
-
orgId: string
Organization identifier
-
projectId: string
Project identifier
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Location plan was successfully retrieved.
Root Schema : LocationPlan
Type:
Show Source
object
-
description(optional):
string
Description of the location planExample:
My location plan description
-
id(optional):
string
Read Only:
true
The unique id of the objectExample:53
-
imageP1:
string
First point of the picture, to pin the image to the mapP1Example:
39.215302, 26.308674
-
imageP2:
string
Second point of the picture, to pin the image to the mapP2Example:
39.215302, 26.308674
-
links(optional):
array links
-
mapP1:
string
First geoPoint (latitude, longitude) in the map, to place the image of the location planExample:
39.215302, 26.308674
-
mapP2:
string
Second geoPoint (latitude, longitude) in the map, to place the image of the location planExample:
39.215302, 26.308674
-
name:
string
Minimum Length:
0
Maximum Length:255
Name of the location plan. Max length is 255 charactersExample:My location plan name
Nested Schema : Link
Type:
Show Source
object
-
href:
string
The target resource's URI
-
rel:
string
Relation type