REST API for Oracle Fusion Field Service Cloud Service

Get work zones

get

/rest/ofscMetadata/v1/workZones

This operation retrieves the list of work zones that are visible to the API user.

Request

Query Parameters

limit: integer

The maximum number of items returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
offset: integer

The number of items that are skipped in the response. If a value is not specified, then it defaults to zero. The value zero indicates that the retrieval starts from the beginning of the collection.

Response

Supported Media Types

application/schema+json
application/json

200 Response

This section describes the 200 status response for this operation.

Root Schema : workZones

Type: object

The collection of work zones.

Show Source

items: array items

An array of work zone items.
totalResults: integer

The total number of work zones retrieved.

{
    "description":"The collection of work zones.",
    "properties":{
        "items":{
            "type":"array",
            "description":"An array of work zone items.",
            "items":{
                "$ref":"#/definitions/workZoneItem"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of work zones retrieved."
        }
    }
}

Nested Schema : items

Type: array

An array of work zone items.

Show Source

Array of: object Work Zone

Title: Work Zone

{
    "type":"array",
    "description":"An array of work zone items.",
    "items":{
        "$ref":"#/definitions/workZoneItem"
    }
}

Nested Schema : Work Zone

Type: object

Title: Work Zone

Show Source

keys: array Keys

Title: Keys
organization: string

Title: The organization label

Minimum Length: 1

Maximum Length: 255
shapes: array Shapes

Title: Shapes
status: string

Title: Status

Allowed Values: [ "active", "inactive" ]
travelArea(required): string

Title: Travel Area

Allowed Values: [ "sunrise_enterprise", "New" ]
workZoneLabel(required): string

Title: Work Zone Label

Minimum Length: 1

Maximum Length: 255
workZoneName(required): string

Title: Work Zone Name

Minimum Length: 1

Maximum Length: 255

{
    "type":"object",
    "title":"Work Zone",
    "properties":{
        "workZoneLabel":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "title":"Work Zone Label"
        },
        "workZoneName":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "title":"Work Zone Name"
        },
        "status":{
            "type":"string",
            "enum":[
                "active",
                "inactive"
            ],
            "title":"Status"
        },
        "travelArea":{
            "type":"string",
            "enum":[
                "sunrise_enterprise",
                "New"
            ],
            "title":"Travel Area"
        },
        "keys":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":50
            },
            "title":"Keys"
        },
        "shapes":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":50
            },
            "title":"Shapes"
        },
        "organization":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "x-nullable":true,
            "title":"The organization label"
        }
    },
    "required":[
        "workZoneLabel",
        "travelArea",
        "workZoneName"
    ]
}

Nested Schema : Keys

Type: array

Title: Keys

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 50

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":50
    },
    "title":"Keys"
}

Nested Schema : Shapes

Type: array

Title: Shapes

Show Source

Array of: string

Minimum Length: 1

Maximum Length: 50

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":50
    },
    "title":"Shapes"
}

Default Response

This section describes the default error response for this operation.

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"
    ]
}

Examples

The following example shows how to return a list of work zones in the system by submitting a GET request on the REST resource using cURL.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscMetadata/v1/workZones/ HTTP/1.0
Authorization: Basic *****
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
Content-Type: application/json; charset=utf-8

Example of Response Body

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

{
    "hasMore": false,
    "totalResults": 13,
    "limit": 100,
    "offset": 0,
    "items": [
        {
            "workZoneLabel": "ALTAMONTE SPRINGS",
            "workZoneName": "ALTAMONTE SPRINGS",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "ALTA"
            ],
            "shapes": [
                "32701",
                "32707",
                "32714",
                "32730",
                "32751"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/ALTAMONTE+SPRINGS"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "CASSELBERRY",
            "workZoneName": "CASSELBERRY",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "CASS"
            ],
            "shapes": [
                "32707"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/CASSELBERRY"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "CHULUOTA",
            "workZoneName": "CHULUOTA",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "CHUL"
            ],
            "shapes": [
                "32766"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/CHULUOTA"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "GENEVA",
            "workZoneName": "GENEVA",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "GENE"
            ],
            "shapes": [
                "32732"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/GENEVA"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "HEATHROW",
            "workZoneName": "HEATHROW",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "HEAT"
            ],
            "shapes": [
                "32746"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/HEATHROW"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "LAKE MARY",
            "workZoneName": "LAKE MARY",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "LAKE"
            ],
            "shapes": [
                "32746"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/LAKE+MARY"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "LONGWOOD",
            "workZoneName": "LONGWOOD",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "LONG"
            ],
            "shapes": [
                "327450"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/LONGWOOD"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "OVIEDO",
            "workZoneName": "OVIEDO",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "OVIE"
            ],
            "shapes": [
                "32765"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/OVIEDO"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "SANFORD",
            "workZoneName": "SANFORD",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "SANF"
            ],
            "shapes": [
                "32771"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/SANFORD"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "WINTER SPRINGS",
            "workZoneName": "WINTER SPRINGS",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "WINT"
            ],
            "shapes": [
                "32708"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/WINTER+SPRINGS"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "Port St Lucie",
            "workZoneName": "Port St Lucie",
            "status": "inactive",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "Port"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/Port+St+Lucie"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "TEX",
            "workZoneName": "TEXAS",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [
                "ANDR",
                "COLO",
                "KERM",
                "LUBB",
                "MIDL",
                "ODES"
            ],
            "shapes": [
                "79401",
                "79512",
                "79701",
                "79714",
                "79745",
                "79761"
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/TEX"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        },
        {
            "workZoneLabel": "testWorkZoneLabel",
            "workZoneName": "testWorkZoneLabel",
            "status": "active",
            "travelArea": "sunrise_enterprise",
            "keys": [],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones/testWorkZoneLabel"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workZones?limit=100&offset=0"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workZones"
        }
    ]
}