Submit Spatial Areas Job

post

https://example.com/cod/AppsServices/api/v2/spatial-areas/jobs

This endpoint allows you to submit a request for financial impact data on Spatial Areas.
You can specify methodology and snapshot versions, area unit, RCP scenario, and Time Horizon details to tailor your request.

Body Params

methodology_location

string

enum

required

Version of the location methodology.

Allowed:

methodology_area

string

enum

Version of the spatial area methodology.

Allowed:

data_snapshot_date

date

enum

Data snapshot "as of" date for corporate and facility data. Suggested format is "yyyy-mm-dd".

Allowed:

production_date

date

enum

Result set production date. Suggested format is "yyyy-mm-dd".

Allowed:

area_unit_name

string

enum

required

Specify one of the options for type of area unit.

rcp

string

enum

The climate warming scenario or "representative concentration pathway" used for evaluation. Choose either RCP or NGFS; CoD only accepts one scenario per API call.

Allowed:

ngfs

string

enum

Network for Greening the Financial System climate change (NGFS) scenarios and the impact of climate risks on the global finance system used for evaluation. Choose either RCP or NGFS; CoD only accepts one scenario per API call.

string

enum

required

The time horizon(s) used for evaluation of climate change. Note that while this parameter is specified as a single year, financial impact data represent projected outcomes summarized across multiple years of projected climate data.

Allowed:

job_type

string

enum

required

Allowed:

Responses

401

No valid API key provided.

403

Forbidden: Access to this resource / action is denied or not authorized

404

Not found.

405

Method not allowed

500

Something went wrong on our end (this happens rarely)

201Job submitted successfully

400Bad Request