Jump to

• Request
• Response
• Examples

Get status of shape upload

get

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

This operation retrieves the status of the shapefile upload process.

Request

Path Parameters

• downloadId(required): string

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

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

• downloadId: integer
  Title: Download ID

  The unique identifier of the shapefile download process.
• status: string
  Title: Status

  The status of the shapefile upload process.
• time: string
  Title: Time

  The current time.

{
    "title":"Shape Upload",
    "description":"The schema of the response body object for this operation.",
    "properties":{
        "status":{
            "title":"Status",
            "description":"The status of the shapefile upload process.",
            "type":"string"
        },
        "time":{
            "title":"Time",
            "description":"The current time.",
            "type":"string"
        },
        "downloadId":{
            "title":"Download ID",
            "description":"The unique identifier of the shapefile download process.",
            "type":"integer"
        }
    }
}

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 status of populate shapes by submitting a GET request on the REST resource using cURL.

curl -X 
GET  -H "Authorization: Basic c29hcEBvZnNjLm1hcHM6MQ==" 
     -H "Cache-Control: no-cache" 
     -H "Postman-Token: c3d35ce8-48d4-db53-bf2b-b041aefbb698" 

"https://ofsc1.vm/master/wwwroot/rest/ofscMetadata/v1/workZones/custom-actions/populateShapes/16ebd53f733cde76deecae12c11db86f?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