Jump to

• Request
• Response
• Examples

Get a work zone

get

/rest/ofscMetadata/v1/workZones/{label}

This operation retrieves the attributes of the specified work zone.

Request

Path Parameters

• label(required): string
  Minimum Length: 1

  Maximum Length: 255

  The label of the work zone.

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root 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.

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 a specific work zone 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/v1/workZones/{label}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK

Example of Response Body

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

{
    "workZoneName": "Pleasant Valley",
    "workZoneLabel": "PLEASANT_VALLEY",
    "status": "active",
    "organization": "Sunrise",
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>/rest/ofscMetadata/v1/workZones/CASSELBERRY"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>/rest/ofscMetadata/v1/metadata-catalog/workZones"
        }
    ]
}

Back to Top