Source File ServicesΒΆ

These services provide access to information about source files that Scale has ingested.

Source File List
Returns a list of all source files
GET /sources/
Query Parameters
page Integer Optional The page of the results to return. Defaults to 1.
page_size Integer Optional The size of the page to use for pagination of results. Defaults to 100, and can be anywhere from 1-1000.
started ISO-8601 Datetime Optional The start of the time range to query. Supports the ISO-8601 date/time format, (ex: 2015-01-01T00:00:00Z). Supports the ISO-8601 duration format, (ex: PT3H0M0S).
ended ISO-8601 Datetime Optional End of the time range to query, defaults to the current time. Supports the ISO-8601 date/time format, (ex: 2015-01-01T00:00:00Z). Supports the ISO-8601 duration format, (ex: PT3H0M0S).
order String Optional One or more fields to use when ordering the results. Duplicate it to multi-sort, (ex: order=file_name&order=created). Nested objects require a delimiter (ex: order=job_type__name). Prefix fields with a dash to reverse the sort, (ex: order=-created).
is_parsed Boolean Optional Return only sources flagged as successfully parsed.
file_name String Optional Return only sources with a given file name.
Successful Response
Status 200 OK
Content Type application/json
JSON Fields
count Integer The total number of results that match the query parameters.
next URL A URL to the next page of results.
previous URL A URL to the previous page of results.
results Array List of result JSON objects that match the query parameters.
.id Integer The unique identifier of the model. Can be passed to the details API call. (See Source File Details)
.workspace JSON Object The workspace that has stored the source file. (See Workspace Details)
.file_name String The name of the source file.
.media_type String The IANA media type of the source file.
.file_size Integer The size of the source file in bytes.
.data_type Array List of strings describing the data type of the source.
.is_deleted Boolean Whether the source file has been deleted.
.uuid String A unique identifier that stays stable across multiple job execution runs.
.url URL The absolute URL to use for downloading the file.
.created ISO-8601 Datetime When the associated database model was initially created.
.deleted ISO-8601 Datetime When the source file was deleted.
.data_started ISO-8601 Datetime When collection of the underlying data file started.
.data_ended ISO-8601 Datetime When collection of the underlying data file ended.
.geometry WKT String The full geospatial geometry footprint of the source.
.center_point WKT String The central geospatial location of the source.
.meta_data JSON Object A dictionary of key/value pairs that describe source-specific attributes.
.countries Array A list of zero or more strings with the ISO3 country codes for countries contained in the geographic boundary of this file.
.last_modified ISO-8601 Datetime When the associated database model was last saved.
.is_parsed Boolean Whether this source was successfully parsed.
.parsed ISO-8601 Datetime When the source file was originally parsed by Scale. 
{
    "count": 55,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 465,
            "workspace": {
                "id": 1,
                "name": "Raw Source"
            },
            "file_name": "my_file.kml",
            "media_type": "application/vnd.google-earth.kml+xml",
            "file_size": 100,
            "data_type": [],
            "is_deleted": false,
            "uuid": "c8928d9183fc99122948e7840ec9a0fd",
            "url": "http://host.com/file/path/my_file.kml",
            "created": "1970-01-01T00:00:00Z",
            "deleted": null,
            "data_started": null,
            "data_ended": null,
            "geometry": null,
            "center_point": null,
            "meta_data": {...},
            "countries": ["TCY", "TCT"],
            "last_modified": "1970-01-01T00:00:00Z",
            "is_parsed": true,
            "parsed": "1970-01-01T00:00:00Z"
        },
        ...
    ]
}
Source File Updates
Returns the source file updates (created, parsed, and deleted sources) that have occurred in the given time range.
GET /sources/updates/
Query Parameters
page Integer Optional The page of the results to return. Defaults to 1.
page_size Integer Optional The size of the page to use for pagination of results. Defaults to 100, and can be anywhere from 1-1000.
started ISO-8601 Datetime Optional The start of the time range to query. Supports the ISO-8601 date/time format, (ex: 2015-01-01T00:00:00Z). Supports the ISO-8601 duration format, (ex: PT3H0M0S).
ended ISO-8601 Datetime Optional End of the time range to query, defaults to the current time. Supports the ISO-8601 date/time format, (ex: 2015-01-01T00:00:00Z). Supports the ISO-8601 duration format, (ex: PT3H0M0S).
order String Optional One or more fields to use when ordering the results. Duplicate it to multi-sort, (ex: order=file_name&order=created). Nested objects require a delimiter (ex: order=job_type__name). Prefix fields with a dash to reverse the sort, (ex: order=-created).
is_parsed Boolean Optional Return only sources flagged as successfully parsed.
file_name String Optional Return only sources with a given file name.
Successful Response
Status 200 OK
Content Type application/json
JSON Fields
count Integer The total number of results that match the query parameters.
next URL A URL to the next page of results.
previous URL A URL to the previous page of results.
results Array List of result JSON objects that match the query parameters.
.id Integer The unique identifier of the model. Can be passed to the details API call. (See Source File Details)
.workspace JSON Object The workspace that has stored the source file. (See Workspace Details)
.file_name String The name of the source file.
.media_type String The IANA media type of the source file.
.file_size Integer The size of the source file in bytes.
.data_type Array List of strings describing the data type of the source.
.is_deleted Boolean Whether the source file has been deleted.
.uuid String A unique identifier that stays stable across multiple job execution runs.
.url URL The absolute URL to use for downloading the file.
.created ISO-8601 Datetime When the associated database model was initially created.
.deleted ISO-8601 Datetime When the source file was deleted.
.data_started ISO-8601 Datetime When collection of the underlying data file started.
.data_ended ISO-8601 Datetime When collection of the underlying data file ended.
.geometry WKT String The full geospatial geometry footprint of the source.
.center_point WKT String The central geospatial location of the source.
.meta_data JSON Object A dictionary of key/value pairs that describe source-specific attributes.
.countries Array A list of zero or more strings with the ISO3 country codes for countries contained in the geographic boundary of this file.
.last_modified ISO-8601 Datetime When the associated database model was last saved.
.is_parsed Boolean Whether this source was successfully parsed.
.parsed ISO-8601 Datetime When the source file was originally parsed by Scale.
.update JSON Object Contains the details of this update.
..action String The source file update that occurred. Choices: [CREATED, PARSED, DELETED].
..when ISO-8601 Datetime When the action occurred. 
{
    "count": 55,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 465,
            "workspace": {
                "id": 2,
                "name": "Raw Source"
            },
            "file_name": "my_file.kml",
            "media_type": "application/vnd.google-earth.kml+xml",
            "file_size": 100,
            "data_type": [],
            "is_deleted": false,
            "uuid": "c8928d9183fc99122948e7840ec9a0fd",
            "url": "http://host.com/file/path/my_file.kml",
            "created": "1970-01-01T00:00:00Z",
            "deleted": null,
            "data_started": null,
            "data_ended": null,
            "geometry": null,
            "center_point": null,
            "meta_data": {...},
            "countries": ["TCY", "TCT"],
            "last_modified": "1970-01-01T00:00:00Z",
            "is_parsed": true,
            "parsed": "1970-01-01T00:00:00Z",
            "update": {
                "action": "PUBLISHED",
                "when": "1970-01-01T00:00:00Z"
            }
        },
        ...
    ]
}