Start shape upload

post

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

This operation uploads the shape files of the work zone.

All the shapefile must be uploaded in a single request. Every time a shapefile is uploaded, the existing shapefile is removed. Therefore, uploading shapefiles in an incremental order is not supported. For more information on uploading shapefiles, see Configuring a Custom Map Layer by Using the Metadata API.

Note: From version 16.8.3 onwards, when the workzone shapefiles are uploaded, Oracle Field Service Cloud performs several validations to rectify the data imported from non-Oracle applications. If the shapefile is already uploaded, then it is recommended that you upload the shapefiles again to ensure that there are no issues in the existing data.

Request

Body ()
The request body for populating shapes.
Root Schema : Populating Shapes Request
Type: object
Title: Populating Shapes Request
The request body parameters for populating shapes. These parameters are used to download and convert shapes.
Show Source
Nested Schema : Authentication
Type: object
Title: Authentication
The authentication parameters used to connect with the server.
Show Source
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : Shape Upload
Type: object
Title: Shape Upload
The schema of the response body object for this operation.
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to add populate shapes by submitting a POST request on the REST resource using cURL.

curl -X 
POST -H "Authorization: Basic c29hcEBtYXN0ZXI6MQ==" 
     -H "Cache-Control: no-cache" -H "Postman-Token: 34f414c3-23cf-dc98-ed57-614010f1475e" -d '

{
  "URL": "https://www2.census.gov/geo/tiger/GENZ2014/shp/cb_2014_us_zcta510_500k.zip",
  "authentication":
  {
    "type": "none",
    "username": "user",
    "password": "pass"
  },
  
  "shapeIdentifierColumn": "GEOID10",
  "shapeAreaColumn":       "shapegeo"
}

' "https://ofsc1.vm/master/wwwroot/rest/ofscMetadata/v1/workZones/custom-actions/populateShapes?request_auth_basic&pretty"

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.

{
  "status": "pending",
  "time": "2016-01-05 12:58:54",
  "downloadId": "16ebd53f733cde76deecae12c11db86f"
}
Back to Top