Jump to

• Request
• Response
• Examples

Check custom map layer population status

get

/rest/ofscMetadata/v1/mapLayers/custom-actions/populateLayers/{downloadId}

This operation retrieves the import status of the custom map layer.

Error Messages:

The following errors may occur for this operation:

• Unexpected script error: The process was terminated unexpectedly.
• Invalid query format '{query_record}: The query ID or the environment name is missing.
• Empty URL: The request contains an empty 'url' field.
• Failed to download file {url}: The shapefile could not be downloaded with the specified credentials.
• Failed to unpack file {url}: The shapefile was successfully downloaded, but the file could not be unzipped.
• File size exceeds limit {filesize_limit}: The shapefile was successfully downloaded and unpacked, but the file size exceeds the threshold of 2GB.
• Failed to parse shapefile {file_name}: Failed to parse the downloaded shape file.
• Failed to process shapefile: The shapefile was parsed, but it cannot be stripped, and the theme name cannot be generated (length exceeds limit of 32 characters) or registered as the theme for MapViewer.

Request

Path Parameters

• downloadId(required): string
  The hash string that uniquely identifies the process for downloading shape files.

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 : Populate Layers Response

Type: object

Title: Populate Layers Response

The schema of the response body object for this operation.

Show Source

• downloadId: integer
  Title: Download ID

  The identifier of the shape file specified in the request.
• status: string
  Title: Status

  The status of the downloaded shape file.
• time: string
  Title: Time

  The time when the operation started.

{
    "title":"Populate Layers Response",
    "description":"The schema of the response body object for this operation.",
    "properties":{
        "status":{
            "title":"Status",
            "description":"The status of the downloaded shape file.",
            "type":"string"
        },
        "time":{
            "title":"Time",
            "description":"The time when the operation started.",
            "type":"string"
        },
        "downloadId":{
            "title":"Download ID",
            "description":"The identifier of the shape file specified in the request.",
            "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 the status of the loading and converting process 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/custom-actions/populateShapes/5a93c598f92621321d4fd257bf0da6d6

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.

{
    "downloadID":5a93c598f92621321d4fd257bf0da6d6,  
    "status":"pending"                           
}

Back to Top