LocationResource
LocationResource REST endpoint to access and manipulate specific Location data.
Copyright 2013 WANdisco.
The following resources are part of this group:
- /location/{locationIdentity}
- /location/{locationIdentity}/attributes
- /location/{locationIdentity}/nodes
- /location/{locationIdentity}/startIgnoring/{ignoreLocationIdentity}
/location/{locationIdentity}
Mount Point: /api/location/{locationIdentity}
GET
Returns the LocationDTO with the specified identity if it exists or a 404 not found exception if the element does not exist
Parameters
| name | description | type | default |
|---|---|---|---|
| locationIdentity | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
PUT
Update the route to the Location.
Parameters
| name | description | type | default |
|---|---|---|---|
| locationIdentity | (no documentation provided) | path |
Request Body
| element: | routes |
| media types: | application/xml application/json |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/location/{locationIdentity}/attributes
Mount Point: /api/location/{locationIdentity}/attributes
GET
Returns the LocationAttributesDTO containing Attributes of the specified location.
Parameters
| name | description | type | default |
|---|---|---|---|
| locationIdentity | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
PUT
Update the Location Attributes.
Parameters
| name | description | type | default |
|---|---|---|---|
| locationIdentity | (no documentation provided) | path |
Request Body
| element: | attributes |
| media types: | */* application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/location/{locationIdentity}/nodes
Mount Point: /api/location/{locationIdentity}/nodes
GET
Returns the NodeListDTO containing nodes at the specified identity
Parameters
| name | description | type | default |
|---|---|---|---|
| locationIdentity | (no documentation provided) | path |
Response Body
| element: | (custom) |
| media types: | application/xml application/json |
(no documentation provided)
/location/{locationIdentity}/startIgnoring/{ignoreLocationIdentity}
Mount Point: /api/location/{locationIdentity}/startIgnoring/{ignoreLocationIdentity}
PUT
Parameters
| name | description | type | default |
|---|---|---|---|
| locationIdentity | (no documentation provided) | path | |
| ignoreLocationIdentity | (no documentation provided) | path | |
| checkRemovedNodes | (no documentation provided) | query | true |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)