API Reference

Examples

Get file

The following example shows the response when retrieving information about an uploaded file. The file is a SHP file.

/rest/v1/organizations/{organization}/files/{file}

{
  "result": {
    "createdBy": "[email protected]",
    "creationDate": "2023-04-03T15:10:39Z",
    "lastModifiedBy": "[email protected]",
    "lastModificationDate": "2023-04-03T15:10:43Z",
    "id": "ab0c347b-5a81-4a78-bb6f-5655d92f0bd0",
    "organizationId": "6dfa36b3-c6c9-430d-a438-48e131c4d5e5",
    "filename": "STM_Metro_lines.zip",
    "status": "ANALYZED",
    "jobId": "09ca5dfe-2b9e-4689-adf1-3ba74ed3c5f4",
    "metadata": {
      "fileNames": [
        "STM_Metro_lines.shp"
      ],
      "fileType": "SHAPE",
      "layers": [
        {
          "name": "STM_Metro_lines",
          "crs": "EPSG:4326",
          "geometryTypes": [
            "CURVE"
          ],
          "fileAttributes": [
            {
              "originalName": "route_id",
              "standardizedName": "ROUTE_ID",
              "type": "VARCHAR"
            },
            {
              "originalName": "agency_id",
              "standardizedName": "AGENCY_ID",
              "type": "VARCHAR"
            },
            {
              "originalName": "route_shor",
              "standardizedName": "ROUTE_SHOR",
              "type": "VARCHAR"
            },
            {
              "originalName": "route_long",
              "standardizedName": "ROUTE_LONG",
              "type": "VARCHAR"
            },
            {
              "originalName": "route_type",
              "standardizedName": "ROUTE_TYPE",
              "type": "VARCHAR"
            },
            {
              "originalName": "route_url",
              "standardizedName": "ROUTE_URL",
              "type": "VARCHAR"
            },
            {
              "originalName": "route_colo",
              "standardizedName": "ROUTE_COLO",
              "type": "VARCHAR"
            },
            {
              "originalName": "route_text",
              "standardizedName": "ROUTE_TEXT",
              "type": "VARCHAR"
            }
          ]
        }
      ],
      "elementsCount": 4,
      "type": "VECTOR_METADATA"
    },
    "type": "VECTOR_DATA"
  },
  "message": "The result is a file"
}