View a Location
get
/api/restapi/location/{locationId}
This endpoint returns locations that meet the following requirements:
- The object has an ID that matches the value of the {locationId} path parameter.
Request
Path Parameters
-
locationId(required): integer(int64)
ID of the Location to be found.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityLocation
Type:
object
Title:
Show Source
ApiEntityLocation
-
addressLine1: string
Minimum Length:
0
Maximum Length:200
The first line of the address of a location.
This might be the building number and street address. -
addressLine2: string
Minimum Length:
0
Maximum Length:200
The second line of the address of a location.
This might be a neighborhood or town. -
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the location and the workspace. Possible values are Owned and Inherited. -
cityName: string
Minimum Length:
0
Maximum Length:200
The city name for a location. -
countryCode: string
Minimum Length:
0
Maximum Length:3
The country for a location. The value is expressed as a three letter code. -
description: string
Minimum Length:
0
Maximum Length:4000
Additional details about the location. -
latitude: number
(double)
Minimum Value:
-90
Maximum Value:90
The geographical coordinate for the latitude of the location.
The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
locationCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier of the location. -
locationId: integer
(int64)
The unique identifier for the location.
-
locationName: string
Minimum Length:
1
Maximum Length:255
A name for the location that your users will understand and recognize. -
longitude: number
(double)
Minimum Value:
-180
Maximum Value:180
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
postalCode: string
Minimum Length:
0
Maximum Length:20
The postal code, post code, or zip code of a location. -
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the location. -
stateCode: string
Minimum Length:
0
Maximum Length:2
A unique identifier for the state or province. -
stateName: string
Minimum Length:
0
Maximum Length:200
The state, region, or province of a location. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
404 Response
The requested location does not exist, or you do not have access to it.