Carbon Footprint Report Job
Overview
This job can be used to generate the Carbon Footprint Report.
| Job Template ID | Resource Type | Job Parameters |
|---|---|---|
| b0001d36-6490-48ac-93af-a87adfb997ed | compute-ops-mgmt/filter | reportType* |
Job parameters marked with a
*are required.
Create Job
A job can be created by issuing a POST to the /compute-ops-mgmt/v1/jobs endpoint with the correct payload for the job.
The following properties are used when creating a job:
| Property | JSON Type | Description | Required? |
|---|---|---|---|
jobTemplate |
string (id) | The durable Template ID of the job | Yes |
resourceType |
string (type) | The TYPE of the resource the job will operate on | Yes |
resourceId |
string (id) | The ID of the resource the job will operate on | Yes |
jobParams |
object | Any additional data required by the job | No |
If the job was created successfully, a 201 Created response is returned. The response includes the job resource which has a
job resourceUri that you can use to track the progress of the job.
Job Parameters
This table summarizes the supported properties in jobParams.
| Property | JSON Type | Description | Required? |
|---|---|---|---|
reportType |
string (enum) | Type of report to be generated | Yes |
Parameter properties
-
reportType: This required property defines the type of report generated. Today only CARBON_FOOTPRINT is supported.
Example
Here's an example request payload for creating this job.
Example 1
{
"jobTemplate": "b0001d36-6490-48ac-93af-a87adfb997ed",
"resourceType": "compute-ops-mgmt/filter",
"resourceId": "e7cef8e6-a3f6-4490-b669-136e3ca40617",
"jobParams": { "reportType": "CARBON_FOOTPRINT" }
}