Jump to

• Request
• Response
• Examples

Get a resource location

get

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

This operation retrieves the details of the specified resource location.

Request

Path Parameters

• locationId(required): integer
  The unique identifier of the location.
• resourceId(required): string
  The external identifier of the resource.

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Resource Location

Type: object

Title: Resource Location

The schema of the response body object for this operation.

Show Source

• address: string
  Title: Address

  The address of the resource.
• city: string
  Title: City

  The city in which the address is located.
• country: string
  Title: Country

  The country in which the address is located.
• label: string
  Title: Label

  The unique label of the resource location.
• latitude: number
  Title: Latitude

  Minimum Value: -90

  Maximum Value: 90

  The geographic coordinates of the resource location.
• locationId: integer
  Title: Location ID

  The unique identifier of the resource location.
• longitude: number
  Title: Longitude

  Minimum Value: -180

  Maximum Value: 180

  The geographic coordinates of the resource location.
• postalCode: string
  Title: Postal Code

  The postal code of the resource location.
• privateLocationFlag: boolean
  Title: Location is private

  Default Value: false

  Indicates whether the location is a resource private location.
• state: string
  Title: State

  The state in which the address is located.
• status: string
  Title: Status

  The status of the resource location.

{
    "type":"object",
    "properties":{
        "address":{
            "type":"string",
            "description":"The address of the resource.",
            "title":"Address"
        },
        "locationId":{
            "type":"integer",
            "description":"The unique identifier of the resource location.",
            "title":"Location ID"
        },
        "country":{
            "type":"string",
            "description":"The country in which the address is located.",
            "title":"Country"
        },
        "city":{
            "type":"string",
            "description":"The city in which the address is located.",
            "title":"City"
        },
        "longitude":{
            "type":"number",
            "minimum":-180,
            "maximum":180,
            "description":"The geographic coordinates of the resource location.",
            "title":"Longitude"
        },
        "state":{
            "type":"string",
            "description":"The state in which the address is located.",
            "title":"State"
        },
        "status":{
            "type":"string",
            "description":"The status of the resource location.",
            "title":"Status"
        },
        "label":{
            "type":"string",
            "description":"The unique label of the resource location.",
            "title":"Label"
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code of the resource location.",
            "title":"Postal Code"
        },
        "latitude":{
            "type":"number",
            "minimum":-90,
            "maximum":90,
            "description":"The geographic coordinates of the resource location.",
            "title":"Latitude"
        },
        "privateLocationFlag":{
            "type":"boolean",
            "default":false,
            "description":"Indicates whether the location is a resource private location.",
            "title":"Location is private"
        }
    },
    "title":"Resource Location",
    "description":"The schema of the response body object for this operation."
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to get resource location 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/44035/locations/3 HTTP/1.0
Authorization: Basic c29hcEB5YW1hdG86MQ==
Host: <instance_name>.fs.ocs.oraclecloud.com
Accept: */*

Example of Response Header

The following shows an example of the response header.

 
HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Fri, 24 Jul 2015 08:35:48 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Example of Response Body

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

  
{
        "label": "Warehouse EU1",
        "postalCode": "32817",
        "city": "Orlando",
        "state": "FL",
        "address": "11350-11398 University Blvd, Orlando",
        "longitude": -81.22226,
        "latitude": 28.59752,
        "status": "manual",
        "locationId": 3,
        "links": [
            {
                "rel": "canonical",
                "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/44008/locations/3"
            },
            {
                "rel": "describedby",
                "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/metadata-catalog/resources"
            }
        ]
}

Back to Top