All Products
Search
Document Center

Energy Expert:GetDataItemList

Last Updated:Sep 27, 2024

This interface is used to obtain the details category of a data item.

Operation description

  • obtain data item detail list under the current enterprise.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /api/v1/carbon/emission/data/item/list HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

Request parameters.

codestringYes

The enterprise code.

C-202302-01

Response parameters

ParameterTypeDescriptionExample
object

The returned struct.

requestIdstring

The request ID.

83A5A7DD-8974-5769-952E-590A97BEA34E
dataarray<object>

Response parameters.

DataItemobject
unitstring

The data item unit.

kg
periodinteger

Data filling method, 1: monthly value 2: annual value.

1
codestring

The identifier of the data item.

demo_api_code
namestring

The name of the data item.

name_bbb

Examples

Sample success responses

JSONformat

{
  "requestId": "83A5A7DD-8974-5769-952E-590A97BEA34E",
  "data": [
    {
      "unit": "kg",
      "period": 1,
      "code": "demo_api_code",
      "name": "name_bbb"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history