Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Carbon Management

Create Emission Transaction

Use this API to create emission transaction.

Additional Information

  • Emission Factors names and id list can be obtained using the Retrieve Emission Factors list API. Use the required id to fill the emissionFactorId field in entityDetail.

Example Request

POST https://{hostname}/api/esg-management/v1/entity-types/names/emission-transactions/entities

POST https://trial.onetrust.com/api/esg-management/v1/entity-types/names/emission-transactions/entities

post/v1/entity-types/emission-transactions/entities

Request body

namestring

The name of the entity.

attributesobject

Example request

{
  "name": "air travel",
  "organization": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "name": "Organization Name"
  },
  "entityDetail": {
    "data": {
      "emissionFactorId": "11909a50-593a-4caf-a27b-ff3ba3022f0b",
      "activityUnit": 30,
      "startDateOfActivity": "01/20/2022",
      "endDateOfActivity": "01/23/2022"
    }
  },
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  }
}

Response

Created

idstring uuid required

The unique identifier of the entity.

numberinteger required

The numerical order in which the entity was created.

namestring

The name of the entity.

orgGroupIdstring uuid

The unique identifier of the organization.

schemaIdstring uuid required

The unique identifier of the schema.

attributesobject

Example response

{
  "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "number": 1,
  "name": "OneTrust",
  "orgGroupId": "d1119953-b4b5-4042-8cb9-b78038cc2c46",
  "entityType": {
    "id": "a2319953-b4b5-4042-8cb9-b78038cc4c46",
    "name": "Asset"
  },
  "workflowAndStage": {
    "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
    "name": "Vendor On-Boarding Workflow",
    "type": "Vendor",
    "workflowMode": "BASIC",
    "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
    "stageName": "Start On-Boarding"
  },
  "attributes": {
    "textAttributeName": [
      {
        "value": "Text"
      }
    ],
    "optionBasedAttributeName": [
      {
        "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
      }
    ]
  },
  "auditFields": {
    "createdBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    },
    "lastModifiedBy": {
      "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
      "name": "Name"
    }
  }
}