Salesforce Net Zero Cloud

opencollection: 1.0.0
info:
  name: Salesforce Net Zero Cloud REST API
  version: 59.0.0
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://login.salesforce.com/services/oauth2/authorize
    accessTokenUrl: https://login.salesforce.com/services/oauth2/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Carbon Emissions
    type: folder
  items:
  - info:
      name: List Carbon Emission Records
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/CarbonEmission
      params:
      - name: scope
        value: ''
        type: query
        description: Filter by emission scope (1, 2, or 3)
      - name: reportingYear
        value: ''
        type: query
        description: Filter by reporting year (e.g., 2023)
      - name: pageSize
        value: ''
        type: query
    docs: Retrieves a list of carbon emission records tracked in Net Zero Cloud, including scope 1, 2, and 3 emissions across
      all reporting periods.
  - info:
      name: Create Carbon Emission Record
      type: http
    http:
      method: POST
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/CarbonEmission
      body:
        type: json
        data: '{}'
    docs: Creates a new carbon emission record for tracking greenhouse gas emissions from a specific source or activity.
  - info:
      name: Get Carbon Emission Record
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/CarbonEmission/:emissionId
      params:
      - name: emissionId
        value: ''
        type: path
        description: Salesforce ID of the carbon emission record
    docs: Retrieves details for a specific carbon emission record including scope, source, quantity, and reporting period.
  - info:
      name: Update Carbon Emission Record
      type: http
    http:
      method: PATCH
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/CarbonEmission/:emissionId
      params:
      - name: emissionId
        value: ''
        type: path
        description: Salesforce ID of the carbon emission record
      body:
        type: json
        data: '{}'
    docs: Updates an existing carbon emission record's data, such as correcting emission quantities or updating the reporting
      period.
  - info:
      name: Delete Carbon Emission Record
      type: http
    http:
      method: DELETE
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/CarbonEmission/:emissionId
      params:
      - name: emissionId
        value: ''
        type: path
        description: Salesforce ID of the carbon emission record
    docs: Deletes a carbon emission record from the system.
- info:
    name: Energy Consumption
    type: folder
  items:
  - info:
      name: List Energy Consumption Records
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/EnergyConsumption
      params:
      - name: energyType
        value: ''
        type: query
        description: Filter by energy type
      - name: reportingYear
        value: ''
        type: query
    docs: Retrieves energy consumption records including electricity, natural gas, fuel, and renewable energy usage across
      facilities and time periods.
  - info:
      name: Create Energy Consumption Record
      type: http
    http:
      method: POST
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/EnergyConsumption
      body:
        type: json
        data: '{}'
    docs: Creates a new energy consumption record for tracking energy usage at a facility or from a specific source.
  - info:
      name: Get Energy Consumption Record
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/EnergyConsumption/:consumptionId
      params:
      - name: consumptionId
        value: ''
        type: path
    docs: Retrieves details for a specific energy consumption record.
- info:
    name: Sustainability Goals
    type: folder
  items:
  - info:
      name: List Sustainability Goals
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/SustainabilityGoal
    docs: Retrieves sustainability goals and net zero targets, including current progress, baseline years, and target years.
  - info:
      name: Create Sustainability Goal
      type: http
    http:
      method: POST
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/SustainabilityGoal
      body:
        type: json
        data: '{}'
    docs: Creates a new sustainability goal or net zero commitment with target metrics and timeline.
- info:
    name: Emission Factors
    type: folder
  items:
  - info:
      name: List Emission Factors
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/EmissionFactor
      params:
      - name: category
        value: ''
        type: query
        description: Filter by emission factor category
      - name: region
        value: ''
        type: query
        description: Filter by geographic region
    docs: Retrieves emission factors used to calculate CO2 equivalent emissions from activity data. Includes region-specific
      grid emission factors, fuel emission factors, and custom factors.
- info:
    name: Waste Management
    type: folder
  items:
  - info:
      name: List Waste Disposal Records
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/WasteDisposal
    docs: Retrieves waste disposal records including landfill, recycling, composting, and hazardous waste disposal data.
  - info:
      name: Create Waste Disposal Record
      type: http
    http:
      method: POST
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/WasteDisposal
      body:
        type: json
        data: '{}'
    docs: Creates a new waste disposal record.
- info:
    name: Water Usage
    type: folder
  items:
  - info:
      name: List Water Withdrawal Records
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/WaterWithdrawal
    docs: Retrieves water withdrawal and consumption records from various sources such as municipal supply, groundwater, and
      rainwater.
  - info:
      name: Create Water Withdrawal Record
      type: http
    http:
      method: POST
      url: https://{instance}.my.salesforce.com/services/data/v59.0/sobjects/WaterWithdrawal
      body:
        type: json
        data: '{}'
    docs: Creates a new water withdrawal record.
- info:
    name: ESG Reporting
    type: folder
  items:
  - info:
      name: Query Sustainability Data
      type: http
    http:
      method: GET
      url: https://{instance}.my.salesforce.com/services/data/v59.0/query
      params:
      - name: q
        value: ''
        type: query
        description: SOQL query string
    docs: Executes a SOQL query to retrieve sustainability data across any Net Zero Cloud object with custom filtering and
      aggregation.
bundled: true