Get work zones of a capacity area
get
/rest/ofscMetadata/v2/capacityAreas/{label}/workZones
This operation retrieves a collection of work zones for the specified capacity area.
Request
Path Parameters
-
label(required): string
Minimum Length:
1
Maximum Length:255
The label of the capacity area.
Response
Supported Media Types
- application/json
- application/schema+json
200 Response
This section describes the 200 status response for this operation.
Nested Schema : AreaWorkZone
Type:
Show Source
object
-
workZoneLabel:
string
The label of the work zone.
-
workZoneName:
string
The name of the work zone.
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
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.
Examples
The following example shows how to get work zones for a specific capacity area by submitting a GET request on the REST resource.
Example of Request Header
The following shows an example of the request header.
GET/rest/ofscMetadata/v2/capacityAreas/CapacityArea/workZones Connection: close Accept-Encoding: gzip,deflate Authorization: Basic bXlyb290QHFhNTUwMzox Host: <instance_name>.fs.ocs.oraclecloud.com User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Server: nginx Date: Wed, 23 Aug 2017 15:01:16 GMT Content-Type: application/json; charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive Access-Control-Allow-Credentials: true Strict-Transport-Security: max-age=31536000; includeSubDomains;
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "workZoneLabel": "Label of Work zone A", "workZoneName": "Name of Work zone A" } ] }