Get resource locations

get

/rest/ofscCore/v1/resources/{resourceId}/locations

This operation retrieves the locations created for the specified resource.

The operation supports custom properties of data type string, enumeration, and integer. You can only specify the properties that are present in the activity travel key configuration. The properties that are not present in the activity travel key configuration are ignored.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : Resource Locations
Type: object
Title: Resource Locations
The collection of resource locations.
Show Source
Nested Schema : Items
Type: array
Title: Items
An array of objects containing the resource location details.
Show Source
Nested Schema : Resource Location
Type: object
Title: Resource Location
The schema of the response body object for this operation.
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to get resource route for resources by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

 
GET /rest/ofscCore/v1/resources/john.smith/locations HTTP/1.0
Authorization: Basic c29hcEB5YW1hdG86MQ==
Host: <instance_name>.etadirect.com

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Example of Response Body

The following example shows the contents of the response body in JSON format.

 
{
    "items": [
        {
            "label": "testloc1",
            "postalCode": "",
            "city": "",
            "state": "",
            "address": "",
            "longitude": 0,
            "latitude": 0,
            "country": "US",
            "locationId": 32
        },
        {
            "label": "testloc2",
            "postalCode": "90007",
            "city": "Los Angeles",
            "state": "California",
            "address": "10775 Santa Monica Boulevard",
            "longitude": -100,
            "latitude": 34.0151468,
            "status": "manual",
            "country": "US",
            "locationId": 33
        }
    ],
    "totalResults": 2,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/resources/testResourceLocationWYOITSYDDH/locations"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/resources"
        }
    ]
}
Back to Top