Work Zones: List of Tasks

You can perform the following tasks using the Work Zones resource:

Task/Method Method Type URI Description

Add Populate Shapes

POST

/rest/ofscMetadata/v1/workZones/custom-actions/populateShapes

This operation loads work zone shapefiles.

Files must be uploaded as a .zip archive. The archive must contain the shapefiles on the first level of the directory hierarchy (at the root level). For more information about shapefiles, see https://en.wikipedia.org/wiki/Shapefile.

The response contains the 'downloadId' parameter that is used in the 'Get shapes populating status' operation to check the status of the upload.

Create Work Zone

POST

/rest/ofscMetadata/v1/workZones

This operation creates a new work zone.

Get shapes populating status

GET

/rest/ofscMetadata/v1/workZones/custom-actions/populateShapes/{downloadId}

This operations returns the status of a shapefile import operation.

Get Work Zone

GET

/rest/ofscMetadata/v1/workZones/{workZoneLabel}

This operation returns the attributes for the specified work zone.

Get work zones

GET

/rest/ofscMetadata/v1/workZones

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

Update Work Zone

PUT

/rest/ofscMetadata/v1/workZones/{workZoneLabel}

This operation updates the specified work zone with the provided attributes.

If the specified work zone already contains attributes, this operation replaces them with the values specified in the request.

Delete work zone

DELETE

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

The method deletes the existing work zone.

Replace work zone

PUT

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

This operation updates the specified work zone with the provided attributes.