v1

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

Get List of Emission Details

Use this API to get list of Emission Details by Criteria.

Additional Information

  • Filtering can be added in the request body.

Example Request

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

POST https://trial.onetrust.com/api/esg-management/v1/entity-types/names/{entityTypeName}/entities/pages

post/v1/entity-types/names/{entityTypeName}/entities/pages

Path parameters

entityTypeName'emission-factors' | 'emission-transactions' required
Example:emission-factors

The name of the entity type.

Query parameters

pageinteger

Results page you want to retrieve (0..N)

sizeinteger

Number of records per page.

sortstring[]

Request body

Response

OK

totalElementsinteger
totalPagesinteger
sizeinteger
numberinteger
numberOfElementsinteger
lastboolean
firstboolean
emptyboolean

Example response

{
  "content": [
    {
      "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"
        }
      }
    }
  ]
}